Crates
Crates placed on blocks in your world, opened with keys, with animated rewards, rarities and chances.
The Crates module turns any block into a crate. Players open it with a key and win a random reward, revealed by an animation. You choose the rewards, their chance and rarity, and how players get keys: as items in their inventory or as virtual keys stored on their account.
This module requires the complete edition. See editions.
Features
- Crates on any block. Look at a block and turn it into a crate with one command. Crate blocks cannot be broken, blown up or moved by pistons.
- Three animations. Roulette (a row of rewards scrolls and slows down until the prize), Wheel (rewards turn around the menu and stop on the prize) or Instant (the reward is given right away, without a menu).
- Physical and virtual keys. Physical keys are items with your own name, description, glow and even an image from your resource pack. Virtual keys stay on the player's account and work on every server of your network.
- Weighted rewards with five rarities: Common, Rare, Epic, Legendary and Mythic. A reward can give money, items, console commands, or all of them.
- Win limits. Cap how many times one player can win a given reward.
- Announcements. Big wins can be announced to every player on the network.
- Preview. A left click on a crate shows every reward with its rarity and chance.
- Nothing is ever lost. The reward is chosen before the animation and given even if the player closes the menu, leaves or the server stops. Items that do not fit in the inventory wait in the player's mailbox.
- Floating names and particles above and around each crate.
Setting it up
Open the Crates module in the web editor and go to the Crates tab. Click Add a crate, fill it in and save.
The crate
- ID: lowercase letters, digits and
_. It is used in commands and cannot be changed once saved. - Name: shown to players. Colors with
&are allowed. - Animation: Roulette, Wheel or Instant.
The key
- Item: what a physical key looks like. Default: a tripwire hook.
- Pack item: replaces the item with an image from your resource pack, made with the pack module.
- Key name and Key description: leave them empty for an automatic text in the language of each player.
{crate}is replaced by the crate name. - Glowing: makes the key shine.
Rewards
Click Add a reward for each prize. The chance of a reward is its weight divided by the total weight of the crate; the editor shows both.
- Icon, used in the menus when the reward has no items.
- ID: lowercase letters, digits and
_, used in commands. It cannot be changed once saved. - Name shown to players. Colors with
&are allowed. Empty uses the name of the first item, or of the icon. - Weight and chance.
- Rarity: colors the reward and the firework.
- Max wins per player: 0 for unlimited. Once a player reaches it, that reward is left out of their draws.
- Announce to everyone: tells every player on the network who won it.
- Money, with its currency (needs the Economy module).
- Commands: run from the console.
{player},{crate}and{reward}are replaced by the player name, the crate ID and the reward ID. - Items: save the crate first, then hold the item in game and type the command shown in the editor,
/crate item <crate> <reward>. Addinventoryat the end to save your whole inventory instead. Remove the items clears them.
Placing crates
Placed crates lists where each crate stands, on every server. To place one, look at a block in game and type /crate set <crate>. To remove one, look at it and type /crate remove, or remove it from the list in the editor.
Giving keys
In Give keys, search a player, pick Virtual or Physical, the amount and click Give. Virtual keys work even if the player is offline. Physical keys are items, so the player must be online on the server you are editing.
Settings tab
| Setting | What it does | Default |
|---|---|---|
| Preview on left click | Left clicking a crate shows its rewards and their chance. | On |
| Push back without a key | A player who clicks a crate without a key is pushed back. | On |
| Opening sound | Sound played when a crate opens. | Chest opening |
| Win sound | Sound played when the reward is revealed. | Challenge complete |
| Win effect | Firework, Particles or None. | Firework |
| Floating names | Name shown above each crate (Minecraft 1.19.4 and newer). | On |
| Name height | Height of the name above the block, in blocks. | 1.4 |
| Particles around crates | None, Sparkles, Flames, Enchantment, Portal, Hearts, Notes or Green sparks. | Sparkles |
How players use it
- Right click a crate to open it. A physical key held in either hand is used first; otherwise a virtual key is used.
- Left click a crate to preview its rewards.
/cratelists their virtual keys.
If every reward of a crate has reached its win limit for that player, the crate does not open and the key is kept.
Commands
| Command | What it does | Permission |
|---|---|---|
/crate or /crate keys (also /crates) |
Lists your virtual keys. | inglis.crates.use (everyone) |
/crate preview <crate> |
Shows the rewards of a crate. | inglis.crates.use (everyone) |
/crate set <crate> |
Turns the block you look at into a crate. | inglis.crates.admin (operators) |
/crate remove |
Removes the crate you look at. | inglis.crates.admin (operators) |
/crate list |
Lists the crates placed on this server. | inglis.crates.admin (operators) |
/crate key give <player|all> <crate> [amount] [virtual|physical] |
Gives keys to a player or to everyone online. Virtual by default. | inglis.crates.admin (operators) |
/crate key take <player> <crate> [amount] |
Takes virtual keys from a player. | inglis.crates.admin (operators) |
/crate item <crate> <reward> [inventory] |
Saves the item in your hand, or your whole inventory, as the items of a reward. Creates the reward if it does not exist yet. | inglis.crates.admin (operators) |
/crate open <crate> [player] |
Opens a crate for you or a player, without using a key. | inglis.crates.admin (operators) |
The amount of keys goes from 1 to 100,000.
Placeholders
| Placeholder | Shows |
|---|---|
%ingliscore_crates_keys_<crate>% |
Virtual keys the player has for that crate, for example %ingliscore_crates_keys_vote% |
See placeholders for how to use them.
Tips
- Three crates come ready to use: Vote Crate, Rare Crate and Legendary Crate. Their rewards show how to chain them: one prize of the Vote Crate is a Rare Crate key, given with the command
crate key give {player} rare 1 virtual. - Use virtual keys for vote rewards and store purchases: they work even if the player is offline or on another server of your network.
- Placed crates belong to the server they were placed on, so you can have different crates on each server.