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

# Fireworks

Documentation for RTX Fireworks, the FiveM Fireworks Script for ESX, QBCore and QBox: installation, configuration, commands, exports and FAQ.

{% embed url="<https://www.youtube.com/watch?v=-WrWaTyBlX8>" %}

## Purchase

[Purchase this resource](https://rtx.tebex.io/package/5430785)

## Installation

{% hint style="info" %}
**Framework compatibility**

This resource is **standalone** and works on any FiveM server.

Compatible with **ESX**, **QBCore**, **QBox**, **vRP**, and other frameworks.

If you are using a framework other than ESX, QBCore, or QBox, follow the **Standalone** installation instructions.
{% endhint %}

{% stepper %}
{% step %}

### Standalone

* Put the `rtx_fireworks` folder into your `resources`
* Configure your `config.lua` to your preferences
* Edit `server/other.lua` file to your framework
* Put the `rtx_fireworks` to your `server.cfg`
  {% endstep %}

{% step %}

### QBCore

* Put the `rtx_fireworks` folder into your `resources`
* Open `config.lua` file
* Replace `Config.Framework = "standalone"` with `Config.Framework = "qbcore"`
* Configure your `config.lua` to your preferences
* Put the `rtx_fireworks` to your `server.cfg`
* Add new items to `qb-core/shared/items.lua` — items name: `fireworks_box_normal`, `fireworks_box_mega`, `fireworks_box_ultimate`, `fireworks_rocket`, `fireworks_pyro_small`, `fireworks_pyro_medium`, `fireworks_pyro_large`, `fireworks_pyro_mega`, `fireworks_solar_flare`, `fireworks_pyro_flare1`, `fireworks_pyro_flare2`, `fireworks_pyro_flare3`, `fireworks_pyro_fontain`, `fireworks_pyro_rug`, `fireworks_pyro_ruglong`, `fireworks_pyro_pirate`

Example items lines for `items.lua`:

{% code title="qb-core/shared/items.lua" %}

```lua
['fireworks_box_normal'] = {['name'] = 'fireworks_box_normal', ['label'] = 'Fireworks Normal', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_box_normal.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_box_mega'] = {['name'] = 'fireworks_box_mega', ['label'] = 'Fireworks Mega', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_box_mega.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_box_ultimate'] = {['name'] = 'fireworks_box_ultimate', ['label'] = 'Fireworks Ultimate', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_box_ultimate.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_solar_flare'] = {['name'] = 'fireworks_solar_flare', ['label'] = 'Solar Flare', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_solar_flare.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_rocket'] = {['name'] = 'fireworks_rocket', ['label'] = 'Rocket', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_rocket.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_pyro_small'] = {['name'] = 'fireworks_pyro_small', ['label'] = 'Pyro Small', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_pyro_small.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_pyro_medium'] = {['name'] = 'fireworks_pyro_medium', ['label'] = 'Pyro Medium', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_pyro_medium.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_pyro_large'] = {['name'] = 'fireworks_pyro_large', ['label'] = 'Pyro Large', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_pyro_large.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_pyro_mega'] = {['name'] = 'fireworks_pyro_mega', ['label'] = 'Pyro Mega', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_pyro_mega.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_pyro_pirate'] = {['name'] = 'fireworks_pyro_pirate', ['label'] = 'Pyro Pirate', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_pyro_pirate.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_pyro_rug'] = {['name'] = 'fireworks_pyro_rug', ['label'] = 'Pyro Rug', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_pyro_rug.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_pyro_ruglong'] = {['name'] = 'fireworks_pyro_ruglong', ['label'] = 'Pyro Rug Long', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_pyro_ruglong.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_pyro_flare1'] = {['name'] = 'fireworks_pyro_flare1', ['label'] = 'Flare 1', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_pyro_flare1.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_pyro_flare2'] = {['name'] = 'fireworks_pyro_flare2', ['label'] = 'Flare 2', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_pyro_flare2.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_pyro_flare3'] = {['name'] = 'fireworks_pyro_flare3', ['label'] = 'Flare 3', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_pyro_flare3.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
['fireworks_pyro_fontain'] = {['name'] = 'fireworks_pyro_fontain', ['label'] = 'Fontain', ['weight'] = 1000, ['type'] = 'item', ['image'] = 'fireworks_pyro_fontain.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'Fireworks'},
```

{% endcode %}
{% endstep %}

{% step %}

### ESX

* Put the `rtx_fireworks` folder into your `resources`
* Open `config.lua` file
* Replace `Config.Framework = "standalone"` with `Config.Framework = "esx"`
* Configure your `config.lua` to your preferences
* Upload SQL file `sql_ESX.sql` to your MySQL database
* Put the `rtx_fireworks` to your `server.cfg`
  {% endstep %}
  {% endstepper %}

{% hint style="info" %}
If you simply want to use fireworks for a standalone server or just for fun on other frameworks, fireworks spawning via command is enabled by default in standalone.

Use the command: /firework number

Numbers are from 1 to 16.\
Example: /firework 1
{% endhint %}

### Objects for anticheat whitelist

* rtx\_gang\_bang\_nano\_pyro
* p\_binbag\_01\_s
* rtx\_gang\_bang\_solar\_flare
* rtx\_gang\_bang\_simple\_pyro
* rtx\_gang\_bang\_bomb\_pyro
* rtx\_gang\_bang\_flare\_smoke\_r
* rtx\_gang\_bang\_flare\_smoke\_g
* rtx\_firecracker\_rug
* rtx\_firecracker\_rug\_long
* rtx\_pirate\_firecracker

## Notes

This page contains simple installation instructions only.

More detailed instructions, exports, events and developer-related information can be found directly inside the product folder after downloading the resource from the CFX Asset Portal.

## Support

If you need help with installation, configuration or have any questions regarding this resource, feel free to contact us on our Discord server:

[Join our Discord](https://discord.gg/rtxdev)
