ParticlePlus Documentation

ParticlePlus Documentation

Welcome to the ParticlePlus official developer guide.
This documentation helps developers integrate their plugins with ParticlePlus to create advanced particle effects, dynamic visual systems, and fully customizable particle behaviors.

ParticlePlus is designed to be lightweight, modern, and easy to use while still offering powerful features like bounds-based spawning, RGB particles, glow effects, and advanced filtering systems.


Features Overview

Entity Tracking

Attach particle effects directly to:

  • Players
  • Mobs
  • Items
  • Custom entities

Effects automatically follow the entity position in real time.


Location Tasks

Create static particle effects at fixed world locations.

Perfect for:

  • Spawn hubs
  • Portals
  • Protected regions
  • Ambient decorations
  • Dungeon indicators

ParticleMix Builder

The ParticleMix.Builder system allows you to combine multiple particle types into one reusable effect.

You can mix:

  • Vanilla Bukkit particles
  • RGB colored particles
  • Radius spreading
  • Spawn bounds
  • Delay timing
  • Custom counts

RGB & Glow Support

ParticlePlus supports advanced visual customization:

  • RGB dust particles
  • Multi-color glow cycling
  • PacketEvents integration
  • Smooth animated color transitions

Bounds-Based Spawning

Using the new bounds system, particles can spawn inside a custom 3D area instead of only around an entity or location.

Useful for:

  • Region visualization
  • Cuboid indicators
  • Arena borders
  • Safe zones
  • Large ambient effects

Advanced Filtering System

Config-based particle effects support advanced filters:

  • Item names
  • CustomModelData
  • NBT tags
  • Entity scoreboard tags
  • World restrictions
  • Permissions

This allows highly specific and optimized particle behavior.


Performance Focused

ParticlePlus is optimized for modern Paper servers and asynchronous-safe environments.

Key optimizations include:

  • Lightweight schedulers
  • Efficient packet handling
  • Minimal object allocation
  • Smart viewer management

Documentation Sections

SectionDescription
Installation & SetupHow to install and hook into the API
API UsageBasic examples and practical usage
API ReferenceFull method documentation
Config CustomizationCreate custom particle systems using YAML
Advanced FeaturesBounds, glow effects, filtering, and optimization