Add-ons ๐Ÿ›’ Key Shop

๐Ÿ”„ Exchanges

On this page, you will find how to configure trading one key for another.

#Exchanges

An exchange trades a number of one key for a number of another. They live under exchanges in key-shop.yml and are shown in their own menu.

exchanges:
  '0':
    identifier: vote_to_legendary
    display-item:
      material: TRIPWIRE_HOOK
      display-name: '&6Upgrade to Legendary'
      amount: 1
    from-key: vote
    from-amount: 10
    to-key: legendary
    to-amount: 1
    permission: ''
    daily-limit: -1
    total-limit: -1
    exchange-message:
    - '&aYou traded &fx%from_amount% %from_key% &afor &fx%to_amount% %to_key%&a.'

#Options

Option What it does
identifier The name the trade counters are stored under.
display-item The item shown in the exchange menu.
from-key The identifier of the key being spent.
from-amount How many of it one trade consumes.
to-key The identifier of the key being received.
to-amount How many of it one trade gives.
permission The player needs this to use the trade. Leave empty for everyone.
daily-limit Trades allowed per player per day, -1 for unlimited.
total-limit Trades allowed per player for the lifetime of the exchange, -1 for unlimited.
exchange-message Sent to the player after the trade.

#Virtual and physical keys

Both sides work with either kind of key. A virtual key is taken from the player's stored key count, and a physical key is taken from their inventory, including the off-hand slot. The key received is delivered the same way any other key is, so a physical key with a full inventory follows whatever the Crate Claim add-on is set to do.

The menu only offers a trade the player can actually complete, so an entry greys out when they are short of the key it consumes.

circle-exclamation

An exchange pointing at a key identifier that no longer exists shows as unavailable and can never be used. Renaming a key means updating every exchange that references it.

#Message placeholders

exchange-message accepts %player%, %from_amount%, %from_key%, %to_amount% and %to_key%.

The exchange-item and unavailable-item entries in menus/default_key_exchange.yml accept:

Placeholder Value
%entry% The display name of the exchange.
%item_name% The name of the configured display item.
%from_key% / %from_amount% The key spent and how many.
%to_key% / %to_amount% The key received and how many.
%owned% How many of the spent key the player holds.
%remaining% Trades the player has left, or the "Unlimited" label.
Last updated 16 days ago
My Cart (0 items)

Oops... looks like the spiders padded through here

Add products to your cart and remove them from here Lets buy