Survival

RewardCrates

Reward crates with opening animations, physical and virtual keys, reward previews, holograms and particles. Every crate is a file in the crates folder.

Buy a license Paper, Spigot, Bukkit 1.20 – 1.21 · Java 17+

Installation

Download the file from the customer area and copy it into your server's plugins folder.
Start the server once: the plugin folder with config.yml is created.
Paste your license under license: and restart the server.

Commands

Aliases: /crates, /rc

Command	Permission	Description
`/crate preview <crate>`	`rewardcrates.preview`	Shows the rewards of a crate
`/crate keys [player]`	`rewardcrates.keys`	Your virtual keys (or another player's)
`/crate give <player\|*> <crate> [amount] [physical\|virtual]`	`rewardcrates.admin`	Gives keys to a player or to everyone
`/crate take <player> <crate> [amount]`	`rewardcrates.admin`	Removes virtual keys
`/crate open <crate> <player>`	`rewardcrates.admin`	Opens a crate for a player, no key needed
`/crate set <crate>`	`rewardcrates.admin`	Turns the block you are looking at into a crate
`/crate remove`	`rewardcrates.admin`	Removes the crate from the block you are looking at
`/crate list`	`rewardcrates.admin`	Lists the loaded crates
`/crate reload`	`rewardcrates.admin`	Reloads configuration, languages and crates

Permissions

Permission	Default	Description
`rewardcrates.use`	true	Open crates with a key
`rewardcrates.preview`	true	Preview the rewards
`rewardcrates.keys`	true	See your own virtual keys
`rewardcrates.keys.others`	op	See other players' virtual keys
`rewardcrates.bypass.cooldown`	op	Open crates without the cooldown
`rewardcrates.admin`	op	Every management command

Placeholders (PlaceholderAPI)

Placeholder	Description
`%rewardcrates_keys_total%`	Total virtual keys
`%rewardcrates_keys_<crate>%`	Virtual keys for one crate (e.g. %rewardcrates_keys_mystic%)

Creating a crate

Copy crates/mystic.yml and rename it, e.g. crates/legendary.yml: the file name is the crate id.
Edit the name, key, animation (ROULETTE, SHUFFLE or INSTANT), rewards and chances.
Run /crate reload, look at a block (for example a chest) and run /crate set legendary.
Give keys with /crate give <player> legendary 1. Virtual keys also work for offline players.

Command rewards

A reward can give items, run console commands ({player} = who opens it) or both. This lets you give money, ranks or items from other plugins.

Configuration files

config.yml

# Your license key (you received it privately from our discord bot).
license: "PASTE-YOUR-LICENSE-HERE"

# Message language: "en" (english) or "it" (italiano). Files are in /lang and can be edited freely.
language: en
# When true, each player sees the messages in their own game language (when a file for it exists).
use-client-language: true

settings:
  # What happens when the inventory is full: "drop" (items fall at the player's feet) or "deny" (opening is blocked).
  inventory-full: drop
  # Seconds a player must wait between two openings.
  open-cooldown: 3
  # Physical keys must be held in the main hand. When false, any key in the inventory works.
  require-key-in-hand: true
  # Shift + right-click opens several keys at once (no animation).
  mass-open: true
  mass-open-limit: 16
  # Left-click on a crate shows its rewards.
  preview-on-left-click: true
  # Players without a key are pushed back a little.
  knockback-without-key: true
  # Crate blocks can't be broken (use /crate remove).
  protect-crate-blocks: true
  # Every opening is written to /logs/openings.log
  log-openings: true

holograms:
  enabled: true
  # Height above the crate block.
  height: 1.25
  # Transparent background (false = dark background like a name tag).
  transparent-background: true

particles:
  enabled: true
  # How often particles are shown (20 ticks = 1 second).
  interval-ticks: 8
  # Particles are only shown when a player is this close.
  view-distance: 24

# Reward rarities. Use them in the crate files ("rarity: epic").
rarities:
  common:
    name: "&7Common"
    glass: LIGHT_GRAY_STAINED_GLASS_PANE
  uncommon:
    name: "&aUncommon"
    glass: LIME_STAINED_GLASS_PANE
  rare:
    name: "&9Rare"
    glass: LIGHT_BLUE_STAINED_GLASS_PANE
  epic:
    name: "&5Epic"
    glass: PURPLE_STAINED_GLASS_PANE
  legendary:
    name: "&6&lLegendary"
    glass: ORANGE_STAINED_GLASS_PANE

crates/mystic.yml

display-name: "<gradient:#B06AB3:#4568DC>&lMystic Crate</gradient>"

# Opening animation: ROULETTE (spinning row), SHUFFLE (rewards flicker in the centre) or INSTANT (no menu).
animation: ROULETTE

# Show the reward list on left-click / with /crate preview.
preview: true

key:
  material: TRIPWIRE_HOOK
  name: "<gradient:#B06AB3:#4568DC>Mystic Key</gradient>"
  lore:
    - "&7Right-click a &fMystic Crate &7to open it."
    - ""
    - "&8Do not lose this key."
  glow: true
  # custom-model-data: 1001

# Lines shown above the crate block.
hologram:
  - "<gradient:#B06AB3:#4568DC>&lMYSTIC CRATE</gradient>"
  - "&7Right-click with a key to open"
  - "&8Left-click to preview"

# Particle effect around the crate. Styles: RING, HELIX, NONE
particles:
  type: WITCH
  style: HELIX

# Sound names from https://minecraft.wiki/w/Sounds.json  ->  "name:volume:pitch"
sounds:
  open: "block.ender_chest.open:1:1"
  spin: "block.note_block.hat:0.6:1.6"
  win: "entity.player.levelup:1:1.2"

# Rarities that are announced to the whole server.
broadcast-rarities: [epic, legendary]

# Rewards. "chance" is a weight: the higher it is, the more often it comes out.
# The real percentage is shown in the preview.
rewards:
  diamonds:
    chance: 20
    rarity: rare
    display:
      material: DIAMOND
      amount: 6
      name: "&b6x Diamond"
    items:
      - material: DIAMOND
        amount: 6

  golden-apples:
    chance: 30
    rarity: uncommon
    display:
      material: GOLDEN_APPLE
      amount: 4
      name: "&e4x Golden Apple"
    items:
      - material: GOLDEN_APPLE
        amount: 4

  experience:
    chance: 35
    rarity: common
    display:
      material: EXPERIENCE_BOTTLE
      name: "&a500 Experience"
      lore:
        - "&7Instantly added to your level."
    commands:
      - "xp add {player} 500 points"

  netherite-sword:
    chance: 8
    rarity: epic
    display:
      material: NETHERITE_SWORD
      name: "&5Mystic Blade"
      glow: true
    items:
      - material: NETHERITE_SWORD
        name: "&5Mystic Blade"
        lore:
          - "&7Forged inside a Mystic Crate."
        enchantments:
          sharpness: 5
          unbreaking: 3
          looting: 3

  elytra:
    chance: 2
    rarity: legendary
    display:
      material: ELYTRA
      name: "&6&lElytra"
      glow: true
    items:
      - material: ELYTRA
    messages:
      - "&6You are one of the lucky few!"