> For the complete documentation index, see [llms.txt](https://edseries-plugins.gitbook.io/p/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edseries-plugins.gitbook.io/p/edcosmetics/getting-started/readme.md).

# Overview

All-in-one cosmetics for Paper 1.21.8+, with no client mods. Every part is a module you can switch off, and every text, menu and HUD label is in a config file.

## What's inside

| Module            | What it adds                                                                                                                                                                                                              |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **cosmetics**     | Name / chat / rank colours (plain, gradients, rainbows, animated text effects), tags, glows, sizes, hats, wings, join / leave messages, `/cosmetics` chest menus, vouchers, limited editions, PlaceholderAPI placeholders |
| **skin-effects**  | Animated skins everyone sees: enchanted, rainbow, void, hologram, galaxy, inferno, frost... and any two combined                                                                                                          |
| **emotes**        | 13 emotes played on a 3D model of the player, as a chest menu or an emote wheel HUD (Shift+F)                                                                                                                             |
| **wardrobe**      | `/cosmetics` as a full-screen HUD: categories, the player's own 3D model wearing what they try on, their cosmetics                                                                                                        |
| **resource-pack** | Puts the plugin's pack into ItemsAdder, Nexo or Oraxen automatically, or gives you a zip                                                                                                                                  |

Every module works with plain chest menus out of the box. The HUDs (emote wheel and wardrobe) are optional: turn them on in `config.yml` → `menus`.

## Default content

* **Wings**: Halloween, Demon, Emerald Dragon (shader wings that flap, glow and stay on the body).
* **Hats**: Astral Crystal Crown, Mini Wumpus.
* **Colours**: 100+ name / chat / rank colours, including animated text effects (flames, shine, outlines...).
* **Tags**: 100+ tags. **Glows**: 11 (cycling ones included). **Sizes**: 4.
* **Skin effects**: every preset (19).
* **Join / leave messages**: 29 each, plus a first-join welcome with the player's number.
* **Emotes**: Wave, Groove, Cheer, Clap, Facepalm, Dab, Salute, Shrug, Backflip, Pumpkin Head, Witch's Brew, Boo!, Twerk.

Categories are files: copy one to make another (as many as you like).

## Requirements

* Paper 1.21.8+ (Java 21). Clients 1.21.6+ for the pack features.
* **packetevents**: hats, wings, glows (packet mode) and the wardrobe; emotes use it to hide the player's items.
* **PlaceholderAPI**: every colour / tag placeholder.
* A resource pack plugin is optional: **ItemsAdder**, **Nexo** or **Oraxen** get the pack automatically; without one you get a zip to merge into your own pack.
* Optional: TAB, LuckPerms (rank sample in the wardrobe), ModelEngine (works next to it), Floodgate (Bedrock players get chest menus).

## Quick start

1. Put `EdCosmetics.jar` and packetevents in `plugins/`, restart.
2. Set your MineSkin API key in `plugins/EdCosmetics/skin-effects/config.yml` (free at mineskin.org) and run `/edcosmetics reload`, or turn `modules.skin-effects` off.
3. Rebuild your pack plugin's pack if it didn't do it by itself (`/iazip`, Nexo / Oraxen reload), see [Resource Pack](/p/edcosmetics/getting-started/resource-pack.md).
4. Use the placeholders in TAB and your chat plugin, see [Placeholders](/p/edcosmetics/reference/placeholders.md).
5. Players open `/cosmetics` and `/emotes`.

## Folder

```
plugins/EdCosmetics/
  config.yml            modules, menus, pack, glows, hats, vouchers, limited editions
  messages.yml          chat messages of /cosmetics
  categories/*.yml      one file = one category (and its placeholder)
  guis/*.yml            every chest menu
  data/<uuid>.yml       what each player owns and wears
  equipment-combos.yml  wing x armour looks of the pack (generated, don't edit)
  skin-effects/         config.yml (MineSkin key, presets), messages.yml
  emotes/               config.yml, messages.yml, emotes.yml, wheel.yml, hats.yml, wings.yml
  wardrobe/             config.yml (texts, buttons), messages.yml, hud.yml
  pack/                 the resource pack, when no pack plugin is used (also EdCosmetics-pack.zip)
```