Embellish Chat for Fabric

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.

---

✨ 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!**
Italic	_Text_	_This is top secret..._
Underline	__Text__	__Check this out__
Strikethrough	~~Text~~	~~We don’t talk about this anymore~~
Obfuscated	||Text||	||Unreadable text||
Color (Hex)	[Text]<#RRGGBB>	[Blue]<#0000FF> like the deep ocean
Color (Gradient)	[Text]<#RRGGBB #R...>	[Grraaaaaaadieeeeent]<#ffaaaa #aaaaff #aaffaa>
Color (Preset)	[Text]<preset>	[pink]<pink> pig
Color (Rainbow)	[Text]<RAINBOW>	look at this [rainbow]<RAINBOW>
Link	[Text](URL)	Download it [here](https://modrinth.com/mod/embellish-chat)
Font	[Text]{path}	[Blorp Zorp]{minecraft:alt}
Item	[i]	Look at my [i]
Inventory	[inv]	Look at my [inv]
Ender Chest	[end]	Look at my [end]
Mention	@PlayerName	Hello, @User

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.

---

🗣️ 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.

---

⌨️ 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 <player> Blocks or restores a player's access to all mod features.
• /embellish-chat stress_test <time> <count> <text> Repeatedly simulates <count> messages for <time> to stress-test the server's message-processing performance.

User Commands

Available to all players (no permission required).

• /embellish-chat open <player> 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.1.1",
  
  //preset
  "colorPreset": { ... },
  "atlasPreset": { ... },
  
  //setting
  "delimiter": ",",
  "timestamp": "yyyy-MM-dd HH:mm:ss",
  "commandAlias": ""
  "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 is strongly recommended:

Styling

The configuration file is located at config/embellish-chat/styles.json.

{
  "stylingRules": {
    "embellish-chat.chat": [
      {
        "pattern": " ... ",
        "styles": [
          {
            "styleType": " ... ",
            "preset": " ... "
          }
        ],
        "comment": "..."
      }
      ...
    ],
    "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.
• 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.
  • 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.
• comment: This comment is used in /embellish-chat help style.

Mention

The configuration file is located at config/embellish-chat/mentions.json.

{
  "mentionRules": {
    "embellish-chat.mention": [
      {
        "pattern": " ... ",
        "title": " ... ",
        "cooldown": 0,
        "onlyTarget": false,
        "sound": { ... },
        "mentions": [
          {
            "mentionType": " ... ",
            "preset": " ... "
          }
        ],
        "styles": [ ... ],
        "comment": "..."
      }
      ...
    ]
  }
}

• 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).
• 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.
• 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.
• sound: Defines the notification sound settings.
  • id: Sound identifier.
  • category: Sound category.
  • volume: Sound volume.
  • pitch: Sound pitch.
• mentions: Defines the mention actions to be executed.
  • mentionType: This is the mention type. You can use all types listed in the MentionWiki.
  • 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.
• comment: This comment is used in /embellish-chat help mention.

---

📜 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.
• 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
• Source Code (GitHub): 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!