> 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/server-setup/excellentcrates.md).

# ExcellentCrates: crates and keys

The seven star crates, keys, reward odds, how keys are earned, and how to change rewards safely.

Files: `plugins/ExcellentCrates/` (`crates/`, `keys/`, `config.yml`, `milestones.yml`, `previews/`, `openings/`, `lang/`). It runs on the **nightcore** library (`plugins/nightcore/`), which must stay installed.

{% hint style="success" %}
**Quick start**

* Give a key: `/crates key give <player> <key> <amount>`.
* Do not change reward `Weight` without the odds rule (next page).
* Back up the crate files before editing. They are huge.
* Move a crate: re-link it with the Link Tool.
  {% endhint %}

### The crates

Seven crates, each in World 1 at the crates area (`/crates` teleports there, see [Navigation](/lethium-docs/gameplay/navigation.md)). Crates are opened with a **physical key**.

| Crate              | Stars | Contains                                          | Key comes from                                                                        |
| ------------------ | ----- | ------------------------------------------------- | ------------------------------------------------------------------------------------- |
| **Starter**        | 1     | Coins, boosts, pet boxes                          | Quests, achievements, Season Pass, Gems Shop                                          |
| **AFK**            | 2     | Coins, boosts, even ranks                         | The [AFK pool](/lethium-docs/gameplay/idle-earnings.md) (every 20 minutes), Gems Shop |
| **Vote**           | 3     | Good rewards                                      | A voting plugin (not included), Gems Shop                                             |
| **Hero**           | 4     | Rich rewards, a shot at a rank                    | Achievements, quests, Gems Shop                                                       |
| **Celestial**      | 5     | The finest: legendary ranks                       | Achievements, Season Pass, Gems Shop                                                  |
| **Cosmetic**       | 3     | Cosmetic **vouchers**, Common to Legendary        | Quests, achievements, Gems Shop                                                       |
| **Grand Cosmetic** | 5     | Legendary, Mythical and Ancient cosmetic vouchers | Achievements, Season Pass, Gems Shop                                                  |

The key ids are `starter`, `afk`, `vote`, `hero`, `celestial`, `cosmetic`, `grandcosmetic`.

> **Editing rewards?** How rewards are built, the odds rule and the safe way to edit crate files are on [ExcellentCrates: rewards and editing](/lethium-docs/server-setup/excellentcrates-rewards.md). Read the odds rule before changing any weight.

### Keys

Keys are **physical** (`Virtual: false`) and drawn with the ClickEm rarity frame. ClickEm gives keys by running:

```
crates key give <player> <key id> <amount>
```

This is used by quests, achievements, the Season Pass, the AFK pool, and the Gems Shop. To give a key by hand, run the same command.

{% hint style="warning" %}
**Key budget:** the two best keys are capped across the game at **10 celestial and 15 grandcosmetic** per player (see [Achievements](/lethium-docs/gameplay/achievements.md) and [Season Pass](/lethium-docs/gameplay/season-pass.md)). Do not add more without re-checking.
{% endhint %}

### `/crates` exists in two plugins

Both ExcellentCrates and ClickEm define `/crates`. See Troubleshooting if `/crates` teleports you instead of opening the crate command, or the other way round.

### Staff commands

ExcellentCrates' main command is `/crates`. The one this setup relies on is:

| Command                                    | Use       |
| ------------------------------------------ | --------- |
| `/crates key give <player> <key> [amount]` | Give keys |

Run `/crates help` for the full list of your version, including editing, reloading and opening crates for players. Restart the server, or use the plugin's reload command, after editing crate files.


---

# 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/server-setup/excellentcrates.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.
