Message Customization

Player messages are split across two places:

plugins/BusyMining/messages.yml: command messages (no permission, reload, Zeta balance, unknown command) and every line of /mine help.
plugins/BusyMining/modules/<module>/messages.yml: each module's own messages (level-ups, drops, summons, trials, shop sales, and so on).

Formatting

Every message accepts MiniMessage tags (<green>, <bold>, <#ff8800>), &#rrggbb hex colours and legacy & codes, in any mix.

Prefix

yaml

prefix: "[Mining] "

The prefix is set in config.yml, not in a messages file. It's added automatically in front of most chat messages; loot lines and help lines are sent without it. The prefix is read at startup, so a change needs a restart rather than /mine reload.

Placeholders

Each message receives its own {key} placeholders, such as {level}, {tier}, {amount}, {vessel} or {time}. Module messages also accept the same keys written as %key%. Check the default text of the message you're editing to see what it receives. A placeholder the message doesn't receive prints as literal text.

In messages.yml, the help lines use {label}, which becomes the command the player typed (mine, bm or busymine):

yaml

help:
  header: "BusyMining — Command List"
  menu: "/{label} — Open the main mining menu"
  shop: "/{label} shop — Open the mining sell shop"

Admin help lines are only shown to players with busymining.admin.

Missing and old messages

New messages from an update are added to your files automatically, in double quotes, without changing anything you wrote (see Module Configuration). Keys you already have are never overwritten, so reworded defaults don't replace your existing text. Delete a key to get its current default back on the next restart or /mine reload.

A few short messages (mostly admin command feedback and some menu hints) are written in code and can't be changed from the messages files yet.

Applying changes

/mine reload after any edit to a messages file. The prefix needs a restart.