Installation

Installation

Requirements

• Paper 1.20 – 1.21.x (or Purpur/Pufferfish), Java 17+ — see Compatibility
• PlaceholderAPI and LuckPerms (required)
• Optional: MySQL, ProtocolLib, a currency plugin, ItemsAdder/Oraxen/Nexo

Steps

1. Put CelestialCosmetics.jar in plugins/, alongside PlaceholderAPI and LuckPerms.
2. Start the server once — the config files are generated in plugins/CelestialCosmetics/.
3. Configure to taste (see Configuration Files).
4. Apply changes with /cosmetics reload or a restart.

First start needs internet to fetch the database driver libraries (Paper's library loader downloads them once and caches them).

Which build?

• Custom build — ships with a full ItemsAdder-based rank system and pre-made cosmetics.
• Clean/vanilla build — basic vanilla cosmetics only (no ItemsAdder), Vault economy, rankbg/chatemoji/rebirth disabled.

Both are the same plugin with different default configs.

Network install (MySQL)

1. Install on every server.
2. On each, set storage.type: mysql pointing at the same database.
3. Keep the config files identical across servers.

Full guide: Network Sync.

First look

• /cosmetics — open the menu
• /cosmetics admin — the in-game creation wizard (Admin Tools)
• /cosmetics give <player> <type> <id> — grant a cosmetic

Recommended chat/TAB wiring

• Chat format → include %celestial_rank%, %celestial_namecolor%, %celestial_tag%, %celestial_chatcolor%
• TAB tabprefix → %celestial_rank_tab% (enable TAB's nested placeholders)

See Placeholders.

---

Next: Quick Start