> For the complete documentation index, see [llms.txt](https://darkstarworks.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://darkstarworks.gitbook.io/plugins/mc/vc-documentation/readme.md).

# Overview

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


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://darkstarworks.gitbook.io/plugins/mc/vc-documentation/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.