effects yml - magemonkeystudio/fabled GitHub Wiki

โœจ effects.yml

The effects.yml file defines custom particle shapes and patterns that can be used in skills. These shapes are generated using math formulas and are most useful for creating dynamic visuals like spirals, rings, explosions, and more.

File location:

/plugins/Fabled/effects.yml

๐ŸŽฏ Supported Mechanic

โš ๏ธ Important: effects.yml is only used by the Particle Projectile mechanic.

To use a custom effect shape from this file:

  1. Create the shape in effects.yml
  2. In the skill editor, go to:
    Mechanic โ†’ Particle Projectile โ†’ Effects
    
  3. In the effects: field, enter the name of the effect (e.g. spiral-up, circle-flat)

Particle Projectile โ€“ Effect Settings

Setting Description
effects Comma-separated list of effect names from effects.yml
effect-time Total duration the effect plays
effect-delay Time before the effect begins
effect-interval Delay between effect steps
effect-speed Playback speed
effect-forward Distance forward from the projectile (Z offset)
effect-upward Distance above the projectile (Y offset)

Example

effects: spiral-up
effect-time: 20
effect-interval: 1
effect-delay: 0
effect-speed: 1
effect-forward: 0
effect-upward: 0.2

๐Ÿงช Test effects by using visible projectiles and debug messages in your skills.


๐Ÿงฎ File Format

Each effect shape uses this structure:

<effect-name>:
  steps: <number>
  copies: <number>
  domain: <range>
  x: "<math expression>"
  y: "<math expression>"
  z: "<math expression>"
  • steps: Number of points to plot in the shape
  • copies: Rotated or repeated versions (for symmetry)
  • domain: How wide the range of angles/inputs is (usually 360)
  • x/y/z: Math formulas that define the shape's 3D coordinates

๐Ÿง  Supported Math

Symbol Meaning
a Angle or loop step index
t Time (for animations)
c Copy index (for loops)
cos(), sin(), tan() Trig functions
abs(), ^, *, /, +, - Standard math operations

๐Ÿ“š Effect Categories

Click a category to browse full examples:

You can define unlimited shapes, and reuse them across multiple skills.


๐Ÿ”— Related Pages

โš ๏ธ **GitHub.com Fallback** โš ๏ธ