> 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/configuration/config-yml.md).

# config.yml reference

Every section of the global config.yml in order, with defaults.

`plugins/ClickEmCore/config.yml` holds the settings that apply to the whole plugin. Gameplay settings are in `modules/`, see [Gameplay overview](/lethium-docs/gameplay.md).

### `license`

```yaml
license:
  key: ""
```

Your **ClickEm license key**, from your purchase confirmation. The plugin will not run without a valid key. Keep it private, and never post your `config.yml` in public without removing it. See [Licensing](/lethium-docs/getting-started/licensing-and-languages.md).

### `locale`

```yaml
locale:
  default: en_us
  sync-lethium-language: true
```

| Key                     | Meaning                                                                                                                                                |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `default`               | Language used when a player's client language has no translation.                                                                                      |
| `sync-lethium-language` | Pass each player's ClickEm language to LethiumLanguage and LethiumMessages. See [Language and text](/lethium-docs/configuration/language-and-text.md). |

### `economy`

```yaml
economy:
  primary-currency: coins
```

The currency id used as "Coins". Leave it as `coins`. Other currencies are `gems` and `artifact_essence`.

### `storage` and `redis`

See [Storage and multi-server](/lethium-docs/configuration/storage.md).

### `limit-stats`

The hard ceiling for the total of each stat. See [Stats and limits](/lethium-docs/configuration/stats-and-limits.md). Defaults: `crit-chance: 75`, `movement-speed: 50`, `movement-speed-flat: 5`, everything else `-1` (unlimited).

### `modules`

One `enabled:` switch per module. See [Modules](/lethium-docs/configuration/modules.md).

### `gui-icons`

Shared icons used across menus. See [Menus and icons](/lethium-docs/configuration/menus-and-icons.md).

### `rarity-tooltips`

The six-tier tooltip frame. See [Menus and icons](/lethium-docs/configuration/menus-and-icons.md).

### `gui`

Shared menu settings: Escape behaviour, border, hub, sword menu, profile and admin panel layout. See [Menus and icons](/lethium-docs/configuration/menus-and-icons.md).

### `hub`

Icons of the `/clickem` hub categories and each module button. See [Menus and icons](/lethium-docs/configuration/menus-and-icons.md).

### `integrations`

```yaml
integrations:
  vault:
    enabled: true
  placeholderapi:
    enabled: true
  luckperms:
    enabled: true
```

Each integration does nothing unless its toggle is `true` **and** the target plugin is installed. A missing plugin never causes a crash: that one integration is simply left off. Safe to leave on.

| Integration      | What it gives you                                                                                                                                                                               |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `vault`          | ClickEm Coins appear as a Vault economy, so other plugins (shops, `/pay` plugins) can use them. The `vault-mirror` option in `mob-rewards.yml` mirrors a share of kill income.                  |
| `placeholderapi` | The `%clickem_*%` placeholders. See [Placeholders](/lethium-docs/placeholders.md).                                                                                                              |
| `luckperms`      | Lets [VIP tiers](/lethium-docs/gameplay/vip-perks.md) match a player's **primary LuckPerms group** (`required-group`). Without it, tiers work through the `clickem.vip.<tier>` permission only. |

### Dependencies

| Plugin                                                                                        | Needed?                                                                                                                               |
| --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| **MythicMobs**                                                                                | **Required.** ClickEm will not start without it.                                                                                      |
| Vault, PlaceholderAPI, LuckPerms, WorldGuard, FastAsyncWorldEdit, ItemsAdder, LethiumLanguage | Optional. Each unlocks extra features.                                                                                                |
| ExcellentCrates                                                                               | Used for crate keys (rewards and the Gems Shop). Not a dependency in `plugin.yml`, but the key commands only work if it is installed. |
| CinematicView                                                                                 | Used by the [tutorial](/lethium-docs/gameplay/tutorial.md) and boss cinematics.                                                       |
| BetterModel, BetterHud                                                                        | Models and HUD.                                                                                                                       |

See [Requirements](/lethium-docs/getting-started/requirements.md) for the full list.


---

# 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/configuration/config-yml.md?ask=<question>&goal=<user_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.