Connect other plugins
Use ExyliaChatCosmetics with another chat plugin, LuckPerms, PlaceholderAPI, Redis and Folia, and know what each reload re-reads.
ExyliaChatCosmetics sits next to what you already run: it never cancels a chat event and never owns your chat format unless you turn its own chat on.
Use it with another chat plugin#
Turn the built-in chat off
In config.yml set modules.chat: false, then run /cca reload.
Put the identity in your format
In your chat plugin's format, write %exyliachatcosmetics_tag%%exyliachatcosmetics_nick% where the tag and the name go. PlaceholderAPI must be installed. If your plugin reads another notation, use %exyliachatcosmetics_tag_legacy% with %exyliachatcosmetics_nick_legacy%, or the _section pair.
Pick the hook
In config.yml, chat.hook styles the message body (colour, shadow, font, decorations). Use the row that matches the plugin that renders your chat:
| Your chat plugin | chat.hook | Why |
|---|---|---|
Paper's own chat, or a plugin using AsyncChatEvent and a ChatRenderer | decorate (default) | the decorated message is what they render |
| Spigot without Paper events | any | decorate and chat_event fall back to legacy_event, with a warning at startup |
A plugin that reads AsyncChatEvent.message() but ignores decoration | chat_event, with chat.priority: LOW | the rewrite lands before that plugin reads it |
A plugin on the old AsyncPlayerChatEvent | legacy_event, with a priority below it | the string already carries § colours |
| You compose the line yourself | off | nothing is styled twice |
The hook only runs with modules.chat: false; with the built-in chat on, the module styles and delivers the line. Both event hooks skip a cancelled event.
Check that it works#
Equip a tag and a chat colour with /cc, then write in chat. The tag and name show in the format you wrote, and the message has its colour. Nothing styled at all means the hook does not match the plugin that renders chat: try the next row.
Going further#
Let players type colours#
With chat.sanitize: true (default) a player's own &c, <red> or {primary} is shown as text instead of obeyed. Give exyliachatcosmetics.chat.format to the people you trust with it. § is neutralised regardless.
LuckPerms#
Optional. Rank colours need it: the prefix and suffix they repaint are LuckPerms meta and an entry's groups list decides who may wear it. Without it {prefix} and {suffix} draw nothing and the rank-colour screen is empty; the other cosmetics are unaffected. With it, a rank change takes cosmetics on or off within the tick, no relog. Without it, ownership refreshes on join, on reload and on the 30-second sweep.
PlaceholderAPI#
Optional. Every placeholder is bridged automatically as %exyliachatcosmetics_<name>%, with nothing to download. Inside any ExyliaLib text the same names work without it. The list is in Placeholders.
Several servers with Redis#
Storage is the database. With Redis enabled in ExyliaLib's database.yml, a change made while a player is on another server (an admin grant, a purchase) makes their server re-read the profile. Without Redis nothing changes. See Database.
Staff mode and vanish#
When another Exylia plugin says a player's cosmetics should not show (staff mode, vanish), their tag is empty, their name plain and their message untouched. You register nothing.
Folia#
Supported (folia-supported: true). The Player methods of the API change what somebody wears and must be called on that player's thread.
What each reload re-reads
/cca reload runs five steps; a step that fails is reported while the rest still run.
| Step | Re-read |
|---|---|
| configs | config.yml and lang/<language>/messages.yml |
| catalogs | every cosmetic file and animations.yml |
| menus | the menu files |
| chat | the chat module is started, reloaded or stopped, and the chat hook reinstalled to match |
| hooks | the LuckPerms subscription |
/exylialib reload (the palette) drops the render cache and re-reads the menus, so recolouring tags, names and menu rows needs nothing here. /cca chat reload re-reads only the chat module's files.
Soft dependencies: ExyliaLib, PlaceholderAPI, LuckPerms, ExyliaEconomy, Vault, packetevents. Any change to a message body marks it as modified for vanilla clients, so players with Only Show Secure Chat on do not see it; servers that care set enforce-secure-profile=false.
Something missing on this page? Tell us on Discord