Fireworks

INSTALLATION

Open the downloaded ZIP product file and drop the folder in it somewhere in your resources folder.
Add your product key (get it here) to the settings.ini file
Add start BigDaddy-Fireworks to your server.cfg.

DO NOT RENAME THE FOLDER.

If you change the name of the folder it will not function correctly so leave the name as it is.

{:is-danger}

GIZMO

There is also another script that comes with this called BigDaddy-Gizmo. This needs to be installed as well. There is no license key as this is a free script provided for use with Fireworks. Also put in the server.cfg start BigDaddy-Gizmo. If you have a previous version of the BigDaddy-Gizmo, it will need to be updated to this one to work with Fireworks. If you had it previously with Camping. There is an update for Camping to work with this gizmo.

CONFIGURATION

As of version 2.0 and above, this has been completely rewritten and supports QBCore and QBox and/or OX Inventory. There is more setup necessary now to incorporate all those. If using the 1.x version the old docs are here

Framework setup

You do not need to configure anything to work with QBCore or QBox. The script will auto-detect what you are running and set it up for you.

Database setup

There is a database dependency when using a framework with this script. The script will auto-detect what mysql connector you have and use that automatically. It will automatically generate the table for you if it does not yet exist. You do not need to do anything else.

settings.ini

This file is where the configuration for the script is including license key, options, and locales if you desire to use a different language. Below is a description of each setting.

SETTING	DEFAULT	DESCRIPTION
[licensing]
key1	none	This is where you put your product key
[settings]
allowShows	true	Whether fireworks shows are enabled
maxNumFireworks	20	Maximum number of active fireworks allowed at one time
forceStandalone	false	Forces the script to run independently and ignore any inventory and framework that is currently running.
AddBlips	true	whether to add blips to the map for fireworks stands - framework only
CelebrateMode	true	Enables celebration mode behaviors and effects
CelebrateCooldown	360000	How long before an automatic show has to wait before it can be triggered again
chanceOfFire	30	Chance that fireworks may start fires. A number between 0 and 100. 0=never and 100=always
AllowStands	true	In stand-alone servers setting this to true allows players to create fireworks stands to use for RP.
debug	false	Enables debug logging and developer messages - recommended to keep this false unless asked to turn it on.
[sound]
useCustomSounds	true	Whether custom fireworks sounds are enabled
fuse	comma separated list	Sound file used for firework fuse ignition
mortarLaunch	comma separated list	Sound files used for mortar launch effects
mortarReport	comma separated list	Sound files used for mortar explosion effects
rocketLaunch	comma separated list	Sound file used for rocket launch effects
rocketReport	comma separated list	Sound files used for rocket explosion effects
boxLaunch	comma separated list	Sound files used for box firework launch effects
boxReport	comma separated list	Sound files used for box firework explosion effects

Setting up the inventory

If using ox-inventory and qbcore/qbox, you will need to setup the inventory. There is a file in the root of the script called oxinventory-setup.zip. It contains a text file with the inventory items that you need to copy and add to your ox_inventory items.lua in the data folder. This will not function with ox_inventory unless you do that. There are also images that need to be added to ox_inventory for your inventory to have images for the items. They typically go in ox_inventory\web\images

COMMANDS

Stand-Alone Commands These only work in stand-alone servers

COMMAND	INFO
/fireworks	Opens fireworks menu
/setfireworks-rocket	Sets down a rocket and lights it. You have 5 seconds until it starts shooting.
/setfireworks-fountain	Sets down a fountain cone and lights it. You have 5 seconds until it starts shooting.
/setfireworks-mortar	Sets down a single mortar firework and lights it. You have 5 seconds until it starts shooting.
/setfireworks-box	Sets down a cake of fireworks and lights it. You have 10 seconds until it starts shooting.
/setfireworks-bigdaddy	Sets down The Big Daddy cake of fireworks and lights it. You have 10 seconds until it starts shooting.
/setfireworks-smoke	Lights a smoke bomb in your hand and immediatly throws it in the direction your are looking (the camera)
/firecracker	Lights a M80 firecracker in your hand and throws it where you are looking (the camera)
/firecrackers	Sets down a pack of firecrackers and lights it.
/sparkler	Lights a sparkler in your hand and burns until it is complete
/romancandle	Lights a roman candle in your hand and shoots 10 shots in the direction the camera is looking
/toggleshow	Toggles show mode off and on (see below for info)
/fireworksshow	Brings up the control menu for controlling a fireworks show that you've set up (see below for info)
/fireworksstand	Creates a fireworks stand in Gizmo mode for placement. Not attended, just a stand to use for RP (must be allowed in the settings)
/deletefireworksstand	Deletes the nearest (within 10m) fireworks stand (stands must be allowed in the settings)

