Messages and Language

Every piece of text a player sees comes from one language file. Edit that file and the wording, the colours and the menu titles all change with it.

Where the file lives

The language key in config.yml picks which file is loaded.

language: en_US

Shipped languages

Four translations ship inside the jar, and they are key for key identical, so switching between them never leaves a gap.

On startup the plugin writes en_US.yml to disk if it is not there, then looks for the file named by language. If that file is in the jar it is written out too. If it is not, a copy of en_US.yml is created under that name as a starting point for your own translation.

How your file is kept up to date

Language files are managed by BoostedYAML, which merges rather than overwrites. On every startup your active file is compared against the version in the jar, and against en_US as a backstop.

The practical effect is that a translation which has fallen behind still works. Anything it is missing falls back to the English line instead of printing a "message not found" placeholder.

Every file under lang/ carries a config-version at the top, the same key config.yml has. It is the plugin's record of which revision your file is at, which is how it works out what a new release has added.

# Internal file revision. Do not edit.
config-version: 1

Colours

Both colour styles work anywhere in the file.

The prefix

The prefix key at the top of the file is inserted wherever a message contains {prefix}.

prefix: '&#00FFFF[StaffMode] '

staff-mode:
  enabled: '{prefix}&#00FF00Staff mode enabled!'

Remove {prefix} from a message to have it print without the tag.

What each section covers

Placeholders

Only the placeholders listed here are replaced. Anything else is printed as written.

{type} in cps.alert is not an English word baked into the code. It is filled from cps.type-left or cps.type-right, two keys in the same file, so the alert reads in one language throughout.

The update notice

update.available is a list of lines rather than a single string, so you can make the notice as long or as short as you like. It is sent to staff holding atstaffmode.updates when they join and a newer release exists.

update:
  available:
    - '{prefix}&#FFFF00A new version of AT-StaffMode is available!'
    - '{prefix}&#FFFFFFRunning &#FF0000{current}&#FFFFFF, latest is &#00FF00{latest}'
    - '{prefix}&#00FFFFSpigot: &#FFFFFF{spigot}'
    - '{prefix}&#00FFFFBuiltByBit: &#FFFFFF{builtbybit}'

Drop a line you do not want and the rest still sends. Whether the notice appears at all is controlled by update-checker in config.yml, see Installation.

Keys added in 1.5.0

Several lines that used to be hardcoded English are now yours to edit.

The debug.staffmode-enabled and debug.staffmode-disabled keys were removed in the same release, along with the /staffmode-debug command they belonged to. If they are still in your file, they are simply unused.

staffchat.format also has two small keys of its own, staffchat.status.in-staffmode and staffchat.status.not-in-staffmode. Whichever applies is what {status} becomes.

Menu text

The gui branch holds the titles, item names and lore for every menu.

Menu lore takes placeholders too. The report entries in gui.reports.items.report-item.lore accept {reporter}, {reason}, {date}, {status_color}, {status} and {assigned}, and the item name accepts {player}.

gui:
  reports:
    items:
      report-item:
        name: '&eReport: &f{player}'
        lore:
          - '&7Reporter: &f{reporter}'
          - '&7Reason: &f{reason}'
          - '&7Date: &f{date}'
          - '&7Status: {status_color}{status}'
          - '&7Assigned to: &f{assigned}'

{status_color} is a colour code chosen from the report status, so put it immediately before {status}.

Adding a language

If the language you want is not one of the four that ship, write your own.