# UltraRituals Animation Documentation

This file describes the different types of animations and parameters you can use in your ritual animations.

## Effect Types (effect_type)
These are the geometric patterns the particles follow:

- EXPLOSION: A burst of particles from the center. Uses 'spread' for the explosion area.
- CIRCLE: A rotating horizontal circle. Uses 'radius'.
- DOUBLE_HELIX: Two rotating spirals moving upwards. Uses 'radius' and 'height'.
- VORTEX: A tornado-like effect that narrows at the bottom. Uses 'radius' and 'height'.
- ORBIT: Multiple particles orbiting at different distances and heights.
- WAVE: A horizontal circle with a vertical wave motion. Uses 'radius'.
- HALO: A static ring of particles at a certain height. Uses 'radius' and 'height'.
- HEART: Particles forming a rotating heart shape. Uses 'radius'.
- DNA: A double helix structure (static segments). Uses 'radius' and 'height'.
- ATOM: Particles forming electron-like orbits around the center. Uses 'radius'.
- SQUARE: A flat horizontal square frame. Uses 'radius' (as half-side length).
- SUNBEAMS: Beams of particles radiating outwards and upwards. Uses 'radius'.
- SHOCKWAVE: An expanding ring that fades out. Uses 'radius'.
- SPHERE_EXPANSION: An expanding sphere that fades out. Uses 'radius'.

## Animation Parameters
Each effect in the 'effects' list can have these parameters:

- effect_type: The name of the pattern (from the list above).
- particle: The Minecraft particle name (e.g., FLAME, SOUL_FIRE_FLAME, DUST).
- sound: Minecraft sound name (optional, played periodically).
- amount: Number of particles (varies per effect type).
- spread: Randomness in particle placement (mostly for EXPLOSION).
- radius: Horizontal size of the effect.
- height: Vertical size of the effect (used in Helix, Vortex, Halo, DNA).
- speed: How fast the animation moves/rotates.
- color: Hex color code (e.g., "#FF0000"). Only works for DUST particles.
- size: Size of the particles (mostly for DUST).

## Multiple Effects
You can add multiple effects to a single animation file by adding more items to the 'effects' list. They will all play simultaneously!

Example:
effects:
  - effect_type: "CIRCLE"
    particle: "FLAME"
    radius: 1.0
  - effect_type: "HALO"
    particle: "END_ROD"
    radius: 0.5
    height: 1.5
