Skip to content

Configuration Files

Araaxyss edited this page Aug 1, 2026 · 4 revisions

Configuration Files Overview

CelestialCosmetics splits its configuration across several files instead of one giant config.yml. This keeps each concern isolated and makes it far easier to manage a server with hundreds of cosmetics.

All files live in plugins/CelestialCosmetics/ and are merged into a single configuration in memory at startup — you can reference values across files (e.g. a set in sets.yml referencing a tag defined in tags.yml) with no extra syntax.

File Contains
config.yml General settings: storage (SQLite/MySQL), menu layout, economy, category toggles, rank-defaults, color fallbacks
tags.yml All Tag cosmetics
rebirth.yml All Rebirth Color styles
namecolors.yml All Name Color cosmetics
chatcolors.yml All Chat Color cosmetics
rankcolors.yml Rank Effects + the whole Rank System config (ranks, weight, template, offsets)
rank-backgrounds.yml Rank Background plates — see Rank Backgrounds
emojis.yml All Emoji cosmetics (glyph shown after the tag)
glows.yml All Glow cosmetics (colored player outline) — see Glows
joinmessages.yml All custom Join Message cosmetics — see Join Messages
chatemojis.yml All Chat Emoji :shortcode: definitions — see Chat Emojis
sets.yml All Sets (bundles of the above)
crates.yml All Crates and their reward tables, including pity and daily-key settings
messages.yml Every player-facing message, plus configurable GUI lore templates

Editing Safely

  1. Edit files directly with any text editor while the server is running (or stopped — either is fine).
  2. Run /cosmetics reload (or the Reload button inside /cosmetics admin) to apply changes.
  3. Check console for warnings — invalid cosmetic references (e.g. a set pointing at a tag id that doesn't exist) are logged clearly at reload time rather than causing a crash.

Automatic Migration

If you're upgrading from a version that used a single config.yml, the plugin detects the old format on first boot and automatically splits it into the separate files above, preserving all your existing cosmetics. A confirmation is printed to console. Back up config.yml before upgrading regardless — see Installation → Upgrading.

The config.yml General Settings

Key sections you'll touch most:

storage:
  type: sqlite            # sqlite (single server) | mysql (network)
  file: "cosmetics.db"
  mysql: { host: localhost, port: 3306, database: celestialcosmetics, username: root, password: '' }

categories-enabled:       # turn whole cosmetic types on/off
  rankbg: true
  chatemoji: true
  # ...

economy:
  economy-mode: vault     # vault | eddungeons | commands
  currency: "credits"

rebirth-source-placeholder: "%eddungeons_leveling_level_rebirth_formatted%"
chatcolor-default: "&f"
namecolor-default: "&f"

Full breakdown of the menu section: GUI Customization. Full breakdown of storage: Network Sync. Full breakdown of economy: Economy Integration. Full breakdown of the rank config: The Rank System.

Anatomy of a Single Cosmetic Entry

Every cosmetic (tag, name color, chat color, rank color, emoji) follows the same basic shape:

tags:
  dragon:
    display: "&#fc6c00Dragon"
    value: "&#fc0000&l[&#fc6c00&lDRAGON&#fc0000&l]"
    icon: DRAGON_HEAD
    permission: celestial.cosmetics.tag.dragon
    description:                 # optional — overrides the default lore template
      - "&fA fierce dragon-themed tag."
    texture: "eyJ0ZXh0..."        # optional — only if icon: PLAYER_HEAD

Rebirth styles have a slightly different shape (prefix/text/suffix/gradient instead of a flat value) — see Cosmetic Types → Rebirth Color.

Next: Cosmetic Types

Clone this wiki locally