🏔️ EXPERIMENTAL BUILD: Chat components and MiniMessage in translations!

[mdcfe]

We're going on an adventure!

@JRoy has been working extensively on adding support for chat components to EssentialsX. You can now test an early preview of component support in EssentialsX with the new experimental build!

Table of Contents

• Using MiniMessage
• Features
• Downloads and Changelogs

Using MiniMessage

With this experimental build, you can now use the MiniMessage syntax to create components with hovers and clickable events. For example:

# original
teleportRequest=\u00a7c{0}\u00a76 has requested to teleport to you.
typeTpaccept=\u00a76To teleport, type \u00a7c/tpaccept\u00a76.
typeTpdeny=\u00a76To deny this request, type \u00a7c/tpdeny\u00a76.
# with MiniMessage
teleportRequest=MM||<red>{0} <gold>has requested to teleport to you.
typeTpaccept=MM||<gold>To <green>accept</green> this teleport request, run <hover:show_text:'Click here to accept the request!'><click:run_command:'/tpaccept'><u><color:#20c0e0>/tpaccept</color></u></click></hover>.
typeTpdeny=MM||<gold>To <red>refuse</red> this teleport request, run <hover:show_text:'Click here to refuse the request.'><click:run_command:'/tpdeny'><u><color:#20c0e0>/tpdeny</color></u></click></hover>.

To add your own MiniMessage translations, all you need to do is add MM|| at the start of the translation, then you can use the full MiniMessage syntax in translations, along with the classic {N} placeholders you're used to from EssentialsX.

For help with writing MiniMessage messages, you can use the Adventure MiniMessage web editor. You can also refer to the official MiniMessage documentation for more information.

Features

The features currently supported in experimental builds are:

• MiniMessage colours, styles and gradients in messages.properties

The features are not currently in experimental builds are:

• MiniMessage in MOTD, custom text commands and books.txt - this will be added at a later date.
• MiniMessage in the default messages.properties files - we're considering adding these later.
• MiniMessage in command inputs - we're still deciding how we want to handle this. For now, you can keep using the & codes as before.

There may be other player-facing features which don't support MiniMessage. We're reviewing these on a case-by-case basis. If you would like to request MiniMessage support for a particular feature, let us know in the thread below.

Downloads and Changelogs

We want your feedback! This is just the start of chat component support.
You can discuss the experimental build below, or in the forum channel on MOSS.

Alpha 1 (2.20.0-dev+46-b59d50c / b59d50c)

• Initial experimental build.
• Supports MiniMessage colours, styles and gradients in translations using the MM|| prefix.
• ℹ️ Note: RGB colours and gradients will only function when both the server and client are running 1.16.x and above.

⬇️ Download Alpha 1

[Pantera07]

[JRoy]

1. This is intended behavior, it takes time to load a locale from disk and delaying messages isn't logistically possible (could show out of order, never end up sending, or be extremely delayed), so I just send in the server locale instead. This only happens once as the locale only needs to be loaded once.
2. These would require the server owner to make a file for each locale. If you could, make another feature request for this as it's out of the scope for this PR.

[Pantera07]

[JRoy]

What language are you using? This string is translated but it may not be in your language yet and thus defaults to the server's locale.

[Pantera07]

[JRoy]

This is intended behavior, it takes time to load a locale from disk and delaying messages isn't logistically possible (could show out of order, never end up sending, or be extremely delayed), so I just send in the server locale instead. This only happens once as the locale only needs to be loaded once.

[BlockyTheDev]

This is intended behavior, it takes time to load a locale from disk and delaying messages isn't logistically possible (could show out of order, never end up sending, or be extremely delayed), so I just send in the server locale instead. This only happens once as the locale only needs to be loaded once.

Is it possible to already load the messages when a player joins with that language or does this need to much memory/server resources (configurable in plugin config)... or is the server not knowing the language at this state?

[JRoy]

Is it possible to already load the messages when a player joins with that language or does this need to much memory/server resources (configurable in plugin config)... or is the server not knowing the language at this state?

The client sends language data to the server sometime after the player has joined and to prevent DoS attacks, it's better we wait for a message to be sent to the player than to constantly be looking for language information.

[BlockyTheDev]

Is it possible to already load the messages when a player joins with that language or does this need to much memory/server resources (configurable in plugin config)... or is the server not knowing the language at this state?

The client sends language data to the server sometime after the player has joined and to prevent DoS attacks, it's better we wait for a message to be sent to the player than to constantly be looking for language information.

Would a config option to load all available languages at server startup consume too many server resources while the server is running?