Introduction
What ExyliaCrates is, what it covers, what it needs to run and how this documentation is organised.
ExyliaCrates turns any block into a crate. A player right-clicks it with a key, the crate plays one of eleven opening animations over the block, and the prize comes out in front of everybody standing nearby. Left-clicking the same block shows what is inside and the real odds of each reward.
Everything about a crate — its name, what it costs to open, its rewards, its guarantee, its animation and
where it stands — is built and edited in game from /cratesadmin. Nothing about a crate lives in a file:
crates, keys, balances and the history are rows in the database, so a network sharing one database shares
them all.
It is a premium plugin, sold on BuiltByBit and installed through a licence loader. Crates used to be a module of ExyliaSurvivalCore; they are now this plugin. See Installation for what that means for a server that used them.
What is included
Created from a menu, placed on any block with a wand, each with a floating icon, a hologram and an overview screen split into five sections.
Keys and costsKeys are their own records, held as items and as a balance worth the same on every server. A crate asks for any list of keys and money, or nothing at all.
Rewards and raritiesWeighted rewards, rarities that follow the real odds, a guarantee after so many openings, and a contents screen that shows the true odds.
OpeningsShared or private openings, opening several keys at once, clicking to speed up, the history and the server-wide announcements.
AnimationsWheel of Fortune, Carousel, Cosmic Orb, Pick a Card, Tier Slots, Rift, Tesseract, Event Horizon, Constellation, Orrery and Starfall, each tuned in a file of its own.
Developer APIRead and grant keys from another plugin, and listen for every opening.
Requirements
| Requirement | Detail |
|---|---|
| Server | Paper 1.21.1 or newer, or a fork of it. Folia 1.21.4 or newer. |
| Java | 21 |
| Required dependencies | packetevents, and ExyliaLib 1.448.1 or newer — installed for you if it is missing |
| Optional dependencies | PlaceholderAPI, an economy (ExyliaEconomy or Vault) for crates that cost money |
Configuration, the menus and their prompts, the reward editor, the database, holograms, the displays the animations are drawn with, effects, the announcement channel and the staff log all come from ExyliaLib. ExyliaCrates is written on top of it and does not run without it, which is why the loader installs it on a server that lacks it.
How a crate works, in one paragraph
A key is a record with an id, a name and an item. A crate names the keys it takes per opening — or money, or nothing. A player pays with key items they carry first and their key balance for the rest. The prize is drawn the moment the key is spent, weighted, with the guarantee applied; the animation only shows it and lands on it. It is handed over when it comes out on screen, and handed over anyway if the player leaves, dies or changes world first.
How to read this documentation
Getting started
Installation, then a first crate with a key, a reward and a block in a few minutes.
Crates
The crate screens, keys and costs, rewards and rarities, what happens during an opening, and the eleven animations.
Reference
Commands, permissions, placeholders, every configuration key, the developer API and the questions that come up most.
Conventions
- Values marked as default are what the plugin writes the first time it starts. If the file already exists, your value is kept.
- Identifiers between
<and>are variables./crates preview <crate>means/crates preview vote, not/crates preview <vote>. - A crate's id is what it was created with and never changes; its display name is what players see.
- Colours use ExyliaLib palette tokens (
{primary},{highlight},{muted}), and&codes work too.
Something missing on this page? Tell us on Discord