Translations and Custom Messages

EssentialsX includes messages for a wide range of languages out-of-the-box, as well as extensive support for customising almost every message in the plugin.

Changing your server's language

By default, EssentialsX will attempt to use your system language if it is supported by the plugin.
You can change the default language by uncommenting and setting the locale option in config.yml:

# Set the locale for all messages.
# ...
locale: de

NEW in 2.21.0: You can now enable per-player translations with the per-player-locale option!
With this enabled, EssentialsX will attempt to display messages to each player in the language they play Minecraft in.
Players can change their game language in their game's settings. If a language is not supported, EssentialsX will use the default locale set above.

# Should EssentialsX use player's language instead of the server's when sending messages?
# ...
per-player-locale: true

Supported languages

The languages listed below are supported out-of-the-box.
Note that not all languages are fully translated; any messages missing from the translation will display in English.

Translations are maintained by our community.
If your language is incomplete or isn't listed here, you can help translate EssentialsX over on Crowdin.

Customising messages

In addition to using EssentialsX's built-in translations, you can also customise the text, appearance and functionality of EssentialsX messages!

Changing the default colors

NEW IN 2.21.0: If you want to change the colors used in the standard EssentialsX messages, you can do so using the message-colors section of config.yml:

# Change the default primary and secondary colours used in EssentialsX messages.
# Some messages may use custom colours, which will need to be edited in the appropriate message files.
# For more information on customising messages, see https://essentialsx.net/wiki/Locale.html
message-colors:
  primary: '#ffaa00'
  secondary: '#ff5555'

Changing the text content

If you want to make more advanced changes to messages, you can create custom message files under the plugins/Essentials/messages/ folder.
In this directory, create an empty file named messages_<lang>.properties, where <lang> is the language code for the language you want to edit.
You can now insert any customised messages in this file, and they will be loaded by EssentialsX the next time you restart your server. For example:

backOther=<primary>Returned <secondary>{0}<primary> to previous location.

Note the numbers in curly braces (ie {0}, {1}). These are template placeholders, which EssentialsX will replace as appropriate before displaying the message. You can compare the messages in the default message files with the appearance in-game to determine which messages are needed.

The colors defined in the config.yml file can also be used in your custom messages, and will be applied to text inside <primary>Gold text here</primary> and <secondary>Red text here</secondary> tags.

You can search through the default messages files on GitHub. We strongly recommend copying only the messages you want to edit, as this will make it easier to manage and update these files across EssentialsX versions.

Note: do not edit any messages files directly inside the EssentialsX jar. You will lose these changes when you update the plugin and they will not be converted to the new MiniMessage format automatically.

Using rich text elements

NEW IN 2.21.0: EssentialsX now supports the MiniMessage syntax for its messages. This allows you to include gradients, hoverable and clickable elements, custom fonts and more!

Below is an example of hoverable/clickable elements in an EssentialsX message:

backAfterDeath=<primary><hover:show_text:'Click to go back'><click:run_command:'/back'><secondary>Click here</secondary> to return to your death point.

You can find a full reference guide for the MiniMessage syntax on the Adventure wiki. You can also use Adventure's MiniMessageViewer to preview custom messages (although this doesn't support EssentialsX's <primary> and <secondary> tags).

Hiding specific messages

Most messages can be disabled or hidden - simply set the message to blank. For example:

noNewMail=

Editing messages in the config file

There are a small number of settings in EssentialsX which can be altered by editing plugins/Essentials/config.yml, such as the currency format, and custom join and leave messages.

Creating custom text commands

EssentialsX's text commands can be edited through text files in the plugins/Essentials directory. For more information, see Text Commands.