🗂️How to configure and setup creator.yml

ClothesPlus – Character-Creator Configuration (creator.yml)

This guide breaks down everything inside plugins/ClothesPlus/creator.yml. If you want to properly construct your own creator for your server, please read thoroughly!

Each Server MUST setup their own creator based on their needs, if in any case you cannot or do not want to do it on your own, feel free to commission Turretedash7 or amon_m on Discord.

If you do not configure the creator to work as you need it to for your server, it will still run but it wont be 100% up to your needs without configurations.

Quick primer
• The top-level character-creator: section controls logic (cool-downs, titles, cinematic, global commands).
• A list called stages: defines each stop in the wizard (race/gender → skin → eyes → …).
• displays: at the very bottom holds text-display coordinates that paint floating glyphs in-world.

Section

In the guide

What the write-up explains

Global toggles (enabled, cooldowns, titles, action-bar…)

✅

What each flag does, default timing values, and how to disable them safely.

Cinematic block

✅

How to chain DELAY lines, console vs %p commands, and why ticks are used.

start_command / end_command

✅

Execution order, placeholder replacement, typical warps/NPC opens.

Stage array

✅

All keys (number, id, enter-commands, display-set, option-display-set, disabled_races, plus every *_options list). Shows how placeholder keys tie to /clothes race, how the hair meta-stage works, and what happens if a stage is skipped.

Unified hair config

✅

command-pattern, hair_styles, hair_colors, how {gender}/{color}/{style} are injected.

Display sets

✅

Coordinate system, glyph codes, colour codes, keeping separate “stage” vs “option” displays, and spawn-distance tweaks.

Fallback location

✅

Where it’s read, how to disable, common mistakes (world mismatch).

1  Core Flags & Timings

character-creator:
enabled: true # master on/off switch if you want creator to work.
disable-cooldowns: false # true = dev‑mode, instant key spam
stage-cooldown: 1800 # ms between stage flips (1.8 sec)
option-key-cooldown: 1500 # ms between option scroll (1.5 sec)

Key

Meaning

enabled

Hard‑disables the command if set to false.

disable-cooldowns

Lets admins test without waiting.

stage-cooldown

Minimum time between Prev/Next Stage (slots 4/5).

option-key-cooldown

Minimum time between Prev/Next Option (slots 0/1).


2  Loading Splash & Action‑Bar

loading-title: '&6Loading in...'
loading-subtitle: '&7Please wait'
loading-fadein: 20 # ticks (1 second)
loading-stay: 80 # 4 seconds
loading-fadeout: 20 # 1 second
actionbar: true
actionbar-customization:
header: '&6§l<< Creator >> '
footer: '&7[Slot 4: Prev Stage | Slot 5: Next Stage]'
duration: 160 # ticks to keep refreshing (8 s)

Action‑bar builder runs every tick for duration when the player is on a stage. The plugin auto‑injects live info (stage #, option index, cooldown) between header and footer.


3  Cinematic Prelude

cinematic:
- ticks: 110 # wait ~5.5 s before first command
execute-commands: [] # list just like start_command (see below)

If you need an intro fly‑through: place DELAY n and command strings in execute-commands. Each DELAY eats that many ticks before the next line fires. This specific command chain line allows you to add any plugin's command of triggering 'cinematics'


4  Global Command Hooks

start_command:
- '%p warp creatorspace' # "player" commands start with %p this section is a must so you can setup a creator in a specific placement!
- DELAY 30 # 1.5 s pause
- '%p wardrobe' # open preview NPC
- DELAY 30
- '%p clothes stage race-gender'
end_command:
- '%p wardrobe'
- DELAY 50
- '%p warp creatorfinish' #please add in the section you want players to tp to after finishing creating their character.

Placeholders inside commands:

Token

Replaced with

%p

Executed as the player (i.e. via Bukkit.dispatchCommand(player, …)).

Anything else

Runs from console.

{player}

Player name text‑replaced.

{gender}, {race}, {skincolor} …

Live selections from previous stages.

DELAY n

Pause n ticks before the next line.


5  Stage List (stages:)

Each block is one GUI screen in the wizard.

- number: 0 # purely cosmetic but recommended to keep tidy
id: race-gender # **unique string** used in commands (`/clothes stage …`)
enter-commands: [] # auto‑run when the player lands on this stage
display-set: set1 # text‑display group from bottom of file
gender_options: # ↓ special layout just for stage‑0
- male_human:
display: '&fMale Human'
display_id: option-male_human # optional → display glyph
commands:
- '%p clothes race male human'
- female_human:
…

5.1 Generic stage keys

Key

Description

number

Used only for the HUD – any integer.

id

Internal handle – must be unique.

enter-commands

Same command syntax as global lists.

display-set

What appears over the player’s head to label the stage.

option-display-set

(Optional) separate glyphs to highlight the current option.

disabled_races

List of race IDs that should skip this stage.

5.2 Option definitions

The plugin merges all option sources into one runtime list:

Inside each option map you can supply:

Sub‑key

Purpose

display

Text shown in the HUD when this option is selected.

display_id

ID inside displays: block for a customised glyph.

commands

What actually changes the skin (/clothes wear …).

Note  If you omit display, the first command string is shown instead.

5.3 Unified Hair Stage (example #3)

hair:
command-pattern: '%p clothes wear hairs/creator/{gender}/{color}/{style}'
hair_styles:
- display: '&f&lGeneric Haircut'
style: '1'
hair_colors:
- display: '&f&lBrown'
color: 'brown'

The Hair stage presents two nested carousels:


6  Displays Section

Located outside character-creator:. Every key inside displays: is a display‑set – a named bundle of one or more TextDisplay coordinates.

displays:
set1:
text1:
x: -1.18 # ← +X is player‑right
y: 0.05 # ← up
z: 0.5 # ← forward (toward player)
text: 'ꐘ' # glyph or MiniMessage string

6.1 Convention cheatsheet

Prefix

Used for

option-…

Per‑option glyphs (selected hair style, eye colour, etc.).

hair‑<gender>-<colour>

Extra icon rendered below the head to preview dye.


7  Placeholders Recap

Placeholder

Filled with

{player}

Player name (in commands).

{gender} / {race} / {skincolor}…

Probed from previous selections.

{style} / {color}

From hair stage controls.

%p

Marks the command as run by the player.

DELAY n

Wait n ticks before next command in list.


8  Troubleshooting

  1. Nothing happens on click → check the command actually starts with %p or is console‑safe, and that the path exists (/clothes wear …).

  2. Stage won’t advance → you’re inside stage-cooldown. Set disable-cooldowns: true for testing.

  3. Invisible displays → co‑ordinates too far; keep |x|,|y|,|z| ≤ ~1.5 for option sets and ≤ 2 for stage sets.

  4. Glyph shows as a box → missing rune in your RP font file.

Published with Nuclino