-
Notifications
You must be signed in to change notification settings - Fork 16
Minecraft Chat Customization
In the [minecraftChatStyle] configuration section, you can set custom styles for certain message categories using Markdown and colored text.
Tip
You can read about applying styles to text at markdown and colored text
To enable applying specified styles to messages, you must set the parameter
enableMinecraftChatCustomization = trueWarning
When enabling chat customization, make sure you don't have any other mods installed with the same functionality.
Otherwise, it may cause errors and crash the game.
For each message type, the comments to the configuration parameter specify dynamic parameters that will be inserted into the message when generated.
Below are three general parameters that you can apply to any message type:
-
{HH}— the number of UTC hours at the time the message was sent -
{MM}— the number of UTC minutes at the time the message was sent -
{SS}— the number of UTC seconds at the time the message was sent
You can substitute these parameters into the message type template like this:
minecraftPlayerMessageStyle = "[{HH}:{MM}:{SS}] <{player}> {message}"To ultimately get the following result in the game:
My local time is 21 hour because my time zone is UTC+5.
You can specify the offset from UTC using the utcOffsetHours parameter, located at the beginning of the configuration.
By default, it's 0, which corresponds to an offset of 0 hours from UTC. In my case, I should set it to 5 to get an offset of 5 hours:
utcOffsetHours = 5
Result:
For all message types where the {player} parameter is available, the following parameters are also available:
-
{x},{y},{z}— The player's coordinates at the time the message was sent -
{dimension}— The name of the dimension the player is in (Overworld, Nether, End, or dimensions from other mods)
Message template example:
minecraftPlayerMessageStyle = "<grey>[{dimension} ({x}, {y}, {z})]<grey/> <{player}> {message}"
Note
By default, each message category is set to a value that matches the game's default style. Below are some example styles for different message types.
The minecraftChatLinkColor parameter controls the color in which links are displayed in the game.
ℹ️ This template applies whether chat customization is enabled or not
The default value is #00b7ff.
minecraftChatLinkColor = "#00b7ff"You can choose any other color from the presets (Colored Text) or specify a hex value. Below are examples of the colors red, green, blue, and #785fc9
The minecraftDiscordMessagesStyle parameter controls the style in which Discord user messages are displayed in the game chat.
ℹ️ This template applies whether chat customization is enabled or not
Available options:
-
{guild}— The name of the Discord server from which the message came -
{member}— Nickname of the server member from whom the message was received -
{message}— Message text
Examples of message templates and their display in the game:
**<#5f78d9>[discord]<#5f78d9/>** <{member}> {message}
{member} *from guild* <red>{guild}<red/> >> <grey>*{message}*<grey/>
[<green>{HH}<green/>:<green>{MM}<green/>:<green>{SS}<green/>] [**{guild}**] <*{member}*> {message}
The minecraftPlayerMessageStyle parameter is responsible for the style of displaying messages from players in the game chat.
Available options:
-
{player}— Player name -
{message}— Message text
Examples of message templates and their display in the game:
<{player}> <red>{message}<red/>
<aqua>**{player}**<aqua/> >> <grey>*{message}*<grey/>
*\"{message}\"* << **{player}** at __{HH}:{MM}__
-
Death messages in the game are composite and always contain the player who died (the
{player}parameter) and the cause of death (the{death_cause}parameter). -
If a player was killed by another player or mob, the cause of death will also include their name (the
{second_entity}parameter). -
If a player was killed using a custom-named item, its name will also be displayed as the weapon used (the
{item}parameter).
ℹ️ The {player}, {second_entity}, and {item} parameters are ultimately substituted into the {death_cause} cause of death text. Therefore, the styles for each parameter are set separately in the configuration.
For example, you can make the entire cause of death text gray and italicized
minecraftPlayerDeathCauseStyle = "<grey>*{death_cause}*<grey/>"
minecraftPlayerDeathNameStyle = "{player}"
minecraftPlayerDeathSecondEntityNameStyle = "{second_entity}"
minecraftPlayerDeathWeaponStyle = "{item}"
And apply different styles to individual parameters, for example:
- Display a dead player in bold and green
- Display the killer in bold and red
- Display the murder weapon in underlined
minecraftPlayerDeathCauseStyle = "<grey>*{death_cause}*<grey/>"
minecraftPlayerDeathNameStyle = "<green>**{player}**<green/>"
minecraftPlayerDeathSecondEntityNameStyle = "<red>**{second_entity}**<red/>"
minecraftPlayerDeathWeaponStyle = "__{item}__"Result:



Some message templates have translatable parameters whose text is substituted depending on the selected game localization.
For example, for game login and logout messages, these are {multiplayer.player.joined} and {multiplayer.player.left}.
Their use is optional, and you can define your own text instead.
For example, instead of
minecraftPlayerJoinedStyle = "<yellow>{player} {multiplayer.player.joined}<yellow/>"You can define your text:
minecraftPlayerJoinedStyle = "<green>{player} has joined our server! Enjoy the game!<green/>"ℹ️ The remaining message types are configured using the same principles as the example messages above.
If you have any questions, you can contact the developer using the special form