Colours
Add and edit nick, chat, shadow and rank colours, and see which one wins when a player wears several.
Four cosmetic types are colours. They differ only in what they paint, and you get 353 ready to wear: 90 nick, 96 chat, 90 shadow and 77 rank colours.
| Type | File | Paints | Menu |
|---|---|---|---|
nick_color | nick-colors.yml | the player's name | /cc nick |
chat_color | chat-colors.yml | the message they typed | /cc colors |
shadow_color | shadow-colors.yml | what is drawn under the message | /cc shadows |
rank_color | rank-colors.yml | the prefix and suffix their rank writes | /cc rank |
Before you start#
- Rank colours need LuckPerms. Without it that type has nothing to repaint.
- Colours use the shared colour grammar: hex, names,
{primary}palette tokens and gradients.
Add a colour#
Open the file
Edit the file from the table above in the plugin's cosmetics/ folder, for example nick-colors.yml.
Write the entry
Copy the example, give it a new id, and use color: for one colour or gradient: for a list.
Reload and test
Run /cca reload, then /cca give <player> nick_color:nebula and open /cc nick.
nick_colors:
nebula:
category: premium
name: '{primary}&lNEBULA'
gradient: ['#8a51c4', '#ff6b9d', '#59a4ff']
animation: shine
icon: ENDER_EYE
description: 'Three colours, and none of them sit still.'
priority: 1Write color: or gradient:, never neither: an entry with nothing to paint is reported and skipped. animation: is optional and names an id from Animations. A palette token works as any stop, so gradient: ['{primary}', '{secondary_light}'] follows your server's colours.
By default a player needs exyliachatcosmetics.<type>.item.<id> or the category node to own a colour, or you give it with /cca give. See Entitlements.
Check that it works#
- Open the menu from the table and find your colour in its tab.
- Equip it and write in chat: the name, message, shadow or prefix changes.
- The console lists any entry it skipped, with the file and key.
Make rank colours for your groups#
The STAFF tab of rank colours names guesses at your groups: owner, admin, dev, mod, helper, builder, media, veteran. If your LuckPerms groups are called something else, that tab is empty for everybody.
Rename the groups
In rank-colors.yml, change each groups: list in the STAFF entries to your real LuckPerms group names.
Reload
Run /cca reload, then open /cc rank as a member of one of those groups.
An entry with groups: is owned by being in one of those groups (case does not matter) and needs no permission node. An entry with no groups is owned by its permission node, like every other type. Only permission: false with no groups makes it free to every rank.
rank_colors:
owner:
category: staff
name: '{primary}&lOWNER'
gradient: ['#ffd700', '#ff8c00']
animation: shine
groups: [owner]
icon: NETHER_STAR
priority: 1Which colour wins#
Players can also mix colours of their own, see Custom cosmetics. Where two could apply, the one they mixed wins.
| What is painted | First one that applies |
|---|---|
| the name | customnick, then nick_color |
| the prefix and suffix | customrank, then rank_color, then the rank as written |
| the message | customcolor, then chat_color, then defaults.chat-color |
| under the message | the worn shadow_color, else the server's own shadow |
A rank colour never touches the name, and a nick colour never touches the prefix. defaults.chat-color is an id from chat-colors.yml and ships empty, so a player with no chat colour keeps the colour the format gave. See Configuration.
Keep brackets in their own colour#
rank-colors.keep in config.yml lists the characters a rank colour never repaints. It ships as []()<>{}|.
rank-colors.keep | &8[&eVIP&8] painted #55ffff |
|---|---|
| default | &8[&bVIP&8], the grey brackets stay grey |
| empty | &b[VIP], brackets included |
Gradients and animations run only over the characters that get painted.
Tabs and counts
| Type | Tabs |
|---|---|
| Nick, 90 | RED, BLUE, YELLOW, GREEN (15 each), ADVANCED 15 gradients, PREMIUM 15 moving gradients |
| Chat, 96 | RED, BLUE, YELLOW, GREEN (16 each), ADVANCED 16, PREMIUM 16 |
| Shadow, 90 | NATURAL 15, RED, BLUE, YELLOW, GREEN (15 each), PREMIUM 15 |
| Rank, 77 | SOLID 15, METAL 12, GEMS 15, GRADIENT 15, ANIMATED 12, STAFF 8 |
A name is four to sixteen letters, so a nick gradient reads best with two or three stops. Nick and chat colours share ids, so wearing CRIMSON on both gives the same red.
Shadow colours
The shadow is the darker copy of the text the client draws under every line. A shadow colour replaces it for that player's messages. There is no gradient: here.
color | Means |
|---|---|
#rrggbb | one colour under the whole line |
#rrggbbaa | the same, the last two digits being the strength |
| a palette token | that colour, opaque |
auto | the message's own colour, darkened |
auto:0.5 | the same, with the amount from 0 to 1 |
none | no shadow at all |
Nothing ships as none, but it works if you write one. Shadow colours are drawn by 1.21.4 clients and newer; older ones see the message as before.
Entry keys
| Key | Means |
|---|---|
color | one colour: #hex, a name or a palette token |
gradient | a list of colours, instead of color |
animation | optional id from animations.yml |
groups | rank colours only: LuckPerms groups that may wear it |
category, name, icon, description, priority, permission, requirement, hidden, metadata | the shared fields, see the catalogue |
Something missing on this page? Tell us on Discord