# Configuration

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

| Parameter                                            | Description                                                                                                       | Example Value                                        |
| ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| <mark style="color:red;">`Config.Command`</mark>     | The chat command players can use to launch fireworks (if <mark style="color:red;">`UseCommand = true`</mark>).    | <mark style="color:red;">`"firework"`</mark>         |
| <mark style="color:red;">`Config.UseCommand`</mark>  | If <mark style="color:red;">`true`</mark>, enables the <mark style="color:red;">`/firework`</mark> command.       | <mark style="color:red;">`true`</mark>               |
| <mark style="color:red;">`Config.UseItem`</mark>     | If <mark style="color:red;">`true`</mark>, players can use an item (e.g., “firework\_item”) to set off fireworks. | <mark style="color:red;">`true`</mark>               |
| <mark style="color:red;">`Config.ItemName`</mark>    | The item name in your inventory system.                                                                           | <mark style="color:red;">`"firework_item"`</mark>    |
| <mark style="color:red;">`Config.soundRadius`</mark> | How far the firework sound effect travels (in meters).                                                            | <mark style="color:red;">`150.0`</mark>              |
| <mark style="color:red;">`Config.Fireworks`</mark>   | A table defining multiple firework “types” (models, particle effects, shot delays, etc.).                         | <mark style="color:red;">(See snippet below.)</mark> |

```lua
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!)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://risk-scripts.gitbook.io/risk-scripts/scripts/firework-script/configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
