zQuestRank

Messages & language

Editing messages, switching language, and adding your own translation.

Every message and menu text lives in the lang/ folder. English (en.yml) and French (fr.yml) ship with the plugin.

Switching language

Set the file name (without .yml) in config.yml:

general:
  language: "fr"

Then /rank admin reload. Menus, quest text, and chat messages all switch.

Editing messages

Open the active lang file and change any line. The files cover:

  • Menu titles, buttons, and rank states.
  • Quest objective templates per quest type (Break {amount} {name}, Catch {amount} fish, ...).
  • Progress and status lines.
  • Claim button text, requirement lines, the promotion broadcast.
  • Command feedback and error messages.

Placeholders in curly braces (like {amount}, {player}, {rank}) are filled by the plugin; keep them in your text wherever you want the value to appear.

A title per rank menu page

menu.rank-title is the title of the whole rank menu. To give one page its own title, or its own ItemsAdder title image, add a menu.rank-title-<page number> key next to it:

menu:
  rank-title: "Ranks"          # fallback for any page you do not list
  rank-title-1: "&fPageOneImage"
  rank-title-2: "&fPageTwoImage"

rank-title-1 is the first page, rank-title-2 the second, and so on. Pages with no entry use the plain rank-title. Handy in manual layout when each page carries a different frame image.

Item and mob names follow the player's client

On Paper servers, the block, item, and mob names inside quest menu icons and in chat messages (the {name} part of objectives, the delivery messages, the quest completed notice) render in each player's own game language. A French client sees "Pierre" where an English client sees "Stone", automatically. Nothing to configure.

  • Needs Paper or a Paper fork. On plain Spigot the names show in English.
  • Only the item, block, or mob name follows the client. The rest of the text (the "Break 500 ..." wording) still comes from the server's language file above.

Colors

Two formats work in every message: classic codes (&a, &6, &l, ...) and &#rrggbb hex colors. The full code tables are on the Colors page.

Adding your own language

Pick a name

Set general.language to something new, for example "de".

Reload once

Run /rank admin reload. The plugin creates lang/de.yml filled with the English defaults.

Translate

Edit the new file line by line, keep the {placeholders}, then reload again.

On plugin updates, new message keys are merged into your lang files automatically (driven by the lang-version key at the top; leave it alone). Your translated lines are kept.

On this page