animations

Every opening animation is one file in animations/. The file name is the animation’s id, which crates select with Settings.Spin-Animation. After editing, run /cratesadmin reload.

Five files ship, one per animation type: csgo.yml, monthly.yml, roulette.yml, slots.yml and shuffle.yml. You can add as many files as you like, for example a fast and a slow CSGO, and give each crate its own.

Upgrading from an older version

animations/ is only filled when the folder does not exist yet, so a server that already has it does not get slots.yml and shuffle.yml. Copy them from the jar (or the examples below), or delete the folder and restart to get every default back.

When an animation plays

• Only on a single open of a ROLL crate whose Spin-Animation is set. Opening more than one key at once is always instant.
• Only for players who have animations turned on (the toggle in /crates, on by default).
• Pressing Q (drop) skips to the result. Closing the menu, opening another menu or disconnecting finishes the open at once, and the reward is still given.
• When the animation finishes, the result stays on screen for Reveal-Delay ticks, then the menu closes and the rewards and summary are handed out.

Types

Type	What the player sees
CSGO	A row of rewards scrolls sideways and slows down, stopping with the winner on Winner-Slot.
MONTHLY	A grid of mystery chests. The player opens Picks of them, each one spins through rewards and reveals a prize. One key gives Picks rewards.
ROULETTE	A closed ring of rewards with a glowing pointer running around it. The reward under the pointer is mirrored in the middle, and the winner is revealed there.
SLOTS	A slot machine. Every reel scrolls down and they stop one after another, left to right, landing three of a kind of the winner on the payline.
SHUFFLE	Random rewards flicker in one slot, slowing down until the last one is the winner, while a colored frame chases around it.

Every type except MONTHLY wins exactly one reward per key.

Settings

Settings:
  Type: "CSGO"
  Title: "Opening {crate}..."
  Size: 27
  Reel-Slots: [9, 10, 11, 12, 13, 14, 15, 16, 17]
  Winner-Slot: 13
  Spins: 48
  Start-Interval: 1
  End-Interval: 4
  Reveal-Delay: 20
  Choose-Slot: true

Key	Default	Used by	Description
Type	required	all	CSGO, MONTHLY, ROULETTE, SLOTS or SHUFFLE.
Title	required	all	Menu title. {crate} and {player} are replaced.
Size	required	all	Menu size, a multiple of 9 from 9 to 54.
Reel-Slots	[]	CSGO, ROULETTE	The reel. CSGO: the scrolling row, left to right. ROULETTE: the ring in path order, at least 4 slots, each next to the one before and the last wrapping back to the first. Ranges like 9-17 work.
Winner-Slot	0	CSGO, ROULETTE, SHUFFLE	CSGO: the reel slot the winner stops on (must be one of Reel-Slots). ROULETTE: the reveal slot in the middle of the ring (must not be on the ring). SHUFFLE: the slot the rewards flicker in (must not be on Frame.Slots).
Spins	1	all	CSGO: how many times the reel moves. MONTHLY: how many frames each chest spins. ROULETTE: the minimum number of pointer steps (rounded up so it lands on the winner). SLOTS: how many frames the first reel spins, more than half the longest reel. SHUFFLE: how many rewards flicker, the last one being the winner.
Start-Interval	1	all	Ticks between frames at the start. ROULETTE also uses it as the speed the ring drains at after landing.
End-Interval	4	all	Ticks between frames at the end. The speed eases from start to end, so a higher value means a longer slow-down.
Reveal-Delay	40	all	Ticks the result stays on screen before the menu closes.
Choose-Slot	false	CSGO, ROULETTE	true shows the Mystery-Item on the reel first and lets the player pick a slot. CSGO: the picked slot becomes the winner slot. ROULETTE: the pointer starts from the picked slot. Any other type with Choose-Slot: true fails to load.
Pitch-Climb	0	ROULETTE, SLOTS, SHUFFLE	Added to the REEL-TICK pitch over the spin (ROULETTE: and again over the drain), so the ticking rises. 0 turns it off.
Reels	[]	SLOTS	A list of reels, each a list of slots from top to bottom. The middle slot of every reel is the payline. No slot may be in two reels. Required for SLOTS.
Reel-Stagger	0	SLOTS	Extra frames each next reel spins, so reel 2 stops Reel-Stagger frames after reel 1, and so on.
Picks	3	MONTHLY	How many chests the player opens, and how many rewards one key gives.
Chest-Slots	[]	MONTHLY	The slots of the mystery chests. Required for MONTHLY.

Choose-Slot and keys

With Choose-Slot: true the key is only spent when the player picks a slot. Closing the menu before picking costs nothing and gives nothing. Every other open spends the keys before rolling.

Items

Filler:
  Material: BLACK_STAINED_GLASS_PANE
  Name: "&r"

Mystery-Item:
  Material: CHEST
  Name: "&b&lMystery Slot"
  Lore:
    - "&7Pick the slot the winning reward"
    - "&7of this spin will stop on."
    - ""
    - "&e➥ Click to select this slot!"

