Messages & Styles

Every string a player sees comes from a language file. Every colour behind those strings comes from styles.yml.

Language files

lang/en.yml, lang/fr.yml, and lang/es.yml ship with the plugin. Pick one in config.yml:

language: en

What is in a language file

Section Covers
prefix The tag in front of chat messages
months Month names for the ranking header
general Shared lines: no permission, player not found, reloaded
jobs Per-job names and descriptions, keyed by job id
job Level ups, the xp action bar, admin confirmations
prestige Prestige messages and requirement lines
farmpoints Balance, given, taken, set
shop Purchases and failures
ranking Reset broadcast, claim lines, the menu header
reward Claim messages and the Claim All summary
boost Grants, clears, the boost item name and lore, and the active list
menu Every menu title and button name
placeholder Words the placeholders print: yes, no, the no-boost dash, the no-source wording, and an empty leaderboard slot
command Usage lines
content Text for shop items and level rewards, pointed at by lang: routes
Keys have to exist in all three files

A key present in en.yml but missing from fr.yml leaves French players with a blank line. Add to all three, or delete from all three.

Adding a language

  1. Copy a bundled file
    lang/en.yml to lang/de.yml, for example.

  2. Translate the values, not the keys
    Leave the key names and the {placeholders} exactly as they are.

  3. Point config.yml at it
    language: de.

  4. Reload
    /corejobs reload, or just save with auto-reload on.

Placeholders are positional in name only

{player}, {job}, {amount} and friends are replaced by name, so you can move them anywhere in the sentence to suit the grammar.

styles.yml

Paired tags you drop into any message or lore line:

styles:
  info: "&b"
  success: "&a"
  warning: "&e"
  error: "&c"
  alert: "&4&l"
  money: "&2"
  points: "&d"
  highlight:
    open: "<GRADIENT:FFD700>"
    close: "</GRADIENT:FFA500>"

Used like this in any message:

some-message: "<warning>Careful</warning>, that costs <points>500</points> points."
Form When to use
Shorthand, name: "<open>" The closing tag resets formatting with &r
Long form, open and close Gradients, or anything where the close matters
Change a scheme once

Every message that uses <warning> follows the tag. Re-colouring the whole plugin is one edit here rather than a search and replace across three language files.

Colours in general

Anywhere you can type text, you can use:

  • Colour codes: &a, &l, &r
  • Hex colours
  • Gradients: <GRADIENT:FFD700>text</GRADIENT:FFA500>
  • Your own style tags from styles.yml
MiniMessage tags do not work

Tags like <red> or <bold> are printed as plain text, they are not colours here. Stick to the four kinds above.

Previous menus.yml Next Storage