Embellish Chat for Fabric

Embellish Chat is a Fabric mod that enhances the chat experience on Minecraft servers. It makes player communication more expressive and convenient with discord like Markdown-style formatting, mentions, clickable links, and mention notifications.

✨ Key Features

Markdown‑Style Formatting: Bold, italic, underline, strikethrough, obfuscation, color, custom font, and links. Works in public chat, private messages, and commands.
Mention System: Mention individual players, your team, everyone, or nearby players with @. Online targets receive a notification; mentions auto‑tint to the player/team color.
Message Metadata: Hover to see the send time, and click a message to copy it to the clipboard.

🛠️ Markdown Usage

Use the following patterns directly in the chat window:

Feature	Syntax	Example
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}`
Mention	`@PlayerName`	`Hello, @User`

Notes

For security, the Link feature only recognizes URLs using the https:// protocol.

Preset values depend on the mod's configuration (e.g., pink, blue, etc.).

path for Font accepts a namespaced ID such as minecraft:alt.

If multiple style types exist and no preset is configured, the user can enter one manually. The separator can be checked through /ec help style.

The table above shows only the most common styles. Embellish Chat supports many additional style types. For more details, please refer to StyleWiki.md

🗣️ Mention System

Target	Behavior
`@Player`	Mentions a specific player. If the player is online, the mention adopts the player’s display name style. If the player is offline or does not exist, it still follows the player's team style if available.
`@team(name)`	Mentions all players in the specified team.
`@group(name)`	Mentions all players in the specified LuckPerms group.
`@everyone`	Mentions all players on the server.
`@here`	Mentions all players within a configurable radius in the same world as the sender. The default radius is 64 blocks, adjustable in the configuration.
`@world(name)`	Mentions all players in the specified world.

Notes

Online mention targets receive a notification, and the message is automatically styled using the appropriate formatting rules.

The mention notification sound uses the UI sound category by default. On Minecraft 1.21.5 and earlier, it falls back to the PLAYER category.

@group(name) requires LuckPerms. Without it, the mention resolves to no players.

@team and @Player mentions follow the color of their respective team. If the team has no color, the defaultTeamColor value is used.

Other mention types can have their color customized by modifying the styleRule value.

⌨️ Commands

/embellish-chat reload — Reloads the configuration from config/embellish-chat.json.
/embellish-chat ban <player> — Prevents the specified player from using any features provided by the mod.
/embellish-chat pardon <player> — Restores access to all features provided by the mod for the specified player.
/embellish-chat test regex <regex> <test> - Compiles the <regex> pattern and tests it against the <test> string.
/embellish-chat test stress <count> <test> - Sends a simulated message containing <test> exactly <count> times with the permissions of the user who executed the command, and processes it the same way as a real message.
/ec help mention - Displays the currently available mentions, how to use them, the mention targets, and the applicable style types.
/ec help style - Displays the currently available styles, how to use them, the applicable style types, and the required input options.
/ec notification - Allows you to decide whether to receive a notification when you are mentioned.

Notes

All commands in the /embellish-chat family require OP level 2.

Commands in the /ec family do not require any OP level and can be used by all users.

Through notificationCommandEnable, you can configure whether users are allowed to set their notification preferences using /ec notification. If notificationCommandEnable is false, the user’s preference is ignored and notifications are sent for all mentions.

⚙️ Configuration

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

Sample

{
  // version
  "version": "2.5.0",
  
  //rules
  "stylingRules": {
    "embellish-chat.chat": [
      {
        "pattern": "\\[([^\\]]+?)]\\((https://.*?)\\)",
        "styles": [
          {
            "styleType": "URL",
            "preset": ""
          }
        ]
      },
      ...
    ],
    "embellish-chat.command_argument": []
  },
  "mentionRules": {
    "embellish-chat.mention": [
      {
        "pattern": "@here()",
        "sound": "entity.experience_orb.pickup",
        "pitch": 1.75,
        "title": "%player:displayname% mentioned you",
        "cooldown": 0,
        "mentions": [
          {
            "mentionType": "INSIDE",
            "preset": "64"
          }
        ],
        "styles": [
          {
            "styleType": "BOLD",
            "preset": ""
          }
        ]
      },
      ...
    ]
  },
  
  // presets
  "delimiter": ",",
  "timestamp": "yyyy-MM-dd HH:mm:ss",
  "urlColor": "#0000EE",
  "colorPreset": {
    "dark green": "#00AA00",
    ...
  },
  "notificationCommandEnable": true,
  "defaultTeamColor": "#FF55FF",
  
  //player list
  "bannedPlayerList": [],
  "notificationOffPlayerList": []
}

Notes

The delimiter is internally processed using a regular expression. If you want to use a special character like | as a separator, please enter the escaped version of the delimiter.

If the defaultTeamColor value is missing or null, it will not be automatically colored.

You can specify the mention cooldown time (in seconds) through the config. When the cooldown time is set to 0, there are no restrictions.

Styling Configuration

Embellish Chat, powered by regular expressions, provides highly flexible styling for nearly any chat pattern imaginable. Since every message must be scanned, extremely large servers may experience additional overhead. (It is expected to have no significant performance impact on typical general servers.) Furthermore, creating custom rules can be challenging because regular expressions (regex) are inherently complex. We recommend using various AI tools for assistance with rule creation and optimization.

In this mod, the order of mention rules and styling rules is extremely important! Depending on the order, serious bugs may occur, so please be careful. The mod applies mentions and styling strictly from top to bottom in the given order.

Style Rule Structure

This section defines the text styling rules.
Each rule consists of a regular expression (pattern) and a style action list(styles).

{
  "pattern": "\\*\\*(.+?)\\*\\*()",
  "styles": [
    {
      "styleType": "BOLD",
      "preset": ""
    }
  ]
}

pattern Must contain two capturing groups: pattern must contain two capturing groups: 1) the text to apply the style to, 2) an optional captured value that can be passed as an argument.
styles This is a list of style actions. Each action consists of a style type (styleType) and style option preset(preset).

you can see more detail in StyleWiki.md

Mention Configuration

A mention rule is applied only when the message satisfies all targets specified in the rule — effectively using the intersection of all mention targets.

Mention Rule Structure

This section defines the mention rules.
Each rule consists of a regular expression (pattern), mention action list(mentions) and style action list(styles).

{
  "pattern": "@here()",
  "sound": "entity.experience_orb.pickup",
  "pitch": 1.75,
  "title": "%player:displayname% mentioned you",
  "cooldown": 0,
  "mentions": [
    {
      "mentionType": "INSIDE",
      "preset": "64"
    }
  ],
  "styles": [
    {
      "styleType": "BOLD",
      "preset": ""
    }
  ]
}

pattern The pattern must contain one capturing group, which represents the mention option. For example, this could be a team name or a LuckPerms group name.
sound sound is the ID of the sound that the mentioned player hears.
pitch pitch is the pitch of the sound that the mentioned player hears.
title title is the title that appears on the mentioned player’s screen. It supports the Text Placeholder API, and %player:displayname% is the name of the player who was mentioned.
cooldown The cooldown is a mention cooldown, and the unit is seconds.
mentions The mentions field is a list of mention actions. Each action specifies a mentionType and an optional preset.
styles The styles field works the same way as in the styling rules section.

you can see more detail in MentionWiki.md

LuckPerms & Permission

This mod supports the permission features of LuckPerms and the Fabric Permissions API.

The keys in stylingRules and mentionRules represent each permission (such as chat, command, mention, etc.). These keys are default keys, and the system works even if they are not explicitly defined.

The mod checks from top to bottom and applies the rules registered for each permission.

The LUCK_PERMS_GROUP mention type requires LuckPerms. If it’s not installed, these features have no effect.

Text Placeholder API

This mod supports dynamic data through the Text Placeholder API. The Text Placeholder API applies to the mention title, all presets used in rules, and any options that users can configure.

📊 TPS Latency Test

Test Environment

Version: Embellish Chat 2.4.0 (DEV)
CPU: 13th Gen Intel(R) Core(TM) i7-1360P
RAM: 2GB max
System: Windows 11
Minecraft: 1.21.10
World: Single Play / Superflat

These results demonstrate general performance characteristics rather than a strict scientific benchmark, as the testing environment does not fully replicate real server conditions.

The graph below shows the TPS (Ticks Per Second) latency measurements for this mod. Each test message contained approximately 200 or 50 characters, and the system was stressed by sending up to 10,000 (500 × 20) chat messages per second.

Type	Length	Test String
Plain Text	50	`This is a simple plain text message for latency test.`
Plain Text	200	`This is a standard long message designed to test the baseline performance of the chat system. It contains simple alphanumeric characters and basic punctuation only, without any markdown triggers.`
Styling Only	50	`Bold _Italic_ [Red]<red> [Blue]<blue> ~~Strike~~`
Styling Only	200	`Welcome to the server! Please read the [rules]<#FF5555> at spawn. _Need help?_ Ask an admin! There is a secret event starting soon at the arena. Don't miss the [LEGENDARY PRIZES]<RAINBOW>!`
Mention Only	50	`Hello @everyone is anyone @here? calling @PlayerName`
Mention Only	200	`Attention @everyone on the server. We are gathering @here now. If you are in @team(red) or @team(blue), please report to @PlayerOne. @group(admin) and @world(overworld) players should attend too.`
Mixed	50	`Hey @everyone! Look at [this]<red> _cool_ @here.`
Mixed	200	`Attention @everyone! The Boss Raid is starting. @team(Red) please defend the [Core]<#FF0000>. @here gather at the gate! Watch out for the hidden assassin. The prize is [GOD SWORD]<RAINBOW>. Msg @Admin if stuck.`

📜 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!

Embellish Chat

Compatibility

Minecraft: Java Edition

Platforms

Supported environments

Links

Creators

Details