FireworkLaunchers

Create signs that launch customizable (and/or random) fireworks into the air.

What is FireworkLaunchers?

FireworkLaunchers is a plugin that lets you create signs that can spawn fireworks at a specified interval. The type, main colour(s), fade colour(s), power, trail, and flicker can all be set per firework explosion (power is per firework only), or they can be randomly generated. Mixing defined values and random values is completely possible as well.

Usage

To create a Firework Launcher, you need at least 2 lines on a sign.

Top Line
On the top line, you put [FL at the beginning, then the power (between 1 and 127, R for random), the percent chance (out of 100%) that a firework will spawn at the interval in the config file, and then the group the launcher is in (any letter, number, word, no spaces). To finish off the top line, add a closing square bracket (]).

Example
[FL 2 10 A1] This will create a firework launcher with a power of 2 (medium height), a 10% chance that it will create a firework at the interval, and t will be in group "A1"

Other lines
The other lines are quite a bit more complicated than the first (due to how many properties a firework can have). Each of the other lines are a different explosion for the firework. The explosions use the following format:
[Type][MainColours]|[FadeColours]|[Flicker][Trail]
Note: the | is not a lowercase L, it is the pipe or vertical bar on the same key as \

[Type]: Can be a number from 0-4, or R for a random type. See the firework type reference below for more details on what each number does. Example - 3 will create a creeper shaped explosion

[MainColours]: Can be a series of hexadecimal characters or Rs for a random colour. Any number of colours (space permitting) can be used. See the colour reference below to see what colour each character is. Example - A5CR will use purple, lime green, brown, and a random colour

[FadeColours]: Exact same format as [MainColours], Rs can be used for random colours. Any number of colours (space permitting) can be used.

[Flicker] and [Trail]: Either 1 or 0 for true and false, respectively. T or Y can also be used for true, and F or N can also be used for false. An R can be used for random. Example - T will cause the explosion to have a flicker or trail, R will cause the explosion to randomly choose whether or not to have one

Complete Examples
2R3|1DR|01 - this will cause a star-shaped explosion with 2 main colours (a random one and light blue), 3 fade colours (orange, green, and a random one), that will not flicker but will have a trail.

R6|RRRR|RR - this will cause a random explosion type with pink as the main colour, 4 random fade colours, and it will randomly choose whether or not to flicker and to have a trail.

Entire Sign Example

Example

In this example, the firework will have a power of 3 and has a 15% chance of spawning at each interval. This launcher is in the "C" group.
The first explosion (line 2) will have a random type, 2 main colours (lime and random), 4 fade colours (purple, orange, and 2 random), that will flicker and it will have a trail.
The second explosion has all random variables (random type, 3 random main colours, 3 random fade colours, random flicker and random trail).
The final explosion will be creeper-shaped with 2 main colours (magenta and cyan), 2 fade colours (green and red), no flicker, and a trail.

Redstone

Depending on which mode is set in the config file, FireworkLuanchers can be activated in 2 different ways.
Pulse Mode
When first powered by redstone, a single firework will be launched, no matter what the percentage on the top line is. (Note: this is still somewhat buggy and occasionally more than 1 firework will be launched)
Normal Mode
As long as the sign is powered, fireworks will be launched using the percent chance and the interval in the config file. Powering a sign is then similar to /flstart, and de-powering a sign is then similar to /flstop.

Please provide feedback on this as it is still a work in progress. -

Commands

/flstart <group> - If no group is entered, all FireworkLaunchers will be activated. If a group is entered, only launchers in that group will be activated
/flstop <group> - If no group is entered, all FireworkLaunchers will be stopped. If a group is entered, only launchers in that group will be stopped

Permissions

fireworklaunchers.* - grants all Firework Launcher permissions
fireworklaunchers.start.* - allows activation of all groups (default: op)
fireworklaunchers.start.<group> - allows activation of specific group
fireworklaunchers.stop.* - allows deactivation of all groups (default: op)
fireworklaunchers.stop.<group> - allows deactivation of specific group
fireworklaunchers.create - allows creation of a Firework Launcher (default: op)
fireworklaunchers.destroy - allows destruction of a Firework Launcher (default: op)

Configuration

The configuration file has only one value that you shouldn't need to change, the signs (you can manually edit the signs as well, however if there is not a sign at that location in that world when the server starts, it will be removed from the configuration file). The interval is the amount of time (in ticks, there are 20 ticks per second) between firework spawns. In the redstone section, enabled is set to true or false to enable or disable redstone interactivity. If pulse mode if set to true, the launcher launches a single rocket when initially powered. If it is set to false, as long as the sign is powered, the firework will still be launched randomly at the interval (automatic way of doing /flstart and /flstop).

Example Configuration

#You should not need to change the signs manually. NOTE: Interval is in ticks, there are 20 ticks per second. Visit http://dev.bukkit.org/server-mods/fireworklaunchers/ for help with these settings.

interval: 5
redstone:
    enabled: true
    pulse: false 
signs:
  signs1:
    world: world
    coords: '{"x":"230.0","y":"64.0","z":"272.0"}'

Firework Type Reference

Type Number	Description
0	Small ball
1	Large ball
2	Star-shaped
3	Creeper-shaped
4	Burst

Colour Reference

Hex Character	Colour
0	White
1	Orange
2	Magenta
3	Light blue
4	Yellow
5	Lime
6	Pink
7	Grey
8	Silver
9	Cyan
A	Purple
B	Blue
C	Brown
D	Green
E	Red
F	Black