Firework image effects

This is a PaperMC plugin for adding custom image firework effects.

They're colorless, since the client controls the color.

Input images

Input images must be PNG files. To draw a firework effect, use black and white pixel colors only. Otherwise, thresholding will be applied on the colored or transparent pixels, where below the half of "maximum lightness" will be treated as black or transparent, and the rest as white.

Place the PNG images in the Plugin's data folder, usually named firework-effects.

How to apply firework effects

1. Use the command /reload-images to reload the images while the server is running if you need to update the loaded firework effects.
2. Once ready, use /list-images to list the available firework effect names.
3. Hold a firework rocket item in your hand and use the command /set-firework <effect-name> to apply the effect to it.
4. Launch the firework rocket to see the custom effect.

Example

At sign, @

TODO

• Migrate back from Kotlin to Java because it seems to add a whole 1.8 MB header to the plugin jar file.
• Improve the command messages
• Add per-image/effect customization via configuration for angles for each copy of the effect
• Revise the code, mainly the commands (maybe we should use the command tree?)