repository·master·Indexed 41 days ago
https://github.com/rosewood-development/playerparticlesA highly customizable Minecraft plugin for creating complex particle effects around players and blocks. Compatible with Spigot, Paper, and Minecraft versions 1.7.10 and newer (requires Java 8+). Features include a variety of pre-crafted styles, support for all in-game particle types, and a comprehensive command system for adding, editing, and managing both player-centric and fixed-location particle effects.
Before installing, ensure your server environment meets the following requirements:
If you require the latest features or fixes not yet available in a stable release, you can download the latest development builds from the Jenkins build server.
https://jenkins.rosewooddev.io/job/Rosewood%20Development/job/PlayerParticles/lastStableBuild/For detailed information on using the plugin or integrating its API, refer to the official Wiki.
If you need technical support, wish to report a bug, or have questions, you can join the Discord server.
The /use command allows players to apply or modify the particle effect, style, or specific data (like color or material) of their active particle group.
Command Syntax:
/use <type> <value>
Available Types:
effect: Sets the base particle effect.
/use effect <effect_name>style: Sets the visual style of the effect.
/use style <style_name>data: Sets specific parameters for the currently active effect. The required format for <value> depends on the dataType of the current effect:
COLORABLE:NOTE: Use <0-24>, rainbow, or random.<0-255> <0-255> <0-255>), a color name, or a hex code (<#hexCode>).COLORABLE_TRANSPARENCY: Use RGB and optional Alpha (<0-255> <0-255> <0-255> [0-255]), color names, or hex codes.BLOCK: Use a valid block material name.ITEM: Use a valid item material name.COLORABLE_TRANSITION: Sets a color transition. Typically starts with an OrdinaryColor followed by additional color parameters.VIBRATION: Use a duration value (e.g., 20, 40, 60).Note: This command cannot be executed by the console; it must be run by a player.
/use effect <effect_name>
/use style <style_name>
/use data <value>The add command allows players to add a new particle effect to their active particle group. The command requires an effect type and a style, and optionally accepts data specific to the chosen effect type.
Usage Syntax:
<effect> <style> [data]
Command Requirements:
<effect>.<style>.PermissionManager).add <effect> <style> [data]To create a new fixed particle effect, use the following syntax:
/pp fixed create [looking] <location> <effect> <style> [data]
Arguments:
looking (Optional): If used, the effect is created at the location the player is currently looking at. This simplifies coordinate input.<location>: The coordinates for the effect. If not using looking, you can use relative coordinates (e.g., ~ ~ ~) or absolute coordinates. If using the console, you must provide <x> <y> <z> <world>.<effect>: The type of particle effect to use (e.g., NOTE, BLOCK, ITEM).<style>: The visual style of the effect. Note that not all styles are compatible with fixed effects.[data]: Additional parameters required by the chosen effect type, such as colors, materials, or vibration settings.Example (Player):
/pp fixed create looking flame circle (Creates a flame circle effect where the player is looking)
/pp fixed create ~ ~ ~ heart circle (Creates a heart circle effect at the player's current position)
/pp fixed create [looking] <location> <effect> <style> [data]The /pp fixed command suite allows players and administrators to create, edit, remove, and manage particle effects that remain at fixed locations in the world.
Available Subcommands:
create: Creates a new fixed particle effect at a specified location.edit <id> <property>: Modifies an existing effect (e.g., location, effect, style, or data).remove <id>: Deletes a specific fixed effect by its ID.list: Displays a list of all fixed effect IDs owned by the player.info <id>: Shows detailed information about a specific effect, including its ID, location, effect type, and style.clear <radius> [location]: Removes all fixed effects within a specified radius of a location (requires specific permissions).teleport <id>: Teleports the player to the location of a specific fixed effect.The edit command allows you to modify an existing active particle's effect, style, or specific data (like color or material) using its unique ID.
Command Syntax:
<ID> <effect|style|data> <args>
Subcommands:
effect: Changes the ParticleEffect of the particle.style: Changes the ParticleStyle of the particle.data: Changes specific data associated with the effect (e.g., color, block material, or item material). The required arguments for data depend on the current effect's DataType./edit <ID> effect <effect_name>
/edit <ID> style <style_name>
/edit <ID> data <data_args>The base PlayerParticles command (the command without arguments) acts as a shortcut to open the main plugin GUI. When executed, it redirects the player to the gui command module, allowing them to interact with the plugin's visual interface.
# Execute the base command to open the GUI
/playerparticlesThe /pp group command allows players to manage collections of particles, including saving their current setup, loading previously saved groups or presets, unloading specific particles, and removing groups.
Sub-commands:
save <groupName>: Saves the player's currently active particles as a new group. The name is truncated to 100 characters. You cannot save the default group name.load <groupName>: Loads a saved group or a preset group into the player's active particles. This replaces the current active particles.unload <groupName>: Removes all particles from the player's active set that match the effect and style of the particles defined in the specified group or preset.remove <groupName>: Deletes a saved particle group. Note that removing a preset group may behave differently depending on permissions.info <groupName>: Displays detailed information about a group, including the ID, effect name, style name, and data string for each particle in the group.list: Lists all of the player's saved particle groups and available presets./pp group save <groupName>
/pp group load <groupName>
/pp group unload <groupName>
/pp group remove <groupName>
/pp group info <groupName>
/pp group listAdministrators can remove multiple fixed effects within a specific area using the clear command.
Syntax:
/pp fixed clear <radius> [location]
<radius>: The distance from the center point within which effects will be removed.[location]: The center point for the clearing operation. If omitted, it defaults to the player's current location. If used via console, a specific location must be provided.Example:
/pp fixed clear 50 (Removes all fixed effects within a 50-block radius of the player)
/pp fixed clear <radius> [location]