> 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

Welcome! This guide walks you through installing Vault Crates, configuring your first crates, handing out keys, and managing everything from the in-game GUI.

If you've used a crate plugin before, the workflow will feel familiar. The big difference: **your crates are vanilla Trial Vaults**, not chests. That gives you per-player loot, two visual tiers, and the real-deal vault open animation — for free.

## Where to start

1. [**Installation**](/plugins/vault-crates/installation.md) — Drop the JAR in, restart, verify the plugin loaded.
2. [**Your first crate**](/plugins/vault-crates/your-first-crate.md) — A 5-minute walkthrough: place a vault, register it, give yourself a key, open it.
3. [**Configuring crates.yml**](/plugins/vault-crates/crates-yml.md) — Full reference for the crate definitions file. Loot pools, reset modes, key items, all of it.
4. [**Managing keys**](/plugins/vault-crates/managing-keys.md) — How keys work, how to issue them, how to integrate with shop plugins.
5. [**The admin GUI**](/plugins/vault-crates/admin-gui.md) — Tour of `/tcpvc gui` and what each screen does.
6. [**Commands & permissions**](/plugins/vault-crates/commands-and-permissions.md) — Quick reference.
7. [**config.yml reference**](/plugins/vault-crates/config-yml.md) — Global toggles (bulk-open, drop protection, holograms, block protection).
8. [**messages.yml**](/plugins/vault-crates/messages-yml.md) — Translating or customising the player-facing text.
9. [**Loot templates**](/plugins/vault-crates/loot-templates-yml.md) — Starter rewards surfaced by the GUI's "Add custom reward" flow, plus how to add your own.
10. [**Integration with Wild Spawners**](/plugins/vault-crates/wildspawners-integration.md) — Make spawner mobs drop crate keys.
11. [**Troubleshooting & FAQ**](/plugins/vault-crates/troubleshooting.md) — Common gotchas and how to fix them.

## What this plugin needs

* **Paper or Folia 1.21.7+** (the admin GUI uses Paper's Dialog API; scheduling is region-aware so Folia runs natively)
* **Java 21+**
* **BetterTrialChambers v1.4.0+** — the free base plugin

Full requirements — including the Minecraft 26.x build note and the optional LuckPerms integration — are in [**Installation**](/plugins/vault-crates/installation.md).

## Getting help

If you hit a snag the docs don't cover, the Discord linked from the marketplace product page is the fastest way to get an answer. Most questions get a response within a few hours.

When asking, include:

* Plugin version (`/tcpvc help` shows it)
* Server software + version (`Paper 1.21.7`, `Paper 1.21.8`, `Folia 1.21.7`, etc.)
* The relevant config snippet (`crates.yml` entry, `config.yml` block)
* The full console log around the moment the issue happened

That triple is enough to diagnose almost anything.