DUXPLIMA Documentation

Reveals

The six reveal kinds, the fourteen shipped animations, Bedrock fallbacks, and the reel's faithfulness.

An animation file under animations/ decides how a reward is shown and nothing else. A crate names one with animation = "<id>", and the same files serve as a crate's idle-effect.

The six kinds

revealDrawn inA Bedrock player gets
inventory-reelA window: faces scroll past a pointerThe same
inventory-turnA window: faces turn overThe same
windowA window the file lays out itselfThe same
world-orbitDisplay entities around the crate block, per viewer, as packetsThe file's bedrock-fallback
world-pillarDisplay entities rising from the crate block, per viewer, as packetsThe file's bedrock-fallback
immediateNothing: the reward is handed over at onceThe same

A world reveal spawns nothing and saves nothing, and two players opening at once never share one animation. A server with no packet layer, or an opening that is not at a placed block (a menu crate, /crates open), plays the window reveal named by bedrock-fallback instead. bedrock-fallback must name a window reveal; a world reveal there is refused and the reel is used.

The shipped animations

FileKindLengthFrameEasingFallback
reelinventory-reel3000 ms100 msease-outinventory-reel
turninventory-turn2400 ms300 mslinearinventory-turn
wheelwindow5000 ms100 msease-outwindow
curtainwindow4000 ms200 msease-inwindow
flickerwindow3500 ms150 msease-outwindow
orbitworld-orbit3200 ms160 mslinearinventory-reel
crownworld-orbit4000 ms200 mslinearinventory-reel
figure-eightworld-orbit3000 ms100 msease-outinventory-reel
helixworld-orbit3200 ms120 mslinearinventory-reel
spiralworld-orbit2800 ms100 msease-outinventory-reel
vortexworld-orbit3600 ms90 msease-ininventory-turn
waveworld-orbit2400 ms80 mslinearinventory-reel
pillarworld-pillar3600 ms120 msease-outinventory-reel
bounceworld-pillar2600 ms70 msease-outinventory-turn

crown, figure-eight, helix, spiral, vortex, wave and bounce draw their shape with a path; the others use the built-in motion of their kind.

A faithful reel

With decoys = [], the faces that scroll past are drawn from the crate's own rewards, each as often as its weight. A rare reward does not flash past as often as a common one, because it is not as likely. Name materials in decoys and the reel shows those instead. The final face is always the reward already decided.

Writing your own

Copy a shipped file and change its numbers. Every key is on Animation files, including the path expressions of a world reveal and the window block that lays out a reveal window of your own.

The window panes

opening.window in opening.conf sets the fill pane (grey) in every uncovered slot of a reel, turn or pick window, and the pointer pane (lime) above and below the slot the reel and the turn stop on. "" turns either off. A window an animation file draws puts its own pointer in its decor.

Related: Animation files, Opening