Help & Docs

Start here

Quick Start

1. Sign in. Use Twitch or Google, then open the Console.
2. Prepare fireworks. Use the built-in library or create and save custom fireworks in Firework Lab when your plan includes the designer.
3. Create an overlay. Open Overlay Lab, choose its format, add launch zones or scene assets, and save it.
4. Set it live. Mark the overlay active and copy its private overlay URL.
5. Add it to OBS. Create a Browser Source with the overlay URL and match the source dimensions to the saved overlay.
6. Test a launch. Keep the Browser Source loaded, then fire a Single shot from Launch Pad.

Console

Know Your Workspace

Overview

Shows account access, live overlay health, saved content, and integration status.

Overlay Lab

Builds the stream-facing layout and determines where fireworks can launch.

Firework Lab

Creates reusable custom firework patterns.

Launch Pad

Selects the active overlay and provides manual, remote, and test controls.

Authoring

Firework Lab

Firework Lab turns one or more drawn shapes into a reusable custom firework. The saved pattern belongs to your workspace and can be used by eligible overlays and launch controls.

Basic workflow

1. Create a pattern and give it a recognizable name.
2. Draw points directly or load a reference image for tracing.
3. Add, reorder, mirror, or adjust shapes as needed.
4. Preview the pattern, then save it to your Custom Patterns library.

Reference images are editor aids. The live overlay launches the saved pattern geometry, not the tracing image.

Layout

Overlay Lab

Each saved overlay owns its layout, route, scene assets, and launch zones. Selecting an overlay loads that overlay's complete editor state.

Important controls

• Save Overlay stores the layout, assets, and launch-zone changes.
• Set Live makes that overlay the workspace's active launch target.
• URL shows the private browser-source route. Rotating the route invalidates the old one.
• Stage Tone changes only the editor background for visibility. Light or Dark is not saved and does not change save behavior.

Launch zones

Launch zones define the usable origin area for fireworks. With multiple zones, launches can originate across their combined area. Without zones, the engine uses its default launch span.

Broadcast software

OBS Browser Source Setup

1. In Overlay Lab, set the intended overlay live and open its URL control.
2. Copy the private overlay URL.
3. In OBS, add a new Browser Source and paste the URL.
4. Set the Browser Source width and height to the overlay's saved dimensions.
5. Keep the source loaded while streaming so it remains connected to Launch Pad and integrations.

Manual control

Launch Pad

Launch Pad controls the active connected overlay. Select an overlay, confirm it reports online, and use the available core or named firework controls.

• Single sends one immediate firework.
• Burst sends 4 to 12 launches at short intervals.
• Random Standard chooses from built-in fireworks.
• Random Custom chooses from eligible saved custom patterns.
• Full Library chooses from both available groups.

Single and named custom launches remain available while a manual burst is running, so the overlay can receive overlapping effects. A Burst control waits until the current manual burst finishes.

Mobile control

Launcher Remote

1. Open Launcher Remote from Launch Pad.
2. Generate a one-time pairing QR code.
3. Scan it with the mobile device and complete pairing.
4. Keep the active overlay loaded; the remote will report when it is online.

Pairing codes expire after ten minutes and work once. Device limits depend on the current plan and are shown in Launch Pad. Revoking a paired device removes its access immediately.

The remote can launch fireworks but cannot edit layouts, change the active overlay, or access account credentials.

Automation

Integrations & API

Trigger links

Use a trigger link for software that can open or fetch a URL. Create the link in Integrations, assign one launch behavior, copy it when shown, and place it in the client's web-request action.

Automation API

Use an automation key for clients that can send an authenticated JSON request. Keys are created in Profile & Account and shown in full only once.

POST https://fireworkengine.com/api/events
Authorization: Bearer fw_live_YOUR_KEY
Content-Type: application/json

{"launchType":"randomAll","singleLaunch":true,"source":"my-client"}

Supported launch types are randomStandard, randomCustom, randomAll, and named. Named launches also require the saved pattern name. External clients may request scheduled launches; the server allows one running and one queued scheduled job per workspace.

Access

Account & Billing

• Profile & Account manages your identity and automation keys.
• Integrations manages single-purpose trigger links.
• Subscriptions & Billing shows current access, plan choices, trial state, and PayPal controls.
• Launch Pad manages paired Launcher Remote devices and displays the current device allowance.

Canceling a subscription does not remove access immediately when a paid period remains. Feature availability follows the plan and access state shown on the Billing page.

Diagnostics

Troubleshooting

The overlay reports offline

Confirm the intended overlay is set live and its current private URL is loaded in an active OBS Browser Source.

A page or WebSocket reports 401 Unauthorized

Your signed-in browser session is missing or expired. Sign in again, then reload the Console page.

A custom firework is missing from launch controls

Confirm the pattern was saved and that the current account access includes custom pattern launching.

The remote cannot launch

Confirm the device is still paired, is within the plan's active-device allowance, and the active overlay reports online.

An external scheduled trigger says the queue is full

Wait for the running or queued scheduled job to finish. Manual Single launches use the immediate path.

Saved changes do not appear in OBS

Confirm you edited the same overlay route loaded in OBS. Normal changes refresh silently; reload the Browser Source only if it did not reconnect.

Credentials

Keep Access Private

• Treat overlay URLs, trigger links, and automation keys like passwords.
• Do not publish them in chat, screenshots, shared source files, or public repositories.
• Rotate an exposed overlay route and update the OBS Browser Source.
• Revoke exposed automation keys, trigger links, or paired remote devices from their management page.