Skip to content
BattleStudio

messages.yml

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

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

Format

Section titled “Format”
Messages:
  DISCOVERED:
    Message:
      Enabled: true
      Value:
      - '&5[&d&lIndex&5] &7You discovered &f{item} &8({discovered}/{total})&7!'
  • 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.

Titles

Section titled “Titles”

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

Messages:
  INDEX-COMPLETED:
    Message:
      Enabled: true
      Value:
      - '&5[&d&lIndex&5] &7You completed your index by discovering all &f{total} &7items!'
    Title:
      Enabled: true
      Title: '&2&m━━━&r &a&lIndex &f&l100% &a&lCompleted &2&m━━━&r'
      Sub-Title: '&7You discovered all &f{total} &7items!'
Key Default Description
Enabled - false hides only the title, leaving the chat message untouched.
Title - The large centre line. Can be ''.
Sub-Title - The smaller line beneath it. Can be ''.
Fade-In 10 Fade-in time in ticks.
Stay 60 Time on screen in ticks.
Fade-Out 10 Fade-out time in ticks.
  • The same {tokens} the message uses resolve in the title and subtitle.
  • The Title block and the chat Message are independent - keep both, or disable one and show the other.
  • Titles only show to players.

INDEX-COMPLETED ships with a title enabled. Add a Title: block to any other key the same way, for example to CATEGORY-COMPLETED.

Message keys

Section titled “Message keys”

Errors: PLAYER-ONLY, NO-PERMISSION, INVALID-PLAYER, UNKNOWN-PLAYER, INVALID-ENTRY, PROFILE-LOADING, TARGET-LOADING.

Discovery: DISCOVERED, DISCOVERED-MULTIPLE, CATEGORY-COMPLETED, INDEX-COMPLETED, INDEX-COMPLETED-BROADCAST.

Admin: ADMIN-DISCOVERED, ADMIN-RESET, RELOAD, INDEX-ADMIN-HELP.

Key Sent when
PLAYER-ONLY /index is run from console.
NO-PERMISSION The sender lacks the permission for the command.
INVALID-PLAYER An /indexadmin target is not online.
UNKNOWN-PLAYER /index <name> names a player who has never joined.
INVALID-ENTRY An /indexadmin item key is not in the index.
PROFILE-LOADING The player runs /index while their own data is still loading after join.
TARGET-LOADING The target is online but their data is still loading.
DISCOVERED A single entry is discovered.
DISCOVERED-MULTIPLE One scan or grant discovers several entries at once (sent instead of DISCOVERED).
CATEGORY-COMPLETED A discovery completes a category. Sent once per completed category.
INDEX-COMPLETED A discovery completes the whole index.
INDEX-COMPLETED-BROADCAST Same moment, to the whole server. Only when Settings.Broadcast-Index-Completion is true.
ADMIN-DISCOVERED After /indexadmin discover, to the sender.
ADMIN-RESET After /indexadmin reset, to the sender.
RELOAD After /indexadmin reload.
INDEX-ADMIN-HELP /indexadmin with no or wrong arguments.

Tokens per message

Section titled “Tokens per message”
Message Tokens
DISCOVERED {item}, {category} (the first category the entry is in), {discovered}, {total}, {player}
DISCOVERED-MULTIPLE {amount} (new entries), {discovered}, {total}, {player}
CATEGORY-COMPLETED {category}, {discovered}, {total}, {player}
INDEX-COMPLETED, INDEX-COMPLETED-BROADCAST {player}, {discovered}, {total}
INVALID-PLAYER, UNKNOWN-PLAYER, TARGET-LOADING {player} (the name that was typed or the target)
INVALID-ENTRY {entry} (the key that was typed)
ADMIN-DISCOVERED, ADMIN-RESET {player}, {amount} (entries added or removed)
RELOAD {ms} (reload time in milliseconds)

{discovered} and {total} are the player’s new count and the index total after the discovery. A token only resolves in the messages that provide it - {item} in CATEGORY-COMPLETED, for example, is left as literal text.

Notes

Section titled “Notes”
  • Error lines use the &4[&c&lError&4] prefix and the rest use &5[&d&lIndex&5]. Change them freely, they are just text.
  • To make discoveries quieter, disable DISCOVERED and DISCOVERED-MULTIPLE and silence the DISCOVERED sound in config.yml.
  • INDEX-ADMIN-HELP is only the help text. Editing it does not change the commands.