Home

VEngine Wiki

VEngine is an animated particle effect engine for Minecraft servers. It plays visual effects (spirals, rings, comets, beams, portals) anywhere in the world and lets you author your own effects as plain YAML files - no Java, no restart, no client mods.

This wiki is split by audience:

You are	Read
Server owner / admin	Commands and permissions, Placeholders, then Writing your own effects
Plugin developer	For developers

Requirements and installation

• Paper or Spigot 1.21.6 - 26.x, Java 21+ (26.x servers need Java 25; the jar runs on both)
• Put VEngine-<version>.jar into plugins/, restart, run /ve play traveling_comet
• PlaceholderAPI is optional. When it is installed, %vengine_*% placeholders are available - see Placeholders
• The vengine-api / vengine-core jars on the download page are for developers only

After the first start you get:

plugins/VEngine/
├── config.yml        # particle view distance
└── effects/          # one .yml per effect, hot-reloaded by /ve reload

Deeper documentation

• Formula functions, variables and YAML schema: Parametric Effects
• Kotlin DSL and SPI reference: Developer Guide