Content generated with AI — it may contain mistakes.

ExyliaArmorSkin/Getting startedUpdated in v1.4.1

Introduction

What ExyliaArmorSkin is: a colour and a trim drawn over any armour piece with packets, while the real item keeps everything it had.

Page 1 of 215 min read

ExyliaArmorSkin puts a skin on a piece of armour: a colour, an optional trim and an optional animation, drawn on the way to the client. The netherite chestplate stays a netherite chestplate on the server, and everyone sees blue leather with a vex trim. Enchantments, attributes, durability and other plugins' data are never touched.

What you need#

A Paper 1.21.1+ (or Folia 1.21.4+) server on Java 21 with ExyliaLib and packetevents. Details in Installation.

What you will have in 10 minutes#

  1. The plugin installed and running (Installation).
  2. Yourself wearing a skin from the wardrobe and another from an item (Your first skin).
  3. A skin of your own in skins.yml, animated if you like (Create and edit skins).
  4. Optionally, a crate players win skins from (Set up the crate).

Forty skins ship, every one animated and with a set bonus, so players have something to wear before you write anything.

Two ways a skin gets worn#

WayWhose it isWhich server it suits
A skin itemThe armour's: one value is written onto the piece and travels with it through chests, trades and deaths.Survival, economy
The wardrobeThe player's: stored per player and per slot in a table, and it lands on whatever they equip.Practice, PvP

behaviour.mode decides which is read — item, wardrobe or both — and is covered in The wardrobe.

A skin item is used by dragging: drop it onto a piece of armour in your own inventory and it is applied; drop a remover onto skinned armour and the skin comes off and is handed back as the item again. The wardrobe is /wardrobe: one screen, click a slot, click a skin — or, with menu.style: SPATIAL, a 3D wardrobe in the world where players try skins on their own body and buy and save in place. The crate can open in the world too.

The armour is never rewritten

An applied skin item writes a single value onto the piece; a wardrobe choice writes nothing at all. Everything else is packets, so what any other plugin reads from that armour is exactly what it had.

What ships#

Forty skins in skins.yml and forty-one animations in animations.yml, built from seven animation types: rainbow, pulse, frames, wave, sweep, bloom and flicker. Each skin carries a set bonus: particles around the body, a line when the set closes and another when it breaks, once every piece it fits is worn with it.

Each skin owns a permission derived from its id, exyliaarmorskin.skin.<id>, with a node per slot underneath it (exyliaarmorskin.skin.<id>.helmet). A player owns a skin through that node or through an unlock: won from the crate, bought in the wardrobe with currency, or handed over by an admin, and kept for good whatever happens to their rank. A wearer who owns the skin neither way is shown their real armour.

Lobbies can show skins off with a showcase: a mannequin that turns on the spot in one skin after another, wearing the skin of a player watching. Every menu and message ships in English, Spanish, Portuguese, French, Russian and Turkish.

What the client is shown#

What the client is shown
On the real itemOn the visual
Netherite chestplateThe leather piece of the same slot, in the skin's colour
Its trim, or noneThe skin's trim, when the skin sets one
Its display nameThe same name, or the vanilla name of the real material
Its loreThe same lore, then a blank line, then the armor-lore lines
Its enchantmentsHidden, but the glint is kept
Its durabilityThe real damage and the real maximum, so the bar reads true
Its attributesHidden, and never replaced by leather's

Who sees a skin#

Who sees a skin
ViewerSees
Everyone tracking the wearerThe skin, on the body
The wearer, in their own inventory and paper dollThe skin
The wearer in creativeThe real armour — a creative client echoes its slots back to the server, so it must be shown the truth
Anyone looking at a skinned piece in a chest, hotbar or on the cursorThe real item with the skin's lore lines added
Everyone, when the wearer owns that skin neither by permission nor by unlockThe real armour — the id stays on the item, or the row stays in the wardrobe, and the look returns with the node
Anyone looking at an elytraThe elytra. It sits in the chest slot but is not armour, and dressing it as a chestplate would cost the wearer their flight

Something missing on this page? Tell us on Discord