Effects

The nine ending effects, the settings each one reads, and how to override them for a single pouch.

The effect is the punch at the end of an opening, right as the rewards land. Each pouch names one with the effect key.

pouches.yml

    effect: FIREWORK

The nine effects

Name	What it does
`NONE`	Nothing
`EXPLOSION`	An explosion burst, no block damage
`LIGHTNING`	A lightning strike with the thunder sound
`FIREWORK`	Launches a firework
`PARTICLE_SPIRAL`	A spiral of coloured particles
`PARTICLE_VORTEX`	A vortex of particles
`SOUND_WAVE`	Expanding rings of particles
`RAINBOW_BURST`	A colourful burst
`GUARDIAN_BEAM`	A guardian beam
`ENDER_SIGNAL`	An ender signal, like a thrown eye of ender

Each effect also plays its own sound.

Fireworks launched by an effect cannot hurt players. The plugin cancels that damage.

Global settings

The effects: block in config.yml sets the defaults for each effect. The section name is the effect name in lowercase.

config.yml

effects:
  firework:
    radius: 1.0
    duration: 1
    particle_count: 50
    power: 1
  particle_spiral:
    radius: 1.5
    duration: 2
    particle_count: 80
    colors:
      - "FF0000"
      - "00FF00"
      - "0000FF"
  rainbow_burst:
    radius: 2.0
    duration: 2
    particle_count: 100
    colors:
      - "FF0000"
      - "FFAA00"
      - "FFFF00"

Key	Applies to	Meaning
`radius`	All	How wide the effect spreads
`duration`	All	How long it runs, in ticks
`particle_count`	All	How many particles it spawns
`power`	`firework`	Firework power, higher flies higher
`colors`	`particle_spiral`, `rainbow_burst`	Hex colours without a leading hash

Any effect can have a section. If effects.lightning does not exist, LIGHTNING runs on its built in defaults.

A few keys in the shipped config.yml are decoration and are not read: the effects.sound block, effects.particle.type and effects.particle.count, and effects.guardian_beam.particle_type. Set a per pouch sound with opening-sound instead, see Pouches.

Per pouch overrides

Add effect-parameters to a pouch to change the effect for that pouch only.

pouches.yml

  mystical:
    animation: FLOATING_ORBS
    effect: PARTICLE_SPIRAL
    effect-parameters:
      particle: SPELL_WITCH
      radius: 2.0
      height: 3.0
      speed: 1.5
      colors:
        - "AA00FF"
        - "FF00FF"
        - "FF69B4"

Which parameters an effect understands depends on the effect. Radius, duration, particle count and colours are the common ones.

Performance caps

settings.performance in config.yml puts a ceiling on effects so one badly tuned pouch cannot flood a server:

Key	Default	What it caps
`limit-particles`	`true`	Master switch for the caps below
`max-particles`	`150`	Highest particle count any effect can use
`max-firework-power`	`2`	Highest firework power
`max-colors`	`5`	How many colours an effect may use

With limit-particles: true, a pouch asking for 500 particles gets 150. Turn the switch off only if you know your server can take it.

Picking one

Indoors or in a shop area, SOUND_WAVE and PARTICLE_SPIRAL stay tidy.
LIGHTNING is loud and visible from far away, good for a rare drop, tiring on a common pouch.
FIREWORK reads well outdoors and at night.
Testing a lot? Use NONE while you tune rewards, then switch the effect back on.

The nine effects

Global settings

Per pouch overrides

Performance caps

Picking one

On this page