Documentation
ExyliaChatCosmetics
Tags, nick, rank, chat and shadow colours, fonts and modifiers a player wears from a menu, custom tags and colours they mix themselves, grants that expire, loadouts — and a full chat module underneath: channels, formats, a bilingual filter, mentions, emojis, item renders, whispers and an announcer.
- Version
- v1.0.0
- Minecraft
- 1.21+
- Category
- Social
- Pages
- 24
Getting started03
IntroductionWhat ExyliaChatCosmetics is, the two halves it ships as, and how this documentation is organised.InstallationDependencies, the first boot, every file it writes, the database, Folia and the reload.First stepsThe first ten minutes: the menu, what a player already owns, granting a tag, and getting the identity into your chat format.
The catalogue06
The catalogueHow the files under cosmetics/ work: one per type, the fields every entry shares, the colour grammar, and what happens when an entry is wrong.TagsThe mark in front of a name: what a display may draw, the sprite and head forms, which clients draw them, and how a head survives being written down.ColoursNick, chat, shadow and rank colours: four files, four things a colour can paint, and the rules that decide which one wins.Fonts and modifiersLetters swapped for look-alike glyphs, and the five decorations a player switches on.AnimationsThe six ways a colour can move over text, the eighteen shipped, and the one clock behind all of them.Custom cosmeticsThe four things a player makes for themselves, the rules that keep them printable, and what happens when one is edited or deleted.
Wearing them03
MenusThe six menu files, what each one opens from, the actions their buttons run, and the values their templates can read.EntitlementsAvailable, owned and equipped as three separate questions, grants that expire, and why nothing is ever removed because a permission answered no.TokensCreation and edit tokens: the two balances per kind of custom cosmetic, how a rank or a store hands them out, and when they are checked and spent.
Chat module05
The chat moduleWhat turning the built-in chat on means, the files it owns, the pipeline a message walks, and how the line is delivered.Channelschannels.yml: the three kinds of channel, who may talk and read, prefixes, per-channel formats, and what travels between servers.FormatsOne file per format under chat/formats/: components, hovers, clicks, the token list, and how a format is chosen.The filterchat/filter/: the generated switches, the word rules and how they are compiled, the whitelist, and how points turn into punishments.Chat featuresEverything in chat/config.yml that is not the filter: mentions, emojis, renders, whispers, moderation, the announcer and the module's own messages.
Reference07
CommandsEvery command the plugin registers: the player command, the four shortcuts, the admin command and the chat module's own.PermissionsEvery node, the two kinds they come in, and why the ownership nodes are deliberately left undeclared.PlaceholdersThe identifier, the three notations, every name it answers to, and what happens to a head on the way out.ConfigurationEvery key of config.yml with its default, and what lives in messages.yml instead.IntegrationsChat plugins, LuckPerms, PlaceholderAPI, Redis, the cosmetics gate, Folia and what each reload re-reads.APITwo services: reading and driving the cosmetics, and the chat this plugin runs when you let it.Frequently asked questionsThe questions that come up most.