# Embellish Chat for Fabric [![Download](https://img.shields.io/modrinth/dt/embellish-chat?label=Modrinth&logo=modrinth)](https://modrinth.com/mod/embellish-chat) [![Wiki](https://img.shields.io/badge/wiki-pages-blueviolet?logo=github)](https://hanhy06.github.io/embellish-chat-wiki/) [![Config Generator](https://img.shields.io/badge/config-generator-teal?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9Ii00IC00IDMyIDMyIiB3aWR0aD0iMTYwIiBoZWlnaHQ9IjE2MCIgZmlsbD0ibm9uZSIgY2xhc3M9Im92ZXJmbG93LXZpc2libGUiPgo8ZGVmcz4KPGxpbmVhckdyYWRpZW50IGlkPSJidWJibGVHcmFkIiB4MT0iMCUiIHkxPSIwJSIgeDI9IjEwMCUiIHkyPSIxMDAlIj4KPHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iIzRGNDZFNSIvPgo8c3RvcCBvZmZzZXQ9IjEwMCUiIHN0b3AtY29sb3I9IiM5MzMzRUEiLz4KPC9saW5lYXJHcmFkaWVudD4KPGxpbmVhckdyYWRpZW50IGlkPSJzcGFya2xlR3JhZCIgeDE9IjAlIiB5MT0iMTAwJSIgeDI9IjEwMCUiIHkyPSIwJSI+CjxzdG9wIG9mZnNldD0iMCUiIHN0b3AtY29sb3I9IiNGNTlFMEIiLz4KPHN0b3Agb2Zmc2V0PSIxMDAlIiBzdG9wLWNvbG9yPSIjRjQzRjVFIi8+CjwvbGluZWFyR3JhZGllbnQ+CjxmaWx0ZXIgaWQ9Imdsb3ciIHg9Ii01MCUiIHk9Ii01MCUiIHdpZHRoPSIyMDAlIiBoZWlnaHQ9IjIwMCUiPgo8ZmVEcm9wU2hhZG93IGR4PSIwIiBkeT0iMCIgc3RkRGV2aWF0aW9uPSIyLjUiIGZsb29kLWNvbG9yPSIjRjQzRjVFIiBmbG9vZC1vcGFjaXR5PSIwLjQiLz4KPC9maWx0ZXI+CjwvZGVmcz4KPHBhdGggZD0iTTggOGgxMmEyIDIgMCAwIDEgMiAydjdhMiAyIDAgMCAxLTIgMmgtMS41bC0zLjUgM3YtM0g4YTIgMiAwIDAgMS0yLTJ2LTdhMiAyIDAgMCAxIDItMnoiIHN0cm9rZT0iI0U1RTdFQiIgc3Ryb2tlLXdpZHRoPSIxLjUiIGZpbGw9Im5vbmUiIHN0cm9rZS1saW5lam9pbj0icm91bmQiLz4KPHBhdGggZD0iTTE2IDRINGEyIDIgMCAwIDAtMiAydjhhMiAyIDAgMCAwIDIgMmgxLjV2My41TDkgMTZoN2EyIDIgMCAwIDAgMi0yVjZhMiAyIDAgMCAwLTItMnoiIHN0cm9rZT0idXJsKCNidWJibGVHcmFkKSIgc3Ryb2tlLXdpZHRoPSIyIiBmaWxsPSJub25lIiBzdHJva2UtbGluZWpvaW49InJvdW5kIiBzdHJva2UtbGluZWNhcD0icm91bmQiLz4KPHBhdGggZD0iTTYgOWg3IiBzdHJva2U9InVybCgjYnViYmxlR3JhZCkiIHN0cm9rZS13aWR0aD0iMiIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIi8+CjxwYXRoIGQ9Ik02IDEzaDQiIHN0cm9rZT0idXJsKCNidWJibGVHcmFkKSIgc3Ryb2tlLXdpZHRoPSIyIiBzdHJva2UtbGluZWNhcD0icm91bmQiLz4KPHBhdGggZD0iTTE5IDFsMS41IDMuNUwyNCA2bC0zLjUgMS41TDE5IDExbC0xLjUtMy41TDE0IDZsMy41LTEuNXoiIHN0cm9rZT0idXJsKCNzcGFya2xlR3JhZCkiIHN0cm9rZS13aWR0aD0iMS44IiBmaWxsPSJ1cmwoI3NwYXJrbGVHcmFkKSIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIgZmlsdGVyPSJ1cmwoI2dsb3cpIi8+CjxwYXRoIGQ9Ik00IDFsLjcgMS44TDYuNSAzLjUgNC43IDQuMiA0IDZsLS43LTEuOEwxLjUgMy41bDEuOC0uN3oiIHN0cm9rZT0idXJsKCNzcGFya2xlR3JhZCkiIHN0cm9rZS13aWR0aD0iMS41IiBmaWxsPSJ1cmwoI3NwYXJrbGVHcmFkKSIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIvPgo8cGF0aCBkPSJNMjIgMTNsLjUgMS41IDEuNS41LTEuNS41LS41IDEuNS0uNS0xLjUtMS41LS41IDEuNS0uNXoiIHN0cm9rZT0idXJsKCNzcGFya2xlR3JhZCkiIHN0cm9rZS13aWR0aD0iMS41IiBmaWxsPSJ1cmwoI3NwYXJrbGVHcmFkKSIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIvPgo8L3N2Zz4=)](https://hanhy06.github.io/embellish-chat-wiki/config-generator.html) **⚠ IMPORTANT: If you downloaded 3.4.0, update immediately. Blocks/items may not drop due to a critical bug.** Embellish Chat modernizes your Minecraft server’s chat experience with a fully server-side design. It introduces Markdown-style formatting, interactive message events, and a robust mention system—no client installation required. It also supports integration with LuckPerms, Styled Nickname, and various other mods. --- ## ✨ Key Features * **Rich Text Formatting** * Express yourself with **bold**, *italic*, __underline__, ~~strikethrough~~, ||obfuscation||, and custom fonts. * Supports advanced color options including Hex codes, Gradients, Presets, and Rainbow patterns. * Works consistently across public chat, private messages (DMs), and commands. * **Advanced Mention System** * Ping specific players, teams, `@everyone`, or `@here` with visual and auditory notifications. * Mention text automatically adapts to the target's color (e.g., team color). * Supports detailed targeting like LuckPerms groups (`@group`) and specific worlds (`@world`). * **Instantly show off your gear!** * Type `[i]` to display the item you’re holding, or `[inv]` to display your entire inventory. * Other players can hover over the link to view detailed item tooltips. * **Chat Utilities** * **Metadata:** Hover over any message to see the exact timestamp. * **Quick Copy:** Click on any message to instantly copy its content to your clipboard. --- ## 🛠️ 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) | | Mention | `@PlayerName` | `Hello, @User` | ![Mention](https://hanhy06.github.io/embellish-chat-wiki/assets/images/Mention.png) | > **Notes** > > * **Links:** Only `https://` URLs are supported for security. > * **Colors:** Presets (e.g., `pink`) are defined in the mod configuration. > * **Fonts:** The `path` requires a namespaced ID (e.g., `minecraft:alt`). > * **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` use their respective team colors. If no team color is set, the `defaultTeamColor` from the config is used. > * **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 notification`** Toggles your personal mention notification preferences. *(Enabled/disabled globally by `notificationCommandEnable` 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": "3.4.0", //setting "delimiter": ",", "timestamp": "yyyy-MM-dd HH:mm:ss", "commandAlias": "ec", "urlColor": "#0000EE", "defaultTeamColor": "#FF55FF", "notificationCommandEnable": true, "mentionBroadcast": true, "useClearFormat": false, //player list "bannedPlayerList": [], "notificationOffPlayerList": [], //webhook "webhook": "" } ``` * The `version` field must not be modified manually. * The core configuration logic is defined in `stylingRules` and `mentionRules`. * 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. * If `defaultTeamColor` is missing or set to `null`, automatic coloring will not be applied. * To avoid JSON syntax errors and ensure valid configurations, using the **[Web Config Generator](https://hanhy06.github.io/embellish-chat-wiki/config-generator.html)** is strongly recommended: ### Styling The configuration file is located at `config/embellish-chat/styles.json`. ``` { "stylingRules": { "embellish-chat.chat": [ { "pattern": " ... ", "comment": "...", "styles": [ { "styleType": " ... ", "preset": " ... " } ] } ... ], "embellish-chat.command_argument": [] } } ``` * **`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. ### Mention The configuration file is located at `config/embellish-chat/mentions.json`. ``` { "mentionRules": { "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`. ``` { "colors": { " ... ": " ... ", }, "atlas": { " ... ": { "atlas": " ... ", "sprite": " ... " } }, "whitelist": [ " ... " ], "prefixes": { " ... ": " ... " } } ``` * **`colors`**: This is used in the color presets for styling. * **`atlas`**: This is used in the atlas presets for styling. * **`whitelist`**: This is used in the `URL` style type. If left empty, all URLs are allowed. * **`prefixes`**: stylingRules, like mentionRules, uses permission nodes as its keys. The prefix supports placeholder tags and placeholder functionality. --- ## 📜 Compatibility ### ✅ Fully Supported * **Fabric Permissions API (Embedded)** * The keys defined in `stylingRules` and `mentionRules` directly function as permission nodes. * Rules are evaluated from top to bottom based on the player's permissions. * **Placeholder API** * 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. * **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. * **Chat Heads** * Fully compatible. ### ❗ 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 `stylingRules` 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!