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

# Overview

Virtual and physical crates built for bulk. Keys are a virtual balance, so a player can hold and open 100,000 keys at once: the roll runs off the main thread and every reward is collapsed into one action with the total attached (one currency add, one command with `{amount}`), never one action per key.

## Supported plugins

| Plugin               | Reward actions                                                                                                                                                                                      |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **PinnaPrison**      | `currency`, `currency-boosted`, `booster-item`, `booster`, `drill`, `crystal`, `crystal-random`, `bomb`, `ability-item`, `enchant`, `level`, `crystal-slots`, `pickaxe-skin`, `backpack-attachment` |
| **EdPrison 2.0**     | `currency` (currencies and level tracks), `edprison-enchant`, `edprison-level`                                                                                                                      |
| **EdTools** (EdGens) | `currency`, `currency-boosted`, `edtools-enchant`, `edtools-level`, `edtools-luckyblock`, `edtools-tool`, `edtools-backpack-item`, `edtools-booster`                                                |
| **EdDungeons**       | `currency`, `eddungeons-enchant`, `eddungeons-level`, `eddungeons-booster`                                                                                                                          |
| **Vault**            | `currency:money`                                                                                                                                                                                    |
| *(none)*             | `command`, `keys`, `item`, `give-item`, `message`, `xp`, ...                                                                                                                                        |

Other plugins can register their own action types through the [API](/p/edcrates/features/api.md).

## Highlights

* **Bulk opening**, press Q on a crate to open every key you own. 100k keys roll in a few milliseconds; rewards are granted as totals.
* **Virtual keys**, held per player in YAML, SQLite or MySQL; physical key items redeem into the balance. Offline players can be given keys.
* **Physical crates** as display entities: a scaled head with a spinning, bobbing idle animation and a per-player hologram that shows *your* key count and cycles through the rewards.
* **Lootbox animation** in the world: the crate pops up in front of you, floats, spins and bursts into its rewards with name tags. Keyframed on display-entity interpolation, so it is a handful of packets. Optionally visible only to the opener. Plus two GUI reels (roulette, flicker).
* **Everything is a config file**: one file per crate holding its selector icon, key item, preview, physical form and reward pools. Menus and animations are presets you reference by name.
* **PlaceholderAPI** in every text, plus an `edcrates` expansion.

## Quick start

1. Drop `EdCrates.jar` in `plugins/` and start the server once.
2. `/edcrates give <you> test 100` then `/crates` and press **Q** on the Test Crate.
3. Edit `plugins/EdCrates/crates/*.yml`; copy `test.yml` to make a new crate.
4. `/edcrates item <crate>` gives the placeable crate; right-click a block to place it.