> For the complete documentation index, see [llms.txt](https://codebyrave.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://codebyrave.gitbook.io/docs/resources/cr-fireworks/configuration/config.md).

# Config

## Instruction 

{% hint style="warning" %}
Config.Framework: framework u server runs or "auto"
{% endhint %}

{% hint style="success" %}
Config.EnableColorPicker: players can use colors, if false colors will be default with Config.Items
{% endhint %}

{% hint style="success" %}
Config.Texts: change the language for the menu
{% endhint %}

{% hint style="success" %}
Config.FireworkPatterns: change the shots section if u want more shots on a pattern
{% endhint %}

```
Config = {}

-- Framework 
Config.Framework = "auto" -- "auto" / "esx" / "qb"

-- Default colors for: items
-- If EnableColorPicker = false
Config.Items = {
    firework1 = { r = 1.0, g = 0.0, b = 0.0 }, -- Red
    firework2 = { r = 0.0, g = 1.0, b = 0.0 }, -- Green
    firework3 = { r = 0.0, g = 0.0, b = 1.0 }, -- Blue
    firework4 = { r = 0.6, g = 0.0, b = 1.0 }, -- Purple
}

-- Config options
Config.EnableColorPicker = true
Config.AnimationDict = "anim@mp_fireworks"
Config.AnimationName = "place_firework_3_box"

Config.Texts = {
    fireworksTitle = "Firework Settings",       -- Title: Firework Options
    colorLabel = "Color",                        -- Label: Color
    patternLabel = "Choose Firework Pattern",   -- Label: Firework Pattern
}

-- Firework patterns
Config.FireworkPatterns = {
    -- Basic
    { label = "Single Burst", id = "single", category = "Basic", shots = 1 },
    { label = "Rapid Fire", id = "rapid", category = "Basic", shots = 10 },
    { label = "Double Burst", id = "doubleBurst", category = "Basic", shots = 2 },
    { label = "Disposable", id = "disposable", category = "Basic", shots = 1 },

    -- Effects
    { label = "Spiral", id = "spiral", category = "Effects", shots = 25 },
    { label = "Rainbow Burst", id = "rainbow", category = "Effects", shots = 20 },
    { label = "Color Wave", id = "colorWave", category = "Effects", shots = 21 },
    { label = "Cascading Stars", id = "cascading", category = "Effects", shots = 15 },

    -- Finale
    { label = "Big Finale", id = "finale", category = "Finale", shots = 50 },
    { label = "Mega Finale", id = "megaFinale", category = "Finale", shots = 100 },

    -- Shapes
    { label = "Heart Shape", id = "heart", category = "Shapes", shots = 14 },
    { label = "Cross Pattern", id = "cross", category = "Shapes", shots = 10 },
    { label = "Flower Bloom", id = "flower", category = "Shapes", shots = 12 },
    { label = "Ring Explosion", id = "ring", category = "Shapes", shots = 15 },
    { label = "Falling Sparkles", id = "falling", category = "Shapes", shots = 15 },
    { label = "Random Scatter", id = "scatter", category = "Shapes", shots = 15 },

    -- Asian Patterns
    { label = "Dragon Tail", id = "dragonTail", category = "Asian", shots = 30 },
    { label = "Lantern Bloom", id = "lanternBloom", category = "Asian", shots = 20 },
    { label = "Cherry Blossom", id = "cherryBlossom", category = "Asian", shots = 20 },
    { label = "Koi Fish", id = "koiFish", category = "Asian", shots = 30 },
    { label = "Peony Burst", id = "peonyBurst", category = "Asian", shots = 20 },
    { label = "Chrysanthemum Bloom", id = "chrysanthemum", category = "Asian", shots = 20 },
    { label = "Golden Willow", id = "goldenWillow", category = "Asian", shots = 20 },
    { label = "Silver Palm", id = "silverPalm", category = "Asian", shots = 20 },

    -- Russian Patterns
    { label = "Comet", id = "comet", category = "Russian", shots = 12 },
    { label = "Brocade Crown", id = "brocadeCrown", category = "Russian", shots = 15 },
    { label = "Peony Spray", id = "peonySpray", category = "Russian", shots = 20 },
    { label = "Palm Burst", id = "palmBurst", category = "Russian", shots = 15 },
}

```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://codebyrave.gitbook.io/docs/resources/cr-fireworks/configuration/config.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.