> 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/installation.md).

# Installation

1. Stop the server. Put `EdCosmetics.jar` in `plugins/`, with **packetevents** and **PlaceholderAPI**.
2. Start the server. EdCosmetics writes its files into `plugins/EdCosmetics/` and its resource pack into your pack plugin (see [Resource Pack](/p/edcosmetics/getting-started/resource-pack.md)).
3. Skin effects: get a free API key at [mineskin.org](https://mineskin.org), put it in `plugins/EdCosmetics/skin-effects/config.yml` → `mineskin.api-key` and run `/edcosmetics reload`. If you don't want skin effects, set `modules.skin-effects: false` in `config.yml` and restart.
4. Make your pack plugin rebuild if it didn't by itself: ItemsAdder `/iazip`, Nexo `/nexo reload pack`, Oraxen `/oraxen reload pack`. Players must rejoin (or accept the new pack) to see the models and effects.
5. Put the placeholders in TAB and your chat plugin ([Placeholders](/p/edcosmetics/reference/placeholders.md)), e.g. TAB `groups.yml`:

```yaml
_DEFAULT_:
  tabprefix: "%edcosmetics_rankcolor_apply%"
  customtabname: "%edcosmetics_tabpaint_apply%"
  tagprefix: "%edcosmetics_rankcolor_apply%"
  tagsuffix: "%edcosmetics_tags%"
```

6. Give your ranks the cosmetics: every cosmetic is unlocked by `edcosmetics.cosmetic.<category>.<cosmetic>` (e.g. `edcosmetics.cosmetic.wings.demon-wings`; with LuckPerms, `edcosmetics.cosmetic.wings.*` gives the whole category). Crates and shops use `/cosmetics give <player> <category> <cosmetic>`.

## Dependencies

| Plugin                     | Needed for                                                                                        |
| -------------------------- | ------------------------------------------------------------------------------------------------- |
| packetevents               | hats, wings, glow `PACKETS` mode, the wardrobe; emotes use it to hide equipment                   |
| PlaceholderAPI             | every colour, tag, glow and message placeholder                                                   |
| ItemsAdder / Nexo / Oraxen | optional: the pack is installed into them automatically                                           |
| TAB                        | optional: glow `TAB` mode, tab list colours                                                       |
| LuckPerms                  | optional: the rank shown on the wardrobe's name tag                                               |
| ModelEngine                | optional: works next to it (see [Resource Pack](/p/edcosmetics/getting-started/resource-pack.md)) |
| Floodgate                  | optional: Bedrock players always get the chest menus                                              |

## Clients

Java 1.21.6 and newer (up to 26.3) see everything with the resource pack. Without the pack, players still get the chest menus, colours, tags, glows, sizes and join messages; models, wings, skin effects and HUDs need the pack. Iris / OptiFine shader packs replace the game's core shaders: their users see normal skins and no shader wings.