> For the complete documentation index, see [llms.txt](https://esmp-fun.gitbook.io/plugins/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://esmp-fun.gitbook.io/plugins/vault-crates/readme.md).

# Overview

Vault Crates turns vaults into crates. You choose the key, the rewards and how often each player can open it; players right-click the vault with the key and get their rewards.

Because the crate is a real vault, it looks and sounds like one: it dims for a player who has opened it and lights up again when they can open it once more.

* Each crate can have two keys, **normal** and **ominous**, each with its own rewards. Either key opens the same vault.
* Rewards can be any item (with enchantments, names or items from other plugins), commands, keys for other crates, or Wild Spawners spawners.
* Choose who waits after an open: each player on their own, everyone at once, or open once per player, ever.
* Everything is set up in-game with `/vc gui`. Players left-click a crate to see what it can give.
* Floating text above each crate shows its name, key and wait time.

## Where to start

1. [Installation](https://esmp-fun.gitbook.io/plugins/vault-crates/installation.md): put the jar in and check it loaded.
2. [Your first crate](https://esmp-fun.gitbook.io/plugins/vault-crates/your-first-crate.md): make a crate, place it and open it in five minutes.
3. [The admin menu](https://esmp-fun.gitbook.io/plugins/vault-crates/admin-gui.md): a tour of `/vc gui`.
4. [Managing keys](https://esmp-fun.gitbook.io/plugins/vault-crates/managing-keys.md): giving keys out, and keys from shops, votes and mobs.
5. [crates.yml](https://esmp-fun.gitbook.io/plugins/vault-crates/crates-yml.md): the crate file, for editing by hand.
6. [Commands and permissions](https://esmp-fun.gitbook.io/plugins/vault-crates/commands-and-permissions.md)
7. [config.yml](https://esmp-fun.gitbook.io/plugins/vault-crates/config-yml.md): opening several keys at once, full inventories, holograms, protection, updates.
8. [messages.yml](https://esmp-fun.gitbook.io/plugins/vault-crates/messages-yml.md): changing or translating the text players see.
9. [Ready-made rewards](https://esmp-fun.gitbook.io/plugins/vault-crates/loot-templates-yml.md): `loot-templates.yml`.
10. [Wild Spawners](https://esmp-fun.gitbook.io/plugins/vault-crates/wildspawners-integration.md): spawners as rewards, and keys dropped by spawner mobs.
11. [Troubleshooting](https://esmp-fun.gitbook.io/plugins/vault-crates/troubleshooting.md)

## Getting help

Ask in the Discord linked from the store page. Include:

* the Vault Crates version (`/vc help` shows it)
* your server software and version, like `Paper 1.21.8` or `Paper 26.3`
* the part of `crates.yml` or `config.yml` you changed
* the console log from around the moment it went wrong
* how to make it happen again, if you know
