Spellbook Effect

Spellbook Effect

spellbook-effect is the Paper-only module for building reusable particle effects.

The engine is Java-first. You compose an EffectInstance from:

• a Shape, which samples local-space points
• zero or more Transforms, which mutate those points
• zero or more EffectModifiers, which edit the whole point buffer
• a ParticleEmitter, which emits particles for each final point
• an optional DirectionProvider, for emitters that use per-point direction values

EffectInstance effect = EffectBuilder.create()
        .shape(new SphereShape(1.5f, 64, 0.05f))
        .translate(0, 1.0f, 0)
        .particle(Particle.FLAME, 1)
        .build();

Effects can be rendered directly for one frame, scheduled with EffectExecutor, or loaded from Bukkit configuration through EffectConfigParser.

Module Scope

This module targets Paper/Bukkit particle rendering. It does not provide a standalone plugin, command framework, scheduler abstraction, viewer selection policy, or config file loader.

Consumers usually provide:

• a Paper plugin instance for scheduling
• viewer selection
• origin and target locations
• optional YAML parsing or custom component registries

Docs In This Section

• API Model: how the effect engine is structured
• Building Effects: create and render EffectInstances
• Running Effects: schedule repeated effects with anchors and viewers
• Built-In Components: shapes, transforms, particles, and morphs
• Custom Components: implement custom shapes, transforms, modifiers, emitters, and directions
• Render Pipeline: point buffer lifecycle and performance rules
• Effect Config Parser: parse effects from Bukkit ConfigurationSection