Framework Commands

COMMAND	INFO
/toggleshow	Toggles show mode off and on (see below for info)
/fireworksshow	Brings up the control menu for controlling a fireworks show that you've set up (see below for info)

CELEBRATE MODE

If celebrate mode is on (see settings.ini above) automatic shows will trigger when people are near the locations set in showlocations.json. You CAN edit these and put them wherever you want.

The shows are on a cooldown timer (length is configurable in the settings) so when one goes off it will not go off again until the timer runs out and someone is near again. Also, automatic shows only happen between 9pm and 5am, because of the sun.

showlocations.json

  {
    "name": "UniqueName",
    "location": { "X": -1553.307, "Y": -1131.617, "Z": 1.78 },
    "claimed": false,
    "gametimer": -1,
    "inProgress": false
  }

name = unique name
location = X Y Z coordinates of where the show will shoot from
claimed = always set to false, it's for script use
gametimer = always set to -1, it's for script use
inProgress = always set to false, it's for script use

ADMIN OPTIONS (Framework only)

People with the permission set in the settings.ini will have access to the admin options menu. This allows you to create new fireworks stands in game, create a business for that stand, manage the stand name and ownership data. /createstand starts the process to create a stand at a new location.

MARKETING INFO (Framework only)

If a stand is for sale, there is an option to view the marketing info for that stand that was entered in the admin options above. There will be a for-sale sign in front of the stand if it is available to purchase. Use targeting on the sign to see the marketing info and purchase a stand.

OWNER'S OPTIONS (Framework only)

The owner's options screen is where you, as an owner of a stand, can go see your revenue and expenses and take care of those. You can also put the stand up for sale if you choose to. Use targeting on the stand and choose OWNERS OPTIONS.

PERMISSIONS (Stand-Alone)

In the settings.ini is UseAcePermissions and AcePermission settings. Setting the first to true and then the latter to whatever permission you want to be "admin" will allow whoever has permissions to delete fireworks stands they did not create (clean up). It also allows them to create stands if those are locked down (by setting AllowStands to false)

HOW TO PLAY

This menu is only available to stand-alone servers. QB/QBox servers use inventory.

Rocket - Sets a rocket down and lights it or if in Show Mode waits for the signal to light it
Mortar - Sets a mortar down and lights it or if in Show Mode waits for the signal to light it
Fountain - Sets a fountain down and lights it or if in Show Mode waits for the signal to light it
Cake - Sets a cake down and lights it or if in Show Mode waits for the signal to light it
Finale Cake - Sets a finale cake down and lights it or if in Show Mode waits for the signal to light it
Sparkler - Lights a sparkler in your hand. It'll run for about one minute.
Roman Candle - Lights a roman candle in your hand. It will shoot 10 shots.
Firecracker - Lights a firecracker in your hand and throws it.
Firecrackers - Lights a firecracker pack on the ground.
Toggle Show Mode - Toggles show mode on and off. If in show mode, the fireworks do not immediately light when you set them down. They are added to a list of fireworks for a show. See next menu option for more info.
Fireworks Show - If you have set fireworks while in show mode, this option shows all the fireworks (in order that you set them down) and you can remotely light each one separately or all at the same time.

Pressing LEFT ALT while in the radial or show menus will toggle the MOVE/MENU mode so you can move around freely

{:is-info}

If you are too close to the box or mortar, it will hurt/kill you.