Crates and keys

Crates that open with keys players earn by playing, with the odds always shown.

DraftThis page is a first draft and may change.

Crates give players a prize when they open one with a key. On our network, keys are earned by playing only: votes, the daily reward, milestones, events, boss fights and the shard shop. Keys can never be sold for real money, and every crate shows its odds to players.

What players see

/crates opens the crate list. Click a crate to see every prize and its chance per key, then open 1 or up to 10 keys at once.
/keys shows their keys, how many they got today, and how to earn each kind.
/crates odds <crate> writes the odds in chat.
/crates claim collects prizes that waited because their inventory was full. Nothing is lost.
You can make any block open a crate: look at it and run /shcrates place <crate>. Sneak and break it to remove it.

The rules every crate follows

We check every crate when the server starts and when you reload. A crate that breaks a rule is turned off, with a plain reason in the console and in /shcrates check. The other crates keep working.

The chances of a crate's rarities add up to exactly 100 percent.
Rarities are sorted from most common to rarest by their chance, whatever order the file lists them in, so the good luck guarantee always means the rarer prizes.
The odds are shown. This cannot be turned off.
No key can come from a purchase. A key type that lists "purchase", "store" or similar is refused.
No prize can be marked as sold.
No prize may be stronger than about 10 hours of play: netherite gear, enchanted golden apples and strong spawners are blocked by default. You choose the list.
A prize that needs something the server does not have (for example money, with no economy installed) turns its crate off, so nobody spends a key on a prize that cannot arrive.

Keys

Daily limit: each player gets at most 5 keys a day from everything together (you can choose 1 to 20). Keys you give with a command count too.
Good luck guarantee: after 50 keys in a crate without its "pity" rarity (Epic by default) or better, the next key gives that rarity or better. You can change the number, or set 0 to turn it off.
Where keys come from: each source (votes, daily, milestones, events, bosses, fragments, shard shop, you and your staff, your add-ons) can be turned off on the settings page. The daily reward and vote rewards (plugins/sh-rewards/rewards.yml) give keys with the give_key action, the same as events and bosses.

Settings page

Setting	Default	Range
Daily key limit	5	1 to 20
Guaranteed good prize after	50 keys	0 to 200 (0 is off)
Keys opened at once	10	1 to 10
Show odds	on	always on
Keys for real money	not possible	always off
Where keys come from	all on	on or off each
Items crates may never give	netherite gear, enchanted golden apples, totems, elytra, mace, strong spawners	any items
Crates and their odds	Daily crate, Event crate	your own

Your AI can change most of these. Changes to the crates and their odds ask you first, by default.

For you and your staff

/shcrates give <player> <key type> <amount> [reason] gives keys (they count toward the daily limit and are logged).
/shcrates take <player> <key type> <amount> removes keys given by mistake.
/shcrates check checks every crate against the rules.
/shcrates reload reads the files again.

Raw files, for experts: plugins/sh-crates/config.yml and plugins/sh-crates/crates.yml.

Good to know

Keys are numbers in a ledger, not items, so they cannot be duplicated.
Crates and keys are this plugin's alone: the rewards plugin only gives keys, it has no crates of its own, so there is one /crates and one key balance.
Every key given, every crate opened and every prize claimed is written to plugins/sh-crates/audit.log, by player id only.
Add-on makers: see Add-ons for setups.