Using it

Opening animations

There are 23 animations. A crate picks one with animation: <id> in its file. Players cannot close or skip an animation, and a reward is never lost if they log out or the server restarts mid-animation.

IdTypeWhat it does
horizontal-rouletteROULETTE_HHorizontal reel that slows down onto the win.
vertical-rouletteROULETTE_VVertical reel.
slot-machineSLOTS_3Three-reel slot machine.
ring-revealRING_EXPANDSlots fill outward from the center.
card-flipCARD_FLIPFace-down cards flip over.
countdownCOUNTDOWNCandidates are eliminated one by one.
chest-unlockCHEST_UNLOCKA lock dial cycles, then unlocks.
mystery-pickPICK_ROLLThe player clicks a mystery slot to roll it.
scratch-cardSCRATCHThe player scratches panels off a card.
balloon-popBALLOON_POPThe player pops a balloon, the rest follow.
dice-rollDICE_ROLLTwo dice flash, then the result reveals.
lucky-wheelLUCKY_WHEELA ring of rewards spins under a pointer.
mining-digMINING_DIGA pickaxe smashes a wall open.
fishing-reelFISHING_REELCatches rise from the water to the surface.

World animations (play on the crate block, GUI closed)#

IdTypeWhat it does
carouselCAROUSELA ring of rewards circles the crate and stops on the win.
crate-spinCRATE_SPINA reward rises out of the crate and flips through the rewards.
meteorMETEORA burning rock falls onto the crate and the win rises out.
fountainFOUNTAINRewards shoot out in arcs, then the win.
chest-revealCHEST_REVEALA chest appears in front of the player, decoy rewards orbit and are sucked in, then the chest bursts open and the win rises out.
flicker-landingITEM_FLICKERA floating item flickers and lands.
lightning-revealLIGHTNING_REVEALVisual lightning bolts strike, then reveal.
vortex-burstVORTEX_BURSTA particle spiral bursts into the reward.
firework-showFIREWORK_SHOWAn accelerating firework volley and a finale.

World animations play on the crate block that was clicked. When a crate is opened from /crates or a command, they play in front of the player instead. The floating reward above a crate hides while an animation plays on it.

Make your own animation#

Copy any file in animations/, rename it (the file name is the id), edit it, point a crate at it and run /mv reload. Each file has a display-name, a type (from the tables above), settings for that type (rows, title, timing, anchor height) and a list of steps.

Each step has an action and a when hook (START, TICK, REVEAL or END; no when means REVEAL):

ActionMain parameters
SOUNDsound (required, a vanilla id), volume, pitch
TITLEtitle and/or subtitle, fade-in, stay, fade-out
ACTIONBAR, MESSAGEtext
BOSSBARtext, color, style, progress, seconds
PARTICLEparticle (particles without extra data), count, dx, dy, dz, speed, spread values
FIREWORKcolor (hex), flicker, power, offsets
LIGHTNINGoffsets. Visual only, never damages.
DELAYticks (required)
REVEALNo parameters. The moment the reward is actually given, commands run and the win is announced. Without a REVEAL step the reward is given when the animation ends.
ITEM_DISPLAYop (spawn, set, despawn), id, material, offsets, scale

Text in steps can use {reward}, {crate}, {player} and {rarity}. The bundled animations/_TEMPLATE.yml has the full schema and a worked example. Unknown keys are ignored and missing keys get defaults. /mv reload reports any animation problems.