Animation Reference

MonthlyCrates runs lightweight item-preview animations around the player. They are designed for keys opened from the hand: no crate block is placed, no world block is changed, and the temporary visual item cannot be picked up.

During most of an animation, the preview cycles through regular-pool prizes. Near the end it shows the opening's selected reward, then the plugin delivers all selected rewards and sends messages.

Configure an animation

Native format uses this section:

animation:
  type: CosmicAnimation
  duration_ticks: 80
  preview_interval_ticks: 3
  radius: 1.25

AdvancedCrates-compatible format uses the root-level name:

animation: CosmicAnimation

The legacy form uses its animation's default duration and a 1.25-block radius. Use native format if you need to tune duration, preview speed, or radius.

Available names

Configured name	Accepted short alias	Default duration	Visual motion
NoAnimation	None	0 ticks	Delivers immediately, without a visual.
QuickCrate	Quick	30 ticks	Quick forward/reverse movement.
RoundAnimation	Round	60 ticks	Circular orbit.
Round2Animation	Round2	80 ticks	Wider, elevated double visual orbit.
MinionAnimation	Minion	50 ticks	Compact bounce around the opener.
RevealAnimation	Reveal	45 ticks	Orbit that closes in while rising.
FlySurpriseAnimation	FlySurprise	60 ticks	Arc flying in toward the player.
MeteorShowerAnimation	MeteorShower	70 ticks	Descending circular motion.
YinYangAnimation	YinYang	65 ticks	Two opposing circular visuals.
PyramidAnimation	Pyramid	70 ticks	Rising and falling wide motion.
DisplayAnimation	Display	50 ticks	Floating display in front of the player.
CosmicAnimation	Cosmic	80 ticks	Wide elevated orbit.
CosmicMonthlyAnimation	CosmicMonthly	1800 ticks	Menu API-backed monthly crate reveal: nine general rewards, then one final reward.
ContrabandAnimation	Contraband	80 ticks	Two fast, wide orbiting visuals.
PouchAnimation	Pouch	45 ticks	Tight bounce motion.

Animation names are case-insensitive and ignore spaces, hyphens, and underscores. For example, round-animation, ROUND, and RoundAnimation all resolve to the round animation.

Tuning values

Setting	Valid value	Practical effect
duration_ticks	0–2400	Total time before rewards are delivered. 20 ticks is about one second. Set 0 for immediate delivery.
preview_interval_ticks	1–100	How often the temporary preview changes before the final reveal. Lower values cycle faster.
radius	0.25–8.0	Base distance from the player; wider animations multiply this internally.

Avoid very large radii in crowded areas. Animation visuals follow the opening location captured at start; they are removed if the player dies, disconnects, or the animation finishes. On plugin shutdown, unfinished openings are completed so that selected rewards are not discarded.

Cosmic monthly note

CosmicMonthlyAnimation opens a Menu API inventory instead of spawning world preview items. It always rolls nine rewards from the general pool and one reward from the final pool, using weighted selection. Native crates should define final_rewards; AdvancedCrates-compatible crates should define final_prizes or best_prizes.

Best-pool display note

For normal item-based animations, a selected best/final reward is used as the final highlighted preview when one exists. CosmicMonthlyAnimation displays every selected reward in the menu: nine general rewards and one final reward. The delivery and message summary still include every selected reward.