# AutoFirework

AutoFirework logo

AutoFirework is a lightweight Bukkit server plugin that periodically launches random fireworks from fixed locations at independently configured intervals. It supports Paper and Folia, staggered startup, per-tick launch limiting, safe data writes, and multiple languages. ## Compatibility | Server | Status | |---|---| | CraftBukkit, Spigot, Purpur | Bukkit API compatible | | Paper | Tested on Paper 26.3 | | Folia | Tested on Folia 26.3 | The plugin is compiled to Java 8 bytecode and supports Minecraft 1.8.8 and newer. Folia uses region schedulers automatically; other server implementations use the Bukkit scheduler. ## Installation 1. Place the plugin JAR in the server's `plugins/` directory. 2. Restart the server. 3. `config.yml` and `data.yml` are generated on first startup. ## Quick Start ```text /af create festival 100 2 ``` This command creates a launcher at the player's current location and launches a firework every 100 ticks. ## Commands ```text /af create /af delete /af list /af reload /af help ``` - `create`: creates a launcher at the player's location; player only. - `delete`: deletes the named launcher. - `list`: lists all launchers. - `reload`: reloads configuration, launcher data, and languages. - `help`: displays command parameters and administrator help. - Tab completion supports subcommands, launcher names, intervals, and power values. Permission: `autofirework.admin`, granted to operators by default. ## Configuration ```yaml language: auto settings: minimum-interval-ticks: 20 maximum-launchers: 100 maximum-launches-per-tick: 5 skip-unloaded-chunks: true ``` | Key | Description | |---|---| | `language` | Interface language; defaults to `auto` | | `minimum-interval-ticks` | Minimum launch interval; defaults to 20 ticks | | `maximum-launchers` | Maximum number of launchers; defaults to 100 | | `maximum-launches-per-tick` | Maximum launches per tick; defaults to 5 with fair rotation | | `skip-unloaded-chunks` | Skip unloaded chunks; enabled by default | Run `/af reload` after editing. New launchers are staggered over at most 40 ticks on startup or reload. Launchers with the same name keep their previous launch schedule. ## Languages Supported values: `auto`, `en`, `zh_cn`, `zh_tw`, `ja`, `ko`, `de`, `fr`, `es`, `ru`. - `auto`: uses each player's client language and the server locale for console messages. - Unsupported languages fall back to English. - Spigot 1.8.8 cannot read the player client locale, so `auto` falls back to English. Fixed-language example: ```yaml language: zh_cn ``` ## Data Format `data.yml`: ```yaml fireworks: example: location: world:0:64:0:0:0 height: 2 delay: 100 ``` - `location`: `world:x:y:z:yaw:pitch` - `height`: firework flight power from `0` to `126`; retained for configuration compatibility - `delay`: launch interval in ticks - Names allow `a-z`, `0-9`, `_`, and `-`, with a length of 1–32 Run `/af reload` after editing. If `data.yml` cannot be parsed, the plugin keeps the currently loaded launchers, disables writes, and backs up the original file as `data.yml.corrupt-`. Repair the file and run `/af reload` to restore writes.

AutoFirework

1.3.0