TotalFreedomMC/PlayerParticles
1
0
Fork 0
mirror of https://github.com/TotalFreedomMC/PlayerParticles.git synced 2025-07-24 14:33:53 +00:00
Code Issues Projects Releases Wiki Activity

Add README.md

Browse source
This commit is contained in:
Esophose 2020-01-18 14:23:36 -07:00 • committed by GitHub
parent d13111b299
commit a3d19623f0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# PlayerParticles
A Spigot particles plugin with more customizability than any other. Create particles around players
or blocks with any particle effect in the game with a plethora of skillfully crafted styles.
### Wiki
For information about how to use the plugin or API within the plugin, please refer to the [Wiki](https://github.com/Esophose/PlayerParticles/wiki)
### Server Compatibility
This plugin is compatible with [Spigot](https://www.spigotmc.org/) and any forks, I recommend using [Paper](https://papermc.io/).
Using CraftBukkit will not work.
The versions of Minecraft that are currently supported are 1.9.4-1.15.x. Support for 1.8.8 will not be added.
### Compilation
PlayerParticles uses Gradle to compile and build the plugin. Run `./gradlew build` in the project's root directory to build the jar.
The plugin jar will be located in `./build/libs` when finished.