> For the complete documentation index, see [llms.txt](https://lethium.gitbook.io/lethium-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lethium.gitbook.io/lethium-docs/gameplay/cosmetics.md). # Cosmetics Purely visual effects in eleven categories, how they are sold, and how to write a new one. File: `plugins/ClickEmCore/modules/cosmetics.yml`. Module id: `cosmetics`. Commands: `/cosmetics`, `/cosmetic`, `/gradient`. Cosmetics are **purely visual** and have **no effect on stats**. A cosmetic is bought once and owned permanently. A player can equip **one per category** at the same time, so a kill effect, a trail and a death effect can all be active together. Cosmetics are bought with **Gems**, from 150 for common effects up to 3200 for the rarest. A `cost` of `0` means "not for sale": used by the seven VIP bonus cosmetics, which are given free with a rank. Cosmetics can also come from **vouchers** (see [Vouchers](/lethium-docs/gameplay/vouchers.md)) and crates (the `cosmetic` and `grandcosmetic` crates). ### The categories Each category has about 20 effects (`damage-styles` has 26). | Section | When it plays | | -------------------- | ---------------------------------------------------------------------------- | | `kill-effects` | At the death spot of every ClickEm mob you kill. | | `boss-kill-effects` | Alongside your kill effect when the mob is on the `boss-mobs` list. | | `death-effects` | At your location when you die. | | `trail-effects` | Redrawn at your feet while equipped, as you move. | | `killstreak-effects` | When a killstreak tier is reached. | | `join-effects` | When you join the server. | | `level-up-effects` | When your Profile Level rises. | | `rebirth-effects` | When you rebirth. | | `spawn-effects` | When you respawn after dying. | | `teleport-effects` | At the destination of a long-distance teleport (`/spawn`, warps, zone hops). | | `damage-styles` | The look of floating damage numbers (digit style, size, crit glow). | Every effect id must be **unique across all categories**, not just within its own. ### An effect ```yaml kill-effects: void_rift: display-name: "clickem.cosmetics.void_rift.name" cost: 300 particle: PORTAL count: 50 spread: 1.3 shape: VORTEX duration-ticks: 14 rarity: RARE sound: "entity.enderman.teleport:0.35:0.8" ``` | Key | Meaning | | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `display-name` | Language key. | | `cost` | Gems. `0` = not for sale. | | `particle` | Any Bukkit Particle name. | | `count` | Number of particles. | | `spread` | Radius of the cloud or shape. | | `shape` | Optional. Default `BURST` (a random loose cloud). Others: `RING`, `WAVE`, `HALO`, `COLUMN`, `HELIX`, `SPIRAL`, `SPHERE`, `STAR`, `WINGS`, `VORTEX`, `BEAM`, `RAIN`, `ORBIT`, `FOUNTAIN`. A shape draws `count` particles along a fixed figure. On event categories it plays as a short animation over `duration-ticks`. | | `speed` | How far particles drift. Default 1.0 for `BURST`, 0.0 for shapes. | | `sound` | Optional `key[:volume[:pitch]]`. Plays once per effect. | | `color`, `color-to`, `size` | For `DUST` (needs `color`) and `DUST_COLOR_TRANSITION` (also `color-to`). Hex `#RRGGBB`. | | `rarity` | Menu colour and tooltip frame. Default `COMMON`. | | `bundle` | Other effect ids given free together. | | `interval-ticks` | Trails: how often they redraw. | #### Damage styles | Key | Meaning | | ------------- | ------------------------------------------------------------------------------------------------------------------ | | `scale` | Size multiplier of the floating number. | | `glow` | Hex colour replacing the gold outline on crits. | | `digit-style` | `BOLD`, `DOUBLE_STRUCK`, `SANS_BOLD`, `FULLWIDTH`, `MONOSPACE`, `SUPERSCRIPT` or `NORMAL`. A plain character swap. | | `font` | A resource-pack font key (`lztooltips:digits`). Needs the font in your pack. | The number's text is in the lang file under `clickem.cosmetics..damage` and `.crit`. ### Global settings | Key | Default | Meaning | | -------------------------- | ----------- | -------------------------------------------------------------------------------- | | `trail-tick-period-ticks` | 5 | How often trails are checked. A trail's own interval is raised to this if lower. | | `sounds.enabled` | true | Master switch for cosmetic sounds. | | `sounds.volume-multiplier` | 1.0 | Scales every effect's sound volume. | | `teleport.min-distance` | 8.0 | Shorter same-world hops do not trigger the effect. | | `teleport.cooldown-ticks` | 40 | Gap between two teleport effects. | | `teleport.ignored-causes` | `[UNKNOWN]` | Teleport causes that never trigger it (zone border corrections). | | `gui.*` | | Rows, category buttons and fallback icons. | Players can switch particles and sounds off in `/settings`. ### How to {% tabs %} {% tab title="Add an effect" %} Copy a block in the right category, change the id (must be unique), add `clickem.cosmetics..name` to `lang/en_us.yml`, then `/clickem module reload cosmetics`. {% endtab %} {% tab title="Change a price" %} Edit `cost` (Gems). Use `0` to make it reward-only. {% endtab %} {% tab title="Give a cosmetic" %} `/ceadmin cosmetics unlock `. To hand out a tradable item use `/voucher admin cosmetic [amount]`. {% endtab %} {% tab title="Make a cosmetic free with a rank" %} Put its id as `bonus-cosmetic-id` under that tier's `perks` in `vip-perks.yml`. {% endtab %} {% endtabs %} ### Staff commands `/ceadmin cosmetics unlock `, `equip `, `reset `. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://lethium.gitbook.io/lethium-docs/gameplay/cosmetics.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.