ParticleLib
PluginLicenseRef-All-Rights-Reserved

ParticleLib

A Library For Developers

5
Downloads
0
Followers
2 months ago
Updated
📦
1
Versions

📖About ParticleLib

ParticleLib — Advanced Shape-Based Particle API for Bukkit/Spigot

ParticleLib is a lightweight, developer-friendly particle utility library for Bukkit / Spigot / Paper plugins.
It lets you render complex geometric particle shapes with just a few lines of code — no math headaches, no repeated boilerplate.

From circles and stars to DNA helixes, spheres, cuboids, bursts, and Bézier curves, ParticleLib is built for devs who want clean visuals fast.

Features

• Chainable & intuitive API
• Supports DUST particles with color
• Built-in rotation system (X / Y / Z)
• Tons of ready-made shapes
• Zero dependencies beyond Bukkit
• Perfect for abilities, spells, cosmetics, bosses, and animations

Included Shapes

Stars (configurable points)

Circles & Ellipses

Squares & Rectangles

Lines & Curved (Bezier) lines

Particle bursts

DNA Helix (with strand connectors)

Spheres

Cuboid outlines

Installation

Maven

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
<dependency>
    <groupId>com.github.sidsteree</groupId>
    <artifactId>ParticleLib</artifactId>
    <version>v1.0</version>
</dependency>

Basic Usage
1️⃣ Create a ParticleShape

ParticleShape shape = new ParticleShape(player.getLocation())
        .setParticle(Particle.DUST)
        .setColor(Color.AQUA)
        .setSize(2.5)

;
2️⃣ Display a Shape

Circle
shape.displayCircle(100);
Star
shape.displayStar(5, 20);
Sphere
shape.displaySphere(400);
DNA Helix
shape.displayDNAHelix(4.0, 120);

🔄 Rotation Support

All shapes support 3D rotation (radians):

shape.setRotation(
    Math.toRadians(45), // X
    Math.toRadians(0),  // Y
    Math.toRadians(30)  // Z
);

Rotation is applied before spawning each particle, making it perfect for spinning or tilted effects.

Advanced Example (Spell Effect)

new ParticleShape(player.getLocation())
        .setParticle(Particle.DUST)
        .setColor(Color.PURPLE)
        .setSize(3)
        .setRotation(0, Math.toRadians(90), 0)
        .displayStar(6, 25);

If you’ve ever written 100 lines of trigonometry just to draw a circle — this library is for you.

Notes

• Rotation values are in radians
• DUST particles use Particle.DustOptions
• Shapes are centered on the provided Location