⚙️Configuration

Below is a table summarizing your main configuration parameters, followed by a code snippet for reference.

Parameter
Description
Example Value

Config.Command

The chat command players can use to launch fireworks (if UseCommand = true).

"firework"

Config.UseCommand

If true, enables the /firework command.

true

Config.UseItem

If true, players can use an item (e.g., “firework_item”) to set off fireworks.

true

Config.ItemName

The item name in your inventory system.

"firework_item"

Config.soundRadius

How far the firework sound effect travels (in meters).

150.0

Config.Fireworks

A table defining multiple firework “types” (models, particle effects, shot delays, etc.).

(See snippet below.)

Config = {}

Config.Command     = 'firework'
Config.UseCommand  = true
Config.UseItem     = true
Config.ItemName    = 'firework_item'
Config.soundRadius = 150.0

Config.Fireworks = {
    ['fireworkl'] = {
        prop         = 'ind_prop_firework_02',
        particleDict = 'scr_indep_fireworks',
        particleFx   = 'scr_indep_firework_fountain'
    },
    ['fireworkm'] = {
        prop         = 'ind_prop_firework_01',
        particleDict = 'proj_indep_firework_v2',
        particleFx   = 'scr_firework_indep_spiral_burst_rwb'
    },
    ['fireworkr'] = {
        prop         = 'ind_prop_firework_03',
        particleDict = 'proj_indep_firework_v2',
        particleFx   = {
            'scr_firework_indep_repeat_burst_rwb',
            'scr_firework_indep_ring_burst_rwb',
            'scr_firework_indep_spiral_burst_rwb'
        },
        shots = 50,
        minDelay = 500,
        maxDelay = 2000,
        minFlightTime = 100,
        maxFlightTime = 200,
        maxRocketsPerShot = 2,
        maxExplosionOffsetX = 3.0,
        maxExplosionOffsetY = 3.0
    }
}

(Customize each firework entry to fit your server’s style, from quick fountains to multi-rocket bursts!)

Last updated