Skip to content
BattleStudio

messages.yml

Edit, disable and translate every message OptimalAuctions sends, plus optional screen titles.

Every message lives in messages.yml. Each supports legacy & codes, &#hex, MiniMessage, [center] and (with PlaceholderAPI) %...%. After editing, run /ahadmin reload.

Format

Section titled “Format”
Messages:
  PURCHASED:
    Message:
      Enabled: true
      Value:
      - '&5[&d&lAuctions&5] &7You bought &fx{amount} {item} &7for {price} {currency}&7.'
  • Enabled: false silences a message entirely.
  • Value is a list. Every line is sent (used by the help panels and the two-line prompts).
  • Keep the {tokens} intact; don’t rename the message keys.

Missing keys are written back with their defaults the next time the file loads, so you can delete a block to reset it.

Titles

Section titled “Titles”

Any message can also show a title and subtitle on the player’s screen. Add a Title: block next to Message::

Messages:
  LISTED:
    Message:
      Enabled: true
      Value:
      - '&5[&d&lAuctions&5] &7You listed &fx{amount} {item} &7at {unit-price} {currency} &7each.'
    Title:
      Enabled: true
      Title: "&2&m━━━&r &a&lItem &f&lListed &2&m━━━&r"
      Sub-Title: "&fx{amount} {item} &7at {unit-price} {currency} &7each!"
  • Title is the large line, Sub-Title the smaller line beneath it. Either can be left ''.
  • The same {tokens} the message uses work in the title and subtitle.
  • Enabled: false hides only the title; the chat message is independent.
  • Titles only show to players.

LISTED ships with a title enabled. Add a Title: block to any other key the same way.

Message keys

Section titled “Message keys”

Errors: PLAYER-ONLY, NO-PERMISSION, INVALID-PLAYER, INVALID-NUMBER, INVALID-CURRENCY, EMPTY-HAND, BLACKLISTED-ITEM, PRICE-TOO-LOW, PRICE-TOO-HIGH, LISTING-LIMIT, LISTING-FEE-UNPAID, ECONOMY-UNAVAILABLE, CANNOT-BUY-OWN, LISTING-GONE, INSUFFICIENT-FUNDS, INVENTORY-FULL, NOTHING-TO-COLLECT, NOTHING-TO-SELL, BUMP-COOLDOWN, BUMP-COST-UNPAID.

Prompts: SEARCH-PROMPT, SEARCH-CANCELLED, SEARCH-SET, PRICE-PROMPT, SELL-CANCELLED, AMOUNT-PROMPT.

Listings: LISTED, LISTING-BROADCAST, PURCHASED, ITEM-SOLD, PAYOUT-RECEIVED, LISTING-CANCELLED, LISTING-COLLECTED, COLLECTED-ALL, LISTING-EXPIRED, LISTING-BUMPED.

Admin: ADMIN-REMOVED, ADMIN-EXPIRED, ADMIN-REMOVED-NOTICE, RELOAD.

Help: AUCTION-HELP (/ah help), AUCTION-ADMIN-HELP (/ahadmin).

When they are sent

Section titled “When they are sent”
Message Sent when
EMPTY-HAND /ah hand or /ah all with nothing in the main hand.
NOTHING-TO-SELL /ah all found no matching items.
ECONOMY-UNAVAILABLE Listing in, or buying with, a currency whose economy is missing or disabled.
LISTING-GONE The listing was sold out, expired, cancelled or removed in the meantime.
INVENTORY-FULL A purchase does not fit, or cancelling / collecting has no room.
NOTHING-TO-COLLECT /ah collect or Collect All with no expired listings.
SEARCH-PROMPT, PRICE-PROMPT, AMOUNT-PROMPT A text prompt opens (search, sell price, custom buy amount).
SEARCH-CANCELLED, SELL-CANCELLED The player typed cancel or closed the anvil.
LISTING-BROADCAST Every other online player, when Broadcast-New-Listings is on.
ITEM-SOLD The seller, if online, after each purchase of their listing.
PAYOUT-RECEIVED Three seconds after joining, when payouts were held while the player was away.
LISTING-EXPIRED The seller, if online, when a listing expires.
ADMIN-REMOVED-NOTICE The seller, if online, when an admin removes their listing.

Tokens per message

Section titled “Tokens per message”
Message Tokens
INVALID-PLAYER {player}
INVALID-NUMBER {input} (what was typed)
INVALID-CURRENCY, ECONOMY-UNAVAILABLE {currency}
PRICE-TOO-LOW {min-price}
PRICE-TOO-HIGH {max-price}
LISTING-LIMIT {limit}
LISTING-FEE-UNPAID {fee}
INSUFFICIENT-FUNDS {price} (the total of the purchase)
BUMP-COOLDOWN {time} (4m, 12s)
BUMP-COST-UNPAID {cost}
SEARCH-SET {search}
PRICE-PROMPT {item}, {currency}
AMOUNT-PROMPT, LISTED, LISTING-BROADCAST, LISTING-EXPIRED, LISTING-BUMPED, ADMIN-REMOVED, ADMIN-REMOVED-NOTICE The listing tokens: {item}, {amount}, {stock}, {unit-price}, {price}, {currency}, {seller}, {expires}, …
PURCHASED, ITEM-SOLD The listing tokens, with {amount} / {stock} = items bought, {buyer}, and {price} = what the buyer paid (PURCHASED) or what the seller received after tax (ITEM-SOLD).
LISTING-CANCELLED, LISTING-COLLECTED The listing tokens, with {amount} / {stock} = items returned.
COLLECTED-ALL {amount} (number of listings collected)
PAYOUT-RECEIVED {price} (every held amount, comma separated if there were several currencies)
ADMIN-EXPIRED {player}, {amount} (listings expired)
RELOAD {ms} (reload time in milliseconds)

A token only resolves in the messages that provide it. Amounts in {min-price}, {max-price}, {fee}, {cost} and INSUFFICIENT-FUNDS are formatted in the currency of the listing, without its color.

Notes

Section titled “Notes”
  • {item} is inserted safely, so a renamed item can’t inject MiniMessage tags into the message.
  • ECONOMY-UNAVAILABLE shows the currency’s display name when listing and its id when buying.
  • Console-sent admin messages skip PlaceholderAPI; %...% is only resolved for player targets.