Skip to content

messages.yml

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

Messages:
REWARD-CLAIMED:
Message:
Enabled: true
Value:
- "&5[&d&lPass&5] &7You claimed the &fTier {tier} {type} &7reward!"
  • Enabled: false silences a message entirely.
  • Value is a list - every line is sent (used for the multi-line admin help panel).
  • Keep the {tokens} intact; donโ€™t rename the message keys.

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

Any message can also flash a title and subtitle on the playerโ€™s screen. Add a Title: block next to Message::

Messages:
TIER-UP:
Message:
Enabled: true
Value:
- "&5[&d&lPass&5] &7You reached &fTier {tier}&7. Open &f/battlepass &7to claim your rewards!"
Title:
Enabled: true
Title: "&2&mโ”โ”โ”&r &a&lTier &f&l{tier} &a&lCompleted &2&mโ”โ”โ”&r"
Sub-Title: "&7Claim your reward in &f/battlepass&7!"
  • Title is the large centre line, Sub-Title the smaller line beneath it. Either can be left ''.
  • The same {tokens} the message uses resolve in the title and subtitle.
  • Enabled: false hides only the title, leaving the chat message untouched.
  • The Title block and the chat Message are independent - keep both, or disable one and show the other.
  • Titles only show to players, with fixed 10/60/10-tick fade timings.

TIER-UP ships with this title enabled. Add a Title: block to any other key the same way.

Errors: PLAYER-ONLY, NO-PERMISSION, INVALID-PLAYER, INVALID-NUMBER, REWARD-LOCKED, ALREADY-CLAIMED, PREMIUM-REQUIRED.

Progress: EXP-GAINED (ships disabled), TIER-UP, REWARD-CLAIMED.

Purchases: MULTIPLIER-PURCHASED, MULTIPLIER-MAXED, MULTIPLIER-NOT-PURCHASABLE, PREMIUM-PURCHASED, PREMIUM-ALREADY-OWNED, PREMIUM-NOT-PURCHASABLE, INSUFFICIENT-FUNDS, PURCHASE-UNAVAILABLE.

Admin: EXP-GIVEN, EXP-TAKEN, EXP-SET, MULTIPLIER-SET, PREMIUMPASS-GIVEN, PREMIUMPASS-TAKEN, PASS-RESET, RELOAD, BATTLEPASS-ADMIN-HELP.

Message Tokens
EXP-GAINED {amount}, {exp}
TIER-UP {tier}
REWARD-CLAIMED {tier}, {type} (Free or Premium)
REWARD-LOCKED {tier}, {required}, {exp}
MULTIPLIER-PURCHASED {multiplier} (the new value)
MULTIPLIER-MAXED {max}
INSUFFICIENT-FUNDS {price}
EXP-GIVEN / -TAKEN / -SET {player}, {amount}
MULTIPLIER-SET {player}, {multiplier}
PREMIUMPASS-GIVEN / -TAKEN, PASS-RESET, INVALID-PLAYER {player}
INVALID-NUMBER {input}
RELOAD {ms} (reload time in milliseconds)

ALREADY-CLAIMED, PREMIUM-REQUIRED, PREMIUM-PURCHASED, PREMIUM-ALREADY-OWNED, PURCHASE-UNAVAILABLE and the two NOT-PURCHASABLE keys take no tokens.

  • EXP-GAINED ships with Enabled: false, and its sound ships blank. At the default Experience.Chance: 100.0 that is one message per block break. Only turn it on with a much lower chance.
  • PURCHASE-UNAVAILABLE means the configured economy provider could not be resolved - the plugin isnโ€™t installed, or Vault has no economy registered. Check the console for the warning logged at startup.
  • MULTIPLIER-NOT-PURCHASABLE and PREMIUM-NOT-PURCHASABLE are the Purchasable: false denials, distinct from PURCHASE-UNAVAILABLE. Both ship with the same wording; change one if you want to tell them apart.
  • Purchase messages are sent by the manager, not the menu, so they appear on both the main-menu check and the confirm click.
  • Console-sent admin messages skip PlaceholderAPI; %...% is only resolved for player targets.