Installation
Install ExyliaChatCosmetics next to ExyliaLib, start the server and check that /cc opens.
By the end of this page the plugin is running and /cc opens the cosmetics menu. It takes about two minutes.
Before you start#
You need Paper 1.21.4 or newer, Java 21, and ExyliaLib in plugins/. The plugin does not run without ExyliaLib.
| Plugin | Needed for |
|---|---|
| PlaceholderAPI | Showing the tag and name in another plugin's chat format, scoreboard or tab list. Not needed with the built-in chat. |
| LuckPerms | Rank colours (the screen is empty without it), and permission changes applying at once instead of on relog. |
| ExyliaEconomy or Vault | Prices on locked cosmetics. With neither, no price is shown. |
| packetevents | Optional, used by ExyliaLib's packet features. |
Steps#
Drop in the jar
Copy Exylia-ChatCosmetics-Loader.jar into plugins/, next to ExyliaLib.
Start the server
The first start writes the config, the language folder, the catalogue and the chat files, and creates the database. It can take longer than usual: the database drivers are downloaded once, so the server needs internet that first time.
Check the console
Look for the plugin's banner with its version. If it never appears, ExyliaLib is missing.
Open the menu
Run /cc. Every player can use it.
modules.chat is true on a fresh install, so the built-in chat delivers every message and registers /msg, /reply, /ignore and the other chat commands. If another plugin already runs your chat, set modules.chat: false in plugins/ExyliaChatCosmetics/config.yml and run /cca reload. The plugin then only styles messages and leaves your chat plugin in charge.
Check that it works#
Run /cc: a window opens with Your chat, Identity, Message, Favorites, Loadouts, Presets and Your collection. Write a message in chat: with the built-in chat on, it already uses the plugin's format. Then continue with Your first cosmetic.
Share cosmetics across servers#
By default the data lives in a file database (H2) in the plugin folder. To share it, point the servers at the same MySQL, MariaDB, PostgreSQL or MongoDB in plugins/ExyliaChatCosmetics/database.yml. That file is ExyliaLib's, see Database. For chat between servers you also need Redis, see Channels.
Update#
Replace the jar and restart. Everything players own is in the database.
New keys appear in config.yml with their defaults. A key the new version no longer has is removed, and reported once in the console as UNKNOWN_KEY: a typo in a key name is deleted too, so read the console after updating if you edited by hand. Changed defaults of the catalogue, menus and chat files wait in /exylialib updates for you to apply or ignore, your edits are kept.
Reload without restarting#
Run /cca reload (needs exyliachatcosmetics.admin). It re-reads the config and messages, the catalogue, the menus and the chat module, and tries LuckPerms again. A change to a modules switch other than chat waits for a restart. /cca chat reload re-reads only the chat module's files. /exylialib reload reloads the palette, and the plugin follows it.
Files the first start writes
Everything is under plugins/ExyliaChatCosmetics/.
| File | Holds |
|---|---|
config.yml | Language, modules, defaults, tag format, rank colour characters, custom cosmetic rules, loadout limit, expiry, shop. See Configuration. |
database.yml | ExyliaLib's database settings. H2 by default. |
lang/<language>/messages.yml | Every line players read. |
lang/<language>/menus/*.yml | The 22 menus. See Menus. |
lang/<language>/cosmetics/*.yml | The catalogue: tags, nick-colors, chat-colors, shadow-colors, rank-colors, fonts, modifiers, presets, animations. |
chat/config.yml | The chat module's switches. |
chat/filter/ | config.yml, rules.yml, whitelist.yml, leet.yml, punishments.yml. |
chat/text/ | emojis.yml, grammar.yml. |
lang/<language>/chat/ | channels.yml, formats/ (default.yml, msg.yml), messages.yml, announcements.yml, plus the translated copies of filter/punishments.yml and text/emojis.yml. |
language in config.yml picks the folder: default follows ExyliaLib, and en, es, pt, fr, ru and tr ship. With modules.chat: false no chat files are written. Tables: chatcosmetics_profiles, _entitlements, _custom, _loadouts, _tokens, and _chat_players once the chat module runs. Folia is supported with nothing to configure.
Something missing on this page? Tell us on Discord