Installation Guide
Step-by-step setup instructions for ClothesPlus
Requirements
| Requirement | Version | Notes |
|---|---|---|
| Minecraft Server | 1.20 - 1.21.X+ | Paper/Spigot recommended |
| Java | 17+ | Required for modern Minecraft versions |
| PacketEvents | Latest | REQUIRED - Download from SpigotMC |
| MineSkin API Key | - | Required for skin generation |
PacketEvents is Required!
ClothesPlus will not work without PacketEvents installed. Download it from SpigotMC.
ClothesPlus will not work without PacketEvents installed. Download it from SpigotMC.
Optional Dependencies
- LuckPerms - For permission-based token allocation and outfit slots
- FastLogin - For cracked server support
- PlaceholderAPI - For placeholder support in other plugins
- Nexo / ItemsAdder / Oraxen - For custom item support in cursor creator
Quick Installation
- Download PacketEvents and place it in your
pluginsfolder - Download ClothesPlus from BuiltByBit or Polymart
- Place
ClothesPlus-X.X.X.jarin yourpluginsfolder - Start (or restart) your server
- Get a MineSkin API key (see below)
- Edit
plugins/ClothesPlus/config.ymland add your API key - Run
/clothes reload
MineSkin API Key Setup
MineSkin is a free service that generates signed Minecraft skin textures.
ClothesPlus uses it to apply skin overlays to players.
Step 1: Create a MineSkin Account
- Go to mineskin.org
- Click "Login" in the top right
- Sign in with your Discord, GitHub, or Microsoft account
Step 2: Generate an API Key
- After logging in, go to mineskin.org/apikey
- Click "Create new API Key"
- Give it a name (e.g., "ClothesPlus")
- Copy the generated API key
Step 3: Add to config.yml
Open plugins/ClothesPlus/config.yml and find the MineSkin section:
YAML
# MineSkin API Key
mineskin:
api-key: urapikey
Replace urapikey with your actual API key:
YAML
# MineSkin API Key
mineskin:
api-key: your-actual-api-key-here
Keep your API key private!
Never share your API key publicly. If compromised, regenerate it on mineskin.org.
Never share your API key publicly. If compromised, regenerate it on mineskin.org.
Plugin Folder Structure
After first startup, ClothesPlus creates this folder structure:
Folder Structure
plugins/ClothesPlus/
├── config.yml # Main configuration
├── creator.yml # Character creator stages
├── cursor_creator.yml # Cursor creator settings
├── guis.yml # Wardrobe GUI configuration
├── base_skin/ # Base skins (steve.png, alex.png)
├── overlays/ # Your clothing overlays
│ ├── shirts/
│ ├── pants/
│ ├── shoes/
│ ├── hats/
│ └── accessories/
├── player_config/ # Per-player settings
│ └── overlay_priorities.yml
├── races/ # Race configurations
│ └── human.yml
└── shading/ # Shading templates
├── steveshade.png
└── alexshade.png
Adding Clothing Overlays
Overlays are PNG files in standard Minecraft skin format (64x64 pixels). Place them in the appropriate category folder:
Example
plugins/ClothesPlus/overlays/
├── shirts/
│ ├── casual_tshirt.png
│ ├── formal_shirt.png
│ └── hoodie.png
├── pants/
│ ├── jeans.png
│ └── shorts.png
└── hats/
├── baseball_cap.png
└── wizard_hat.png
After adding overlays, run /clothes reload to refresh the wardrobe.
Tip: Make sure your overlay PNGs only contain the clothing pixels.
Transparent pixels will show the player's base skin underneath.
Extracting Bundled Overlays
ClothesPlus comes with bundled overlay templates. To extract them:
- Open
config.yml - Set
overlay_extract.enabledtotrue - Run
/clothes reload - The system will extract bundled overlays and automatically set this back to
false
YAML
# Overlay Auto-Extract System
# Automatically extracts bundled overlay ZIP from the plugin JAR on startup if set true
# You can also run the command /clothes reload to extract it on the server live. Just bare it might lag for a moment.
# When you finish extracting the overlays, the system with set this back to false automatically.
overlay_extract:
enabled: false # Set to true to extract bundled overlays on next startup or /clothes reload
MySQL Setup (Optional)
For cross-server synchronization (Velocity/BungeeCord networks), configure MySQL:
YAML
# mySQL setup for Velocity/BungeeCord servers
mysql:
enabled: false
host: "127.0.0.1"
port: 3306
database: "clothesplus"
username: "clothesuser"
password: "changeme"
pool-size: 10
use-ssl: false
# Velocity/BungeeCord Cross-Server Sync
# Enable this when running behind a Velocity or BungeeCord proxy
# Requires ClothesPlusVelocity plugin on the proxy for full functionality
velocity:
enabled: true # Set to true to enable cross-server skin synchronization
# When enabled, skin resets and updates are broadcast to all backend servers
# This ensures players see consistent skins across server switches
Verify Installation
Run these commands to verify ClothesPlus is working:
Commands
/clothes info # Shows plugin version and status
/clothes help # Shows available commands
/wardrobe # Opens the wardrobe GUI (requires overlays)
Success! If you see the wardrobe GUI, ClothesPlus is installed correctly.
Check the Commands page for usage instructions.
Troubleshooting
Plugin not loading?
- Make sure PacketEvents is installed
- Check console for error messages
- Verify you're running Minecraft 1.20+
Skins not applying?
- Verify your MineSkin API key is correct
- Check console for MineSkin errors
- Ensure overlay PNG files are valid 64x64 skins
Permission errors?
- Default permissions are set to
op - Use LuckPerms or a permission plugin to grant
wardrobeclothes.use - See the Permissions page for all permissions