skyslycer / particlehelper Goto Github PK

View Code? Open in Web Editor NEW

ParticleHelper is a utility plugin/library to easily handle sending particles to the client. It is meant to be a nice api to prevent having to figure out how to customize each particle.

License: GNU General Public License v3.0

Java 96.35% Kotlin 3.65%

particlehelper's Introduction

ParticleHelper

ParticleHelper is a library that nicely handles the logic for customizing particles for Minecraft Java Edition.

Documentation

Gradle

repositories {
   maven("https://repo.bytecode.space/repository/maven-public/")
}
dependencies {
    implementation("com.owen1212055:particlehelper:1.0.0-SNAPSHOT")
}

Allows you to handle particles nicely, accounting for all the weird exceptions.

// Send a single blue note to the player
ColorableParticle noteParticle = Particles.NOTE.single();
noteParticle.setColor(Color.fromRGB(0, 0, 255));

// You can even compile the particle to optimize sending to multiple players!
CompiledParticle compiled = noteParticle.compile();

Location location = Bukkit.getWorlds()[0].getSpawnLocation();
for (Player player : Bukkit.getOnlinePlayers()) {
   compiled.send(player, location); // Compiled particles will cache their packet when reusing the same location!
}

 // Send a bulk note particle
MultiNoteParticle noteParticle = Particles.NOTE.multi();
noteParticle.setColorMultplier(0.5F); // Note we lose the ability to individually modify the particle color, but we can control the multiplier.
noteParticle.setYOffset(10);
noteParticle.setCount(90);

// Send to a specific player
Player player = Bukkit.getPlayer("bob");
noteParticle.send(player, player.getLocation());