Home Discord Store Get ClothesPlus Login
Esc

config.yml

Main plugin configuration reference — MineSkin API, caching, MySQL, base skin settings, and more.

Full Reference

yaml
# Wardrobe Clothes Plugin Configuration
enable-messages: false

# FOR LUCKPERMS - Token allocation by permission group
token_settings:
  - group: default
    tokens: '1'
  - group: admin
    tokens: '5'

# MineSkin API Key - REQUIRED for skin generation
# Get your key at: https://mineskin.org/apikey
mineskin:
  api-key: urapikey

# Pre-cache system
precache:
  enabled: false
  owner_username: "YourMinecraftUsername"
  max_items: 20
  delay_seconds: 2
  priority_categories:
    - "shirts"
    - "pants"
    - "hats"
    - "jackets"
    - "shoes"
    - "accessories"

# Shared Cache Configuration
shared_cache:
  enabled: true

# Creator Cache Configuration
creator_cache:
  enabled: true

# Base Skin Cache Configuration
base_skin_cache:
  enabled: true

# Base Skin Mode
# true: Uses base skin from base_skin folder
# false: Uses player's Mojang skin as base
base_skin: true

# Require Shading Selection (only when base_skin: false)
# Players must choose a body shading via /clothes shading <gender> <file>
# before they can wear any clothing overlays.
require_shading: true

# Skin Tone Detection (only when base_skin: false)
apply_skin_tone: true

# Strip Second Layer (only when base_skin: false)
strip_second_layer: false

# Use Base Skin Parts
use_base_skin_parts: false

# Sound effects
sound: true

# Auto-Fit System
allow-auto-fit: true

# Reset to Mojang Skin
reset_to_mojang_when_empty: true

# Avatar System — show clothing preview in wardrobe/outfit GUI lore
avatar: false

# NPC Preview Configuration
npcpreview:
  use_slowness_effect: true
  enter_message: '&fLoading...'
  exit_message: '&fExiting...'
  npc_distance: 7

# MySQL Configuration
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
velocity:
  enabled: true

# Overlay Auto-Extract System
overlay_extract:
  enabled: false

# Developer Options (DO NOT TOUCH)
developer:
  self-visibility: false
  logging: false
  enhanced_cache_logging: false

Key Settings Explained

Base Skin Mode {#base-skin-mode}

Controls how player base skins are handled:

SettingBehavior
base_skin: trueAll players use steve.png or alex.png from the base_skin folder
base_skin: falsePlayers keep their Mojang skin as the base layer

When base_skin: false:

  • require_shading: true — Players must select a body shading before wearing clothes
  • apply_skin_tone: true — Automatically detects and matches skin tone for overlays
  • strip_second_layer: false — Whether to strip the outer layer from Mojang skins

Cache System {#cache-system}

ClothesPlus has three independent cache systems to improve skin generation performance:

CachePurpose
shared_cacheCaches clothing combinations shared across all players
creator_cacheCaches skin previews during character creation
base_skin_cachePer-player cache when using Mojang skins (base_skin: false)

Keep all caches enabled for best performance. Clear them with /clothes cache clear if skins aren't updating correctly.

Token Settings (LuckPerms) {#token-settings}

Tokens control how many outfit slots players can have, configured per LuckPerms group:

yaml
token_settings:
  - group: default
    tokens: '1'
  - group: vip
    tokens: '3'
  - group: mvp
    tokens: '5'
  - group: admin
    tokens: '10'

Players inherit the token count from their highest-priority LuckPerms group. Admins can also manually adjust tokens with /clothes addtoken and /clothes removetoken.

NPC Preview {#npc-preview}

The NPC preview creates a clone of the player for skin preview:

SettingDescription
use_slowness_effectApply slowness to prevent player movement during preview
enter_messageMessage shown when entering preview mode
exit_messageMessage shown when exiting preview mode
npc_distanceDistance of the NPC from the camera

MySQL {#mysql}

Required for cross-server sync. See the MySQL setup guide for details.

Overlay Extract {#overlay-extract}

Set enabled: true and run /clothes reload to extract bundled overlay templates. Automatically resets to false after extraction.