Custom Server Messages

<div align="center"> # Server Messages (https://img.shields.io/badge/modrinth-00AF5C?logo=modrinth&logoColor=white)](https://modrinth.com/mod/servermessages) (https://img.shields.io/badge/GitHub-181717?logo=github)](https://github.com/arvitus/ServerMessages) (https://img.shields.io/badge/Discord-5662f6?logo=discord&logoColor=white)](https://discord.gg/xzdbetZVrn) A Minecraft mod to customize any server message, with support for text formatting and placeholders. </div> --- ## What does it do? This mod lets you modify any<sup id="a1">](#f1)</sup> server message to your liking. You can replace the message itself, add or change the (https://placeholders.pb4.eu/user/quicktext/), and even use (https://placeholders.pb4.eu/). The format is fully compatible with the (https://minecraft.wiki/w/Raw_JSON_text_format#Translated_Text) used by language files. Common use cases include changing the color of messages like "You have been banned", adding information to the "You're not whitelisted" message or customizing the kick notification. You could even use the mod to display some stats when a player joins or leaves the server or make death messages appear in rainbow colors. The possibilities are endless! > !(https://shieldcn.dev/badge/Note-3b82f6.svg?variant=outline&logo=ri%3APiInfoBold&logoColor=3b82f6) > For anything chat related, I recommend using (https://modrinth.com/mod/styled-chat) instead. > If you do, all related messages in this mod will be disabled to prevent conflicts. > You can then change them using Styled Chat. ## How do I use it? To modify a message, you simply add the corresponding (https://github.com/InventivetalentDev/minecraft-assets/blob/26.1/assets/minecraft/lang/en_us.json) to the config and change its value to your liking. The text format is based on the (https://minecraft.wiki/w/Raw_JSON_text_format#Translated_Text) and also supports the (https://placeholders.pb4.eu/user/quicktext) for text formatting and global (https://placeholders.pb4.eu/user/default-placeholders/). You can reload the config with `/reload`. The format for placeholders is `${placeholder}` and for most messages you can only use placeholders that do NOT depend on a player/entity! So `${server:tps}` and `${world:name}` (overworld) are perfectly fine, but `${player:name}` will not always work. *For more information, see (#placeholder-contexts).* The config format is compatible with the Minecraft language file format. So you could simply replace the config with a language file (strongly discouraged) and it would work just fine. Note, however, that this would NOT overwrite the language setting of the players! For reference, you can find a list of all language files currently available (https://github.com/InventivetalentDev/minecraft-assets/tree/26.1/assets/minecraft/lang). If you use translation keys manually ((https://placeholders.pb4.eu/user/quicktext) / (https://placeholders.pb4.eu/user/text-format) or (https://minecraft.wiki/w/Text_component_format)), for example in chat messages or other mods, they will also be affected by this mod and thus use the same formatting as specified in the config. If you do not want this, you can either append `r` or `raw` to the (https://placeholders.pb4.eu/user/quicktext/#translations) / (https://placeholders.pb4.eu/user/text-format/#translations) translation tags (`<lang ...>` -> `<rlang ...>`), or add `#raw` as the **last** argument to the translation arguments. *For example, `<rawlang ...>` is the same as `<lang ... #raw>` and will prevent the message from being modified. For (https://minecraft.wiki/w/Text_component_format#Translated_Text), it would look like this: `{"translate": "...", "with": }`.* > !(https://shieldcn.dev/badge/Note-3b82f6.svg?variant=outline&logo=ri%3APiInfoBold&logoColor=3b82f6) > Any other mod that modifies server messages (e.g. (https://modrinth.com/mod/banhammer)), will most > certainly take precedence over changes made by this mod. <h3 id="example-config"></h3> ### Example Config ```json5 { // only change formatting "multiplayer.disconnect.not_whitelisted": "<red><bold><lang multiplayer.disconnect.not_whitelisted></bold></red>", // replace message; use placeholder "multiplayer.disconnect.server_shutdown": "<green>We'll be right back!</green>\n<gray><underline>Uptime: </>${server:uptime}</gray>", // add text; use nested translation argument "multiplayer.player.joined": "<yellow><lang multiplayer.player.joined '%s'>. Good to see you!</yellow>", // replace message; use translation argument "multiplayer.player.left": "<yellow>See you soon, <bold>%s</bold>!</yellow>", // custom translation key; add reason to kick message