Using it

The roll animation

animations.yml controls the floating shard (hologram:) and the effects played at each moment (sequences:). Copy any key into a kit file's own hologram: or sequences: section to change it for that kit only (the bundled Royal kit sets its own item, label and glow color this way).

The hologram#

hologram:
  # Item shown floating in front of the player.
  item: AMETHYST_SHARD
  custom-model-data: -1
  scale: 0.9
  follow-distance: 2.5
  vertical-offset: 0.3
  spin: true
  spin-speed: 8.0               # degrees per tick

  # How long the roll takes before the result (20 ticks = 1 second).
  suspense-ticks: 80

  label-success: "<bold><gradient:#5EEAD4:#B57CFF>UNLOCKED FOREVER</gradient></bold>"
  label-fail: "<bold><gradient:#FF5C7A:#FFC857>ONE-TIME REWARD</gradient></bold>"
  # Line under the label. %chance% = the chance this roll used. "" = none.
  info-line: "<color:#A69CC4>Chance <color:#F3EEFF>%chance%%"
  flicker-start-interval: 6.0
  flicker-end-interval: 1.0

  glow: true
  glow-color-success: "#5EEAD4"
  glow-color-fail: "#FF5C7A"
  progress-bar: true

  land-scale-success: 1.4        # the shard grows on a win...
  land-scale-fail: 0.6           # ...and shrinks on a loss
  particle-burst: END_ROD        # NONE = no burst
  linger-ticks: 40               # how long the result stays up

The label flashes between the two outcomes faster and faster until the result lands. The file also has sound options (flicker-sound, land-sound-success, land-sound-fail) and progress bar styling.

Sequences#

Each sequence is a list of steps. A step is { type: ..., delay: ..., ... }. The delay is in ticks after the step before it. Sequences: suspense (while the shard is in the air), success, fail, claim (claiming an owned kit) and pity (right after a loss).

Step typeParameters
PARTICLEpattern (SPIRAL, RING, BURST, HELIX, TRAIL_HOLOGRAM), particle, count, offset-x/y/z, speed, duration-ticks
SOUNDsound, volume, pitch
TITLEtitle, subtitle, fade-in, stay, fade-out
ACTIONBARmessage
MESSAGEmessage, broadcast: true|false
BOSSBARtext, color, duration, progress, fill: true (grows from empty to full)
FIREWORKshape (BALL, BALL_LARGE, STAR, BURST, CREEPER), color, fade, trail, flicker, power. For show only, never hurts anyone.
EFFECTeffect, duration, amplifier
LIGHTNINGA harmless flash at the shard.
COMMANDcommand, as: console|player
DELAYJust waits.

Text in steps can use %player%, %kit%, %chance% and %pity%. Sounds use vanilla ids with dots, like block.anvil.use. Colors are dye names (LIME) or hex (#5EEAD4).

A real step from the success sequence:

- { type: FIREWORK, delay: 4, shape: BALL_LARGE, color: "#B57CFF", fade: "#FF7AC6", trail: true, flicker: true, power: 1 }

Use /vkit test <kit> [success|fail] to watch a roll while you tune it. Nothing is saved or given.