--- Embellish Chat enhances Minecraft chat with item and inventory showcases, built-in icons, mentions, and rich formatting. Players can show off gear, open showcased inventories, and use more expressive chat features without requiring the mod on their client. --- ## ✨ Key Features * **Item and Inventory Showcases** Showcase your held item, inventory, or ender chest directly in chat with `[i]`, `[inv]`, and `[end]`, allowing other players to inspect them interactively. * **Built-in Chat Icons** Use `:name:` syntax to insert built-in Minecraft-based icons into messages. * **Rich Chat Formatting** Style messages with bold, italic, underline, strikethrough, custom fonts, hex colors, gradients, presets, and rainbow effects. * **Smart Mention System** Mention players, `@here`, `@team(name)`, `@world(name)`, or `@everyone` with clear notifications. LuckPerms group mentions are also supported. * **Useful Chat Utilities** Hover messages to see exact timestamps and click them to copy their content with the timestamp. * **Server-side mod with optional client features** Embellish Chat works fully server-side for all core chat features. Players do not need to install the mod on their client. It is marked as **Server & Client** only because an optional client-side mention autocomplete feature is available when the mod is installed on the client. --- ## 🛠️ Styling System Use the following patterns directly in the chat window to apply styles: | Feature | Syntax | Example | Showcase | |:-----------------|:------------------------|:--------------------------------------------------------------|:------------------------------------------------------------------------------------------| | Bold | `**Text**` | `**You really need to read this!**` | ![Bold](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Bold.png) | | Italic | `_Text_` | `_This is top secret..._` | ![Italic](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Italic.png) | | Underline | `__Text__` | `__Check this out__` | ![Underline](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Underline.png) | | Strikethrough | `~~Text~~` | `~~We don’t talk about this anymore~~` | ![Strike](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Strikethrough.png) | | Obfuscated | `\|\|Text\|\|` | `\|\|Unreadable text\|\|` | ![Obfuscated](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Obfuscated.gif) | | Color (Hex) | `[Text]<#RRGGBB>` | `[Blue]<#0000FF> like the deep ocean` | ![Color](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Color_Hex.png) | | Color (Gradient) | `[Text]<#RRGGBB #R...>` | `[Grraaaaaaadieeeeent]<#ffaaaa #aaaaff #aaffaa>` | ![Color](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Color_Gradient.png) | | Color (Preset) | `[Text]` | `[pink] pig` | ![Color](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Color_Preset.png) | | Color (Rainbow) | `[Text]` | `look at this [rainbow]` | ![Color](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Color_Rainbow.png) | | Link | `[Text](URL)` | `Download it [here](https://modrinth.com/mod/embellish-chat)` | ![Link](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Link.gif) | | Font | `[Text]{path}` | `[Blorp Zorp]{minecraft:alt}` | ![Font](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Font.png) | | Item | `[i]` | `Look at my [i]` | ![Item](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Item.png) | | Inventory | `[inv]` | `Look at my [inv]` | ![Inventory](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Inventory.png) | | Ender Chest | `[end]` | `Look at my [end]` | ![EnderChest](https://hanhy06.github.io/embellish-chat-wiki/assets/images/EnderChest.png) | | Icon | `:name:` | `I :love: you` | ![AtlasIcon](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Atlas_Icon.png) | | Mention | `@PlayerName` | `Hello, @User` | ![Mention](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Mention.png) | > **Notes** > > * **Links:** The built-in default link rules only match `https://` URLs. > * **Colors:** Presets (e.g., `pink`) are defined in `presets.json/color`. > * **Fonts:** The `path` requires a namespaced ID (e.g., `minecraft:alt`). > * **Icons & Item Sprites:** Icon presets and item sprite rendering use atlas-backed components, so they are not supported on older Minecraft versions. > * **More Info:** For advanced syntax, style combinations, and detailed rules, refer to `/embellish-chat help style` or the [StyleWiki](https://hanhy06.github.io/embellish-chat-wiki/style/StyleSystem/). --- ## 🗣️ Mention System | Target | Behavior | |:---------------|:------------------------------------------------------------------------------------------| | `@PlayerName` | Mentions a specific player. | | `@team(name)` | Mentions all players in the specified team. | | `@group(name)` | Mentions all players in the specified **LuckPerms** group. | | `@world(name)` | Mentions all players in the specified world. | | `@everyone` | Mentions every player on the server. | | `@here` | Mentions players within a configurable radius (default: **64 blocks**) in the same world. | > **Notes** > > * **Behavior:** Successful mentions send a notification sound to the target and automatically tint the text (e.g., to the team color). > * **Dependencies:** `@group` requires **LuckPerms**. Without it, the mention will be ignored. > * **Colors:** `@team` and `@Player` mentions start from the `team_color` value in `config.json`, then use the target's team/display styling when available. If `team_color` is `null`, the mention text is left uncolored. > * **Sound:** The notification sound uses the **UI** category (falls back to the **PLAYER** category on Minecraft 1.21.5 and earlier). > * **More Info:** For a full list of mention types and advanced usage, refer to [MentionWiki](https://hanhy06.github.io/embellish-chat-wiki/mention/MentionSystem/). --- ## ⌨️ Commands ### Admin Commands > Requires **OP Level 2** (or `GAMEMASTERS_CHECK` on 1.21.11+). * **`/embellish-chat reload`** Reloads all configuration files under `/config/embellish-chat/` immediately. * **`/embellish-chat ban/pardon `** Blocks or restores a player's access to all mod features. * **`/embellish-chat stress_test `** Repeatedly simulates `` messages for `` to stress-test the server's message-processing performance. * **`/embellish-chat regex_test `** Tests the provided `` against `` and highlights capture groups to analyze the match result. ### User Commands > Available to **all players** (no permission required). * **`/embellish-chat open `** Opens the last shared inventory/ender/item of the specified player. * **`/embellish-chat help mention`** Displays the mention rules available to you based on your permissions. * **`/embellish-chat help style`** Displays the styling rules available to you based on your permissions. * **`/embellish-chat help icon`** Displays available icon presets from `presets.json/icon` in `name - icon` format. * **`/embellish-chat notification`** Toggles your personal mention notification preferences. *(Enabled/disabled globally by `notify_command_enabled` in the config).* --- ## ⚙️ Configuration Embellish Chat provides powerful functionality through the use of regular expressions. Because regular expressions are inherently difficult, it is recommended to leverage various AI tools for rule creation and optimization. ### Config The configuration file is located at `config/embellish-chat/config.json`. ``` { //version "version": "current mod version", //setting "delimiter": ",", "timestamp": "yyyy-MM-dd HH:mm:ss", "command_alias": "ec", "url_color": "#0000EE", "team_color": "#FF55FF", "notify_command_enabled": true, "notify_mention_enabled": true, "require_same_channel": true, "disable_vanilla_chat_format": false, //player list "banned_players": [], "notify_off_players": [] } ``` * The `version` field must not be modified manually. * `ConfigManager` writes `config.json`, `styles.json`, `mentions.json`, and `presets.json` separately, then merges them into one runtime `Config` when loading. * Missing sections are restored from the built-in defaults during that merge step. * If the stored `version` does not match the running mod version, the mod keeps the current in-memory configuration and ignores the mismatched load. * The core configuration logic is defined in `style_rules` and `mention_rules`. * Rules are processed from top to bottom, so placing a catch-all rule earlier may override more specific rules defined below. * The `delimiter` value is internally handled as a regular expression; special characters such as `|` must be properly escaped. * `command_alias` registers an additional root command that redirects to `/embellish-chat` when the config is loaded with a non-blank value. * `team_color` is the base color used when styling `@team` and `@Player` mentions. * If `team_color` is missing or set to `null`, those mentions are left without an automatic color. * `require_same_channel` limits `ADVANCED_CHAT_CHANNEL` mentions to the sender's current Advanced Chat channel when enabled. * Reloading the config refreshes the runtime style and mention processors, so updated `style_rules`, `mention_rules`, `timestamp`, `url_color`, `whitelist`, `color`, `icon`, and `item` values take effect immediately. * To avoid JSON syntax errors and ensure valid configurations, using the **[Web Config Generator](https://hanhy06.github.io/embellish-chat-wiki/config-generator/)** is strongly recommended. ### Styling The configuration file is located at `config/embellish-chat/styles.json`. ``` { "style_rules": { "embellish-chat.chat": [ { "pattern": " ... ", "comment": "...", "styles": [ { "styleType": " ... ", "preset": " ... " } ] } ... ] } } ``` * **`pattern`**: This is a regular expression for scanning text. It must have two capture groups. * `group 1`: This is text to be styled. * `group 2`: This is text passed as an option. * **`comment`**: This comment is used in `/embellish-chat help style`. * **`styles`**: Defines the styles to be applied to captured group 1. * `styleType`: This is the style type. You can use all types listed in the [StyleWiki](https://hanhy06.github.io/embellish-chat-wiki/style/StyleType/). * `preset`: This is a preset value. If a value is provided, it is always used; if it is empty, the content of the user's captured group 2 is used instead. * Each top-level key such as `embellish-chat.chat` is also treated as a permission node. * Each `styleType` name must match a handler registered in the runtime `StyleRegistry`. ### Mention The configuration file is located at `config/embellish-chat/mentions.json`. ``` { "mention_rules": { "embellish-chat.mention": [ { "pattern": " ... ", "comment": "...", "title": " ... ", "sound": { ... }, "cooldown": 0, "onlyTarget": false, "mentions": [ { "mentionType": " ... ", "preset": " ... " } ], "styles": [ ... ] } ... ] } } ``` * **`pattern`**: This is a regular expression for scanning text. It must have one capture group. * This is the mention option (e.g. team name, LuckPerms group). * **`comment`**: This comment is used in `/embellish-chat help mention`. * **`title`**: This is the title shown on the mentioned player's screen. * `%player:displayname%` is the display name of the player who sent the mention. * **`sound`**: Defines the notification sound settings. * `id`: Sound identifier. * `category`: Sound category. * `volume`: Sound volume. * `pitch`: Sound pitch. * **`cooldown`**: This is the mention cooldown time in seconds. * Set to `0` to disable the cooldown. * **`onlyTarget`**: * When set to `true`, prevents the message from being broadcast globally and sends it only to the target. * **`mentions`**: Defines the mention actions to be executed. * `mentionType`: This is the mention type. You can use all types listed in the [MentionWiki](https://hanhy06.github.io/embellish-chat-wiki/mention/MentionType/). * `preset`: This is an optional preset value. * **`styles`**: Defines the styles to be applied when the mention is triggered. * Works the same way as in the styling rules section. ### Presets The configuration file is located at `config/embellish-chat/presets.json`. ``` { "prefix": { " ... ": " ... " }, "whitelist": [ " ... " ], "icon": { " ... ": { "atlas": " ... ", "sprite": " ... " } }, "item": { " ... ": { "atlas": " ... ", "sprite": " ... " } }, "color": { " ... ": " ... " } } ``` * **`prefix`**: Uses permission nodes as its keys, and each value is a string parsed as a text component with placeholder tags. * **`whitelist`**: This is used in the `URL` style type. If left empty, all URLs are allowed. * **`icon`**: This is used by `ICON_PRESET` and `/embellish-chat help icon`. * **`item`**: This overrides atlas sprites used by `SHOW_ITEM` for specific item IDs. * **`color`**: This is used in the color presets for styling. --- ## 📜 Compatibility ### ✅ Fully Supported * **Fabric Permissions API (Embedded)** * The keys defined in `style_rules` and `mention_rules` directly function as permission nodes. * Rules are evaluated from top to bottom based on the player's permissions. * **Text Placeholder API (Embedded)** * Supports dynamic placeholders in mention titles and style presets. * **Exclusive:** Use `%embellish-chat:content%` to access the raw, unparsed chat message. * **Styled Nicknames** * Supports mentioning players by nickname. * **LuckPerms** * **Required** for the `@group` mention type. Without it, group mentions will be ignored. * **Advanced Chat** * **Required** for the `@channel` mention type. Without it, channel mentions will be ignored. * **Geyser (Bedrock Edition)** * Mentions between Java and Bedrock editions work seamlessly. * *Note:* Advanced styling (hover text, click events) may not fully render on Bedrock clients. * **Minecraft LAN Play** * Tested in standard LAN worlds. ### ❗ Known Conflicts * **Styled Chat** * **Styled Chat takes priority.** If installed, Embellish Chat's *styling* features will be overridden. * **Mentions still work:** The mention and notification system remains functional. * **Performance Tip:** If you must use both, remove all entries in Embellish Chat's `style_rules` to prevent unnecessary background processing. --- ## 📜 License & Links This project is licensed under the **Apache License 2.0**. Please download the mod from the official sources below to ensure you have the latest, safest version. Linking to these pages is appreciated; please avoid re‑hosting files. * **Official Download (Modrinth):** [https://modrinth.com/mod/embellish-chat](https://modrinth.com/mod/embellish-chat) * **Source Code (GitHub):** [https://github.com/hanhy06/embellish-chat](https://github.com/hanhy06/embellish-chat) --- ## ✨ Feedback & Support Found a bug or have a feature request? Please open an issue or reach out on the project’s Discord server. If you want to receive updates sooner, please press the heart ❤️ on our Modrinth page! Your support means a lot!

hanhy06

server

client

client and server