ChatMod

<h1><strong>ChatMod - Advanced Server Messaging & Info</strong></h1>
<p><strong>ChatMod</strong> transforms your server's communication! This powerful server-side Fabric mod provides administrators with robust tools to engage players, deliver announcements, and manage server information efficiently. Enhance server interaction through highly customizable broadcast messages, dynamic MOTD, user-definable info commands, interactive chat replacements, and more.</p>

<details>
<summary>📧 Contact Me & Support Information (Click to expand)</summary>
<br>
<h3>💬 Primary Support Channel (Preferred)</h3>
<p><strong>All general questions, feature requests, and non-urgent bug reports should be posted in the appropriate channels on our <a href="https://discord.gg/48sZCbdHzJ">Discord Server</a>.</strong> We actively monitor the server and will respond as soon as possible. This ensures that the whole community can benefit from the discussion and solutions.</p>

<h3>🆘 Urgent Private Messaging (PM) Policy</h3>
<p>While we prefer all issues to be handled via the Discord server first, you are welcome to PM me directly under <strong>specific urgent circumstances</strong>:</p>
<ul>
    <li><strong>Allowed Reason:</strong> Your server is <strong>crashing</strong> or experiencing <strong>critical, game-breaking errors</strong> directly related to one of my mods/plugins.</li>
    <li><strong>Requirement:</strong> You must be the <strong>owner</strong> of the server.</li>
    <li><strong>Time Zone:</strong> I am operating in the <strong>(CET/CEST) Time Zone</strong>.</li>
    <li><strong>PM Hours:</strong> Please only send private messages between <strong>10:00 AM and 10:00 PM (Brussels Time)</strong>.</li>
</ul>
<p>I will endeavor to answer your PM as soon as I can to be helpful and see what I can do to resolve your urgent issue. However, please understand that immediate responses are not guaranteed, and <strong>private messaging is a professional courtesy, not an entitlement.</strong> Thank you for your understanding and cooperation!</p>
</details>

<hr />

<h2>Features</h2>

<h3>Dynamic Message of the Day (MOTD)</h3>
<ul>
    <li>Greet players with <strong>personalized welcome messages</strong> upon joining.</li>
    <li>Utilize a rich set of <strong>placeholders</strong> (player name, playtime, last login, server stats).</li>
    <li>Fully customizable message content with <strong>Minecraft color codes</strong> (&amp;c), <strong>hex colors</strong> (&amp;#RRGGBB), text formatting, and <strong>interactive elements</strong> (hover/click).</li>
    <li>Enable or disable via <code>chatmod.json</code>.</li>
</ul>

<h3>Scheduled &amp; Ad-Hoc Global Broadcasts</h3>
<ul>
    <li><strong>Multiple Broadcast Types:</strong> Send messages as standard <code>CHAT</code>, <code>ACTION_BAR</code>, prominent <code>TITLE</code> (with subtitle), or dynamic <code>BOSSBAR</code> (with custom color/style).</li>
    <li><strong>Predefined Broadcasts:</strong> Create named templates (e.g., "vote_reminder") in <code>predefined_broadcasts.json</code> for easy reuse.</li>
    <li><strong>Ad-Hoc Broadcasts:</strong> Send one-off global messages directly with <code>/chatmod bcnow &lt;message&gt;</code>.</li>
    <li><strong>Advanced Scheduling:</strong>
        <ul>
            <li><strong>Delayed Single Broadcast:</strong> Send once after a delay (e.g., <code>/chatmod time 10m bc promo_event</code>).</li>
            <li><strong>Repeating Broadcasts:</strong> Schedule broadcasts to repeat over a total duration. (Example: <code>/chatmod time 30m often 5 bc event_promo</code>).</li>
        </ul>
    </li>
    <li><strong>Placeholder Support:</strong> Use <code>%online_players%</code>, <code>%time%</code>, <code>%date%</code>, <code>%countdown%</code>, and more.</li>
</ul>

<h3>Customizable Info Commands (e.g., /rules, /help)</h3>
<ul>
    <li>Create <strong>unlimited custom commands</strong> that display text from dedicated JSON files.</li>
    <li><strong>Rich Content:</strong> Supports multiple pages, full formatting, and <strong>clickable actions</strong> (run command, open URL, etc.).</li>
    <li><strong>Dynamic Management:</strong> Commands are generated automatically. Includes subcommands for aliases and permissions.</li>
</ul>

<h3>Custom Placeholders &amp; Chat Replacements</h3>
<ul>
    <li><strong>Custom Triggers:</strong> Define keywords in <code>placeholders.json</code> (e.g., <code>[spawn]</code>) that transform into formatted text or links.</li>
    <li><strong>Predefined Items:</strong>
        <ul>
            <li><code>[item]</code>: Displays the item in your main hand.</li>
            <li><code>[item:#]</code>: Displays a predefined item from admin-configured slots (1-54).</li>
        </ul>
    </li>
</ul>

<h3>Player Tagging &amp; Mentions</h3>
<ul>
    <li><strong>@PlayerName:</strong> Highlights the name and plays a <strong>ping sound</strong> for the target.</li>
    <li><strong>@everyone:</strong> Notify and ping all online players.</li>
    <li><strong>Dedicated Tag Command:</strong> Use <code>/tag &lt;player&gt; &lt;message&gt;</code> for specific notifications.</li>
</ul>

<hr />

<h2>Commands</h2>
<ul>
    <li><code>/chatmod</code>, <code>/cm</code> - Main help interface</li>
    <li><code>/chatmod reload</code> - Reloads all configurations</li>
    <li><code>/chatmod create &lt;filename&gt;</code> - Creates a new custom info file</li>
    <li><code>/chatmod items</code> - Opens the GUI for managing predefined items</li>
    <li><code>/tag &lt;player&gt; &lt;message&gt;</code> - Sends a tagged message</li>
</ul>

<hr />

<h2>Permissions</h2>
<details>
<summary>Click to view all permission nodes</summary>
<ul>
    <li><code>chatmod.modinfo</code>: Access to base /chatmod help.</li>
    <li><code>chatmod.reload</code>: Access to /chatmod reload.</li>
    <li><code>chatmod.create</code>: Access to /chatmod create.</li>
    <li><code>chatmod.tag.command</code>: Access to the /tag command.</li>
    <li><code>chatmod.items.edit</code>: Edit access to /chatmod items GUI.</li>
    <li><code>chatmod.chatitem</code>: Use [item] placeholder.</li>
    <li><code>chatmod.player.tag.everyone</code>: Tag everyone with @everyone.</li>
    <li><code>chatmod.chat.colors</code>: Use color codes in chat.</li>
</ul>
</details>

<hr />

<h2>Modpack Policy</h2>
<ul>
    <li>You <strong>ARE PERMITTED</strong> to include ChatMod in any modpack.</li>
    <li>The modpack itself <strong>must not be sold</strong>.</li>
    <li>Please do not modify the mod's JAR file directly.</li>
</ul>

ChatMod — Advanced Server Messaging & Chat

Chat Mod Sprites Texture Pack

ChatMod is a server-side Fabric mod that gives administrators complete control over how the server communicates with players. Custom info commands, automated broadcasts, a rich MOTD, interactive chat with hover and click events, inline atlas sprite icons, player tagging with sound, persistent chat colours, predefined items, scheduled broadcasts — all configurable from YAML files with no restart required.

⚠️ Version Note — Atlas Sprite Icons

Atlas sprite icon features ([#SpriteName], [#item], [##item], custom placeholder icons, player head sprites) require Minecraft 1.21.9 or newer. Versions targeting 1.21.5 through 1.21.8 do not include these features. All other features are available on all supported versions.

Formatting — Used Everywhere

Every message in ChatMod — broadcasts, MOTD, info files, chat — supports the same rich formatting syntax.

📢 Broadcasts

Set up automated cycling messages in chatmod.yml. Every broadcast entry supports four display types.

Action Bar

• Single line stays visible for duration_seconds (re-sent automatically, vanilla clears it after ~3 s without this).
• Add a second line to show subtitle text in the title area alongside the action bar.
• Add more lines to cycle through them in sequence, each held for duration_seconds.

Title Supports up to 4 lines per set:

1. Main title
2. Subtitle
3. Action bar text (optional)
4. Replaces the subtitle while line 3 is active (optional)

Add lines1:, lines2: … to cycle through multiple title screens within one broadcast entry, each displayed for duration_seconds.

Boss Bar Multiple lines are displayed one after another as separate boss bars, each held for duration_seconds.

Broadcast controls

broadcast_enabled: true
broadcast_interval_seconds: 300
randomize_broadcast: false   # true = random order instead of sequential

Per-player-count intervals — automatically adjust the broadcast interval based on online players:

players_5_interval_seconds: 240
players_10_interval_seconds: 180
players_25_interval_seconds: 120

🌅 MOTD

Greet players with a personalized message when they join. Supports all formatting, placeholders, hover and click events, and atlas sprite tokens.

motd_enabled: true
motd_messages:
  - lines:
      - "&+&bWelcome, %player%!"
      - "&7Playtime: &e%playtime%  &7Last seen: &e%last_play_time%"

Use /cm testmotd to preview without rejoining.

📄 Custom Info Commands

Create unlimited custom text commands from YAML files — /rules, /help, /discord, /info, or any name you choose. ChatMod registers them as real server commands and supports multiple pages and named sections per file.

Create a new one:

/cm create rules

This generates config/chatmod_info/rules.yml which you edit freely, then /cm reload.

Managing your info commands:

Pages can link to each other using click actions, making full multi-section help menus easy to build.

📡 Predefined & Scheduled Broadcasts

Define reusable named broadcasts in predefined_broadcasts.yml and send or schedule them from commands.

/cm bc event_soon             — send immediately to all players
/cm bcshow event_soon         — preview it yourself first
/cm bclist                    — see all available broadcasts
/cm time 20m often 5 bc event_soon   — send 5 times spread over 20 minutes
/cm time 30m bcnow CHAT Hello everyone!  — send ad-hoc text after 30 minutes

Each predefined broadcast supports all four display types (CHAT, ACTION_BAR, TITLE, BOSSBAR), permission gating, and full formatting.

For ad-hoc one-off messages without a predefined entry:

/cm bcnow CHAT &aServer event starting now!
/cm bcnow TITLE &6Event! | &eGet to spawn!
/cm bcnow <player> CHAT &eYou have been selected!

🎨 Atlas Sprite Icons (1.21.9+ only)

Render any Minecraft texture atlas sprite inline in any message — chat, MOTD, broadcasts, info files.

Sprite aliases and vanilla texture overrides are configured in sprites.yml. You can remap any token to a custom atlas path — for example, make [#chest] show a christmas chest texture.

Sprites work in every context: chat messages, MOTD, broadcasts, info files, hover tooltips, and as persistent chat colour prefixes.

👤 Player Identity Tokens

Reference any online player as an interactive inline element anywhere ChatMod formatting is supported.

Hover profiles in placeholders.yml let you define different tooltips per permission group. Admins can see UUID, ping, world and balance; regular players see rank and balance. Profiles are selected based on the named player's permissions and support full ChatMod formatting including sprites.

🏷️ Player Tagging & Mentions

Type @PlayerName or PlayerName@ in chat to tag someone. They hear a distinct ping sound and see their name highlighted. Use @everyone or everyone@ to notify the whole server (different sound, separate permission).

Tag formats are configured in placeholders.yml under player_tag_format and everyone_tag_format.

💬 Chat Features

Colour & formatting control — Two separate permissions:

• chatmod.chat.color — allows &0–&f and &#RRGGBB hex in chat
• chatmod.chat.format — allows &l, &o, &n, &m, &k, &r in chat

Grant both, one, or neither independently.

Persistent chat colour — Players set a permanent colour for all their chat messages:

/cm chatcolor aqua
/cm chatcolor #FF5500
/cm chatcolor b           ← legacy code shorthand

Admins can set it for other players too with the chatmod.chatcolor.others permission.

Sprite prefixes — Set an atlas sprite as your chat colour prefix (1.21.9+):

/cm chatcolor [#dirt]
/cm chatcolor [#diamond]
/cm chatcolor player      ← uses your own player head

Inline item display — Players can show their held item in chat using [item], [#item] (with icon), or [##item] (icon only). Each has its own permission node.

Inline sprite icons — Type [#SpriteName] anywhere in chat to embed a sprite icon. Gated by chatmod.chaticon.

Custom placeholders — Typed shortcuts in chat that expand to formatted, interactive text with hover and click events. Defined in placeholders.yml.

📦 Predefined Items & GUI

Store up to 54 items per page (unlimited pages) as shared references, displayed in chat via [item:N], [#item:N], or [##item:N].

Manage items through a visual chest GUI:

/cm items       ← opens page 1
/cm items 2     ← opens page 2

Items are stored with full NBT data so custom names, lore, enchantments, and all other properties are preserved exactly.

🔧 Custom Placeholders

Define your own typed shortcuts in placeholders.yml that players type in chat and ChatMod expands into formatted, interactive output.

custom_placeholders:
  spawn:
    typed: '[spawn]'
    chatmod: '&bSpawn&r'
    hover: '&bClick to teleport to spawn.'
    icon: grass_block
    runcommand: /spawn

Each placeholder supports a display text, hover tooltip, click action (run command / suggest command / open URL), and an optional sprite icon. A permission node can be required to use it.

⚙️ Configuration

All configuration is in YAML files under config/chatmod/. No restart needed — use /cm reload after any edit.

PlaceholderAPI placeholders (e.g. %luckperms:prefix%) are resolved in all contexts when PlaceholderAPI is installed. ChatMod skips the API call when a message contains none, so there is no performance overhead for plain messages.

Commands

Permissions

Modpack Policy

• ✅ You may include ChatMod in any modpack.
• ❌ The modpack must not be sold.