Content generated with AI — it may contain mistakes.

ExyliaChatCosmetics/Chat moduleUpdated in v1.3.0

Chat features

Turn on mentions, emojis, [item] shows, private messages, chat moderation and a rotating announcer, and change how each one behaves.

Page 17 of 305 min read

The built-in chat comes with mentions, emojis, item and inventory shows, private messages, moderation commands and an announcer. Most work with no setup; this page shows how to change the ones people ask about.

Before you start#

The built-in chat must be on, see The chat module. Switches and triggers are in plugins/ExyliaChatCosmetics/chat/config.yml; run /cca chat reload after editing. You can also flip them in game: run /cca menu, click Settings, then Chat commands or Chat features.

Add an emoji#

Open the emoji file

Edit plugins/ExyliaChatCosmetics/lang/<language>/chat/text/emojis.yml, for example lang/en/chat/text/emojis.yml.

Add a line

Under emojis: write '*star*': '{highlight}★'. The left side is what players type, the right is what they see. Colours work, see Colours.

Reload

Run /cca chat reload.

To make an emoji need a permission, put it under gated: with a trigger, a replacement and a permission (it defaults to exyliachatcosmetics.chat.emoji.<name>). A replacement can carry its own hover and click.

Check that it works#

Type the trigger in chat. You should see the symbol instead. For [item], hold something and type [item] in a message: it becomes the item's name, and a click opens a read-only copy of it.

Show an item, inventory or ender chest#

Players typeShowsPermission (default)
[item], [i] or [hand]What they holdexyliachatcosmetics.chat.render.item (everyone)
[inv] or [inventory]Their inventoryexyliachatcosmetics.chat.render.inv (everyone)
[ec] or [enderchest]Their ender chestexyliachatcosmetics.chat.render.ec (everyone)

Clicking opens a read-only copy, taken when the message was written. It expires after 60 seconds (renders.cache-seconds). An empty hand shows nothing and tells the sender why. Change the triggers or turn one off under renders in chat/config.yml.

Mentions#

A player who is named in a message gets a note block sound, and the name is highlighted. Writing the @ is optional. Only players who can read the message can be mentioned, and at most 3 per message (mentions.max). The same player is not nudged twice in 5 seconds. To change the sound, edit mentions.feedback in chat/config.yml: it is an ExyliaLib effect, so it can also hold a title or an action bar. Senders need exyliachatcosmetics.chat.mentions (everyone by default).

Private messages and ignore#

Players use /msg <player> <message>, /reply, /ignore <player> and /ignoreall. A message to someone who closed their inbox or ignores the sender says so instead of pretending to deliver. Staff with exyliachatcosmetics.chat.staff cannot be ignored. /spymsg (op by default) lets staff read everybody's whispers. How a whisper looks is in formats/msg.yml, see Formats.

Moderate the chat#

CommandWhat it doesNot affected
/mutechatMutes or unmutes public chatexyliachatcosmetics.chat.bypass.mute
/clearchatPushes 100 blank lines onto every screenexyliachatcosmetics.chat.bypass.clearchat
/broadcast <message> (/bc)Sends a server line to everybody

They are for staff (op by default) and name who did it. The mute is kept in memory only, so a restart unmutes. In game, /cca menu has Mute the chat, Unmute the chat and Clear the chat buttons.

Set up announcements#

Open the file

Edit lang/<language>/chat/announcements.yml.

Switch it on

Set enabled: true. It ships off. interval-seconds (300 by default, minimum 5) is the wait between two announcements.

Write your lines

Add an entry under announcements: with lines, and optionally hover, click, sound and permission. The shipped discord and cosmetics entries are examples to copy.

Reload and test

Run /cca chat reload, then /cca chat announce <id> to send one now, or /cca chat announce next to send the next one due.

random: true picks any announcement, false goes down the list. A click starts with RUN_COMMAND:, SUGGEST_COMMAND:, OPEN_URL: or COPY:. A replacements piece lets one word in a line carry its own hover and click: write {name} in the line.

Staff can also edit the rotation in game: run /cca menu, then click Announcer.

chat/config.yml keys
SectionKeys
listener-priorityWhere the module takes the chat event: LOWEST to HIGHEST. Default HIGHEST
commandsOne true/false per command: msg, reply, ignore, ignoreall, spymsg, mutechat, clearchat, broadcast, channel. A command that is off is not registered, so another plugin may claim it
msgsound, an ExyliaLib effect played for whoever receives a whisper
grammar, emojis, linksenabled
command-replacerenabled, format (%command%). Turns a typed /command into a clickable suggestion
mentionsenabled, format (%player%), max, cooldown-seconds, feedback
renderscache-seconds, then item, inventory, enderchest each with enabled and triggers
cross-serverenabled
console-format{channel}, {name}, {message}. Default [{channel}] {name}: {message}
filtered-markerPut before a blocked message that staff may still read. Default {error}✖

grammar.yml (chat/text/grammar.yml) maps wrong words to right ones: rules: { dont: "don't" }, whole words, any case. Links are clickable only for exyliachatcosmetics.chat.links holders (op by default); everyone else's links went through the filter's url check first. How renders are drawn, the command hover, the spy line and every other line the module sends is in lang/<language>/chat/messages.yml, which has its own prefix on purpose.

The announcer's other keys: announcements.<id>.hover (shown over every line), .sound, .permission (only holders read it), and replacements.<name> with text, hover, click. A line with no %placeholder% is built once and sent to everyone.

Something missing on this page? Tell us on Discord