Markers:
  Slots: [4, 22]
  Item:
    Material: BEACON
    Name: "&b&lWinning Slot"

Key	Description
Filler	Fills every slot that is not part of the animation. Optional. Also what the reel clears to when the winner is revealed.
Mystery-Item	MONTHLY: the closed chest icon (required). CSGO / ROULETTE: shown on the reel while the player picks a slot with Choose-Slot. Required for ROULETTE with Choose-Slot.
Markers.Slots	Slots that point at the winner. CSGO: the markers move with the winner slot when the player picks a different one. ROULETTE, SLOTS, SHUFFLE: fixed. Optional.
Markers.Item	The marker icon.

Reward icons in the animation are each reward’s Display-Item from the crate file.

Slots

Settings:
  Type: "SLOTS"
  Title: "Spinning {crate}..."
  Size: 45
  Reels:
    - [11, 20, 29]
    - [13, 22, 31]
    - [15, 24, 33]
  Spins: 30
  Reel-Stagger: 8
  Start-Interval: 1
  End-Interval: 5
  Reveal-Delay: 40
  Pitch-Climb: 0.6

Markers:
  Slots: [18, 26]
  Item:
    Material: YELLOW_STAINED_GLASS_PANE
    Name: "&e&lPayline"

Every frame each running reel moves down one slot. Reel 1 stops after Spins frames, reel 2 after Spins + Reel-Stagger, and so on, playing REEL-LAND as each one stops. The winner lands on every payline, so the result reads as three of a kind. When the last reel stops, everything but the paylines clears to the Filler. Pressing Q lands every reel at once.

Shuffle

Settings:
  Type: "SHUFFLE"
  Title: "Shuffling {crate}..."
  Size: 27
  Winner-Slot: 13
  Spins: 36
  Start-Interval: 1
  End-Interval: 6
  Reveal-Delay: 30
  Pitch-Climb: 0.8

Frame:
  Slots: [3, 4, 5, 14, 23, 22, 21, 12]
  Items:
    Red:
      Material: RED_STAINED_GLASS_PANE
      Name: "&r"
    Orange:
      Material: ORANGE_STAINED_GLASS_PANE
      Name: "&r"
    Yellow:
      Material: YELLOW_STAINED_GLASS_PANE
      Name: "&r"

Winner-Slot shows a different random reward every frame (never the same one twice in a row), and the last one is the winner. Meanwhile the Frame.Items chase one step per frame through Frame.Slots, which are listed in path order around the winner slot. The frame is optional: leave Frame out for a plain flicker.

Key	Description
Frame.Slots	The frame around the winner slot, in path order. Must not include Winner-Slot.
Frame.Items	The items that chase around the frame, in order. Any number, each a normal item. Required when Frame.Slots is set.

Sounds

Each animation has its own sounds, in the same "NAME;volume;pitch" form as config.yml. Set a key to "" to silence it.

Sounds:
  "REEL-START": "BLOCK_ENDER_CHEST_OPEN;1;1"
  "REEL-TICK": "BLOCK_NOTE_BLOCK_HAT;1;1.5"
  "REEL-LAND": "ENTITY_PLAYER_LEVELUP;1;1.5"
  "REEL-CLOSE": "BLOCK_ENDER_CHEST_CLOSE;1;1"

Key	Played when
REEL-START	The animation starts (for MONTHLY, when the menu opens).
REEL-TICK	Every frame of the spin.
REEL-LAND	The winner is revealed (for MONTHLY, each chest; for SLOTS, each reel stopping).
REEL-CLOSE	The menu closes after Reveal-Delay.

Shipped presets

File	Type	Notes
csgo.yml	CSGO	27 slots, the middle row scrolls 48 times, winner in slot 13 with beacon markers above and below. Choose-Slot on.
monthly.yml	MONTHLY	45 slots, a 3x3 grid of ender chests, 3 picks per key.
roulette.yml	ROULETTE	45 slots, a 16-slot ring with the reveal in slot 22, rising tick pitch. Choose-Slot on.
slots.yml	SLOTS	45 slots, three 3-slot reels with the payline on the middle row, stopping 8 frames apart.
shuffle.yml	SHUFFLE	27 slots, 36 flickers in slot 13 inside a rainbow glass frame.

Validation

A broken animation file is skipped and logged to console with its file name, and every crate that uses it fails to load too, so it never opens without its animation. These fail an animation:

• Missing Settings, Settings.Type or Settings.Title
• An unknown Type, or a Size that is not a multiple of 9 from 9 to 54
• CSGO without Reel-Slots
• MONTHLY without Chest-Slots or Mystery-Item
• ROULETTE with fewer than 4 ring slots, a Winner-Slot outside the menu or on the ring, or Choose-Slot without a Mystery-Item
• SLOTS without Reels, with an empty reel, a reel slot outside the menu or in two reels, a negative Reel-Stagger, or Spins not above half the longest reel
• SHUFFLE with a Winner-Slot outside the menu or on Frame.Slots, or Frame.Slots without Frame.Items
• Choose-Slot: true on anything but CSGO or ROULETTE