Installation Guide

Place the resource

Put the oxide-fire folder inside your server's resources folder. If you run several Oxide resources, keep them together in a folder named [oxide].

Add the startup order

Open your server.cfg (the text file that tells your server which resources to start) and make sure the resources start in this order:

# 1. Framework, and everything it needs
ensure oxmysql
ensure ox_lib
ensure qb-core          # or es_extended, or qbx_core

# 2. Your other scripts (inventory, target, clothing, phone, banking...)
ensure ox_target

# 3. o-link, the bridge. Starts after your framework and scripts, before any Oxide resource.
ensure o-link

# 4. Oxide resources. Keep these together, ideally in a folder named [oxide].
ensure oxide-weather    # optional
ensure oxide-dispatch   # optional
ensure oxide-radio      # optional, department radio channels
ensure oxide-fire

There is no required order inside each group. The only rule is that o-link starts after your framework and scripts, and before oxide-fire. If your Oxide resources live in an [oxide] folder, you can replace the lines in group 4 with a single ensure [oxide].

Save the file.

The database

You do not need to import anything. oxide-fire creates its tables the first time it starts.

It creates tables for departments, stations, apparatus bays, grades, uniforms, gear-room loadouts, firefighters, treasury transactions, unpaid salaries, the apparatus fleet, per-model hose ports, radio channels, incident sites and wildfire zones. It also creates the shared oxide_settings table, which is where your settings live after the first start.

The database user in your mysql_connection_string (in server.cfg) needs permission to create tables, because oxide-fire checks its tables every time it starts. sql/install.sql is a reference copy of the same tables; you do not need to import it.

Add a fire job to your framework

A fire department in oxide-fire is tied to a job in your framework. When someone is hired, their framework job is set to the department's name. QBCore, Qbox and ESX do not ship a fire job, so you add one.

Pick a short, lowercase name with no spaces, for example fire. You will give your department the same name in /fire admin later.

The exact steps differ per framework:

• QBCore: QBCore guide, Add a fire job
• Qbox: Qbox guide, Add a fire job
• ESX: ESX guide, Add a fire job

Register the scba item

Firefighters need one item, scba (a breathing mask and air cylinder). Using it puts the mask on, and using it again takes it off.

The name must be exactly scba. Copy-paste entries for each framework are in the framework guides:

• ox_inventory (Qbox, and ESX or QBCore servers running ox_inventory): copy the entry from itemimages/ox_inventory_items.lua. See the Qbox guide.
• qb-inventory (QBCore): see the QBCore guide.
• ESX inventories that read ESX's items table: see the ESX guide.

If you would rather firefighters need no item to mask up, clear SCBA item under Safety → Breathing air (SCBA) in /fire settings.

Copy the item image

Copy itemimages/scba.png into your inventory's image folder:

• qb-inventory/html/images/ for qb-inventory
• ox_inventory/web/images/ for ox_inventory

Each image is named after its item (scba.png for scba). Without an image the item still works, it just shows a blank icon.

Restart the whole server

Not restart oxide-fire. A full server restart.

oxide-fire streams its own models: the hose nozzle firefighters hold, the coupling on the hose outlets and the SCBA backpack. Streamed models are only loaded when the server starts, so restarting just the resource leaves them missing for everyone already connected. This applies to the first install and to any update that changes the files in stream/.

Review the settings

Almost every setting is edited in game. On the first start, the values in shared/config.lua and shared/config/*.lua are copied into the oxide_settings database table, and from then on the database is what the server reads. Open the settings editor with /fire settings. Changes save and apply straight away.

Two settings are worth checking before anyone works a shift:

• Duty & Payroll → Use banking accounts. This is on by default and needs a banking resource that o-link supports. If you do not run one, turn it off, or the department treasury stays at 0 and salaries are never paid.
• Apparatus → Apparatus catalog. It ships with two entries, the stock firetruk engine and the stock lguard chief car. Add the fire vehicles installed on your server.

A few settings stay in the config files. The full list, with every default, is in Configuration.

Departments, stations, interaction points, grades, bays, apparatus, uniforms, loadouts, radio channels, incident sites and wildfire zones are not settings. You build them in game with /fire admin.

Make sure your admins can use the admin tools

The admin panel (/fire admin), the settings editor (/fire settings) and the hire and dismiss commands are for your server admins. A player counts as an admin if they are in a group that has the admin permission.

If you already set up admins for other Oxide resources (or for txAdmin), you are done. They can use these tools with nothing extra to add.

If you have not set up an admin group yet, add these two lines to your server.cfg. Replace the licence with your own:

# 1. Put your account in the "admin" group
add_principal identifier.license:abc123 group.admin

# 2. Give the "admin" group permission to use admin tools
add_ace group.admin admin allow

Save the file and restart your server. There is one admin level: a player either is an admin or is not, and it works the same on QBCore, Qbox and ESX.

First-time setup in game

After the fire job and the scba item are in place and the server has fully restarted:

1. Join the server with an admin account.
2. Run /fire admin to open the admin panel.
3. Create a department. The internal name must match the fire job you added earlier (for example fire). The display label is what players see.
4. Under Grades, add at least two grades. Give the highest one the boss flag so somebody can open the management desk.
5. Under Stations, create a station and place its points: at least one Clock In point, plus Lockers, a Gear Room and a Management desk.
6. Under Apparatus Bays, create a bay, place its interaction point and at least one spawn point.
7. Under Apparatus, add units to the bay.
8. Under Gear Room, add a loadout with the equipment firefighters should take (for example the scba item, a fire extinguisher and a hatchet).
9. Under Uniforms, build a uniform.
10. Under Incident Sites and Wildfire Zones, add places where fire calls can happen. Without at least one, the call generator has nowhere to start a fire.
11. Hire a test firefighter with /fire hire <serverID> <department> <grade>.
12. Have the test firefighter clock in at the station before testing anything else.

The admin panel shows a Setup Checklist for each department that ticks off grades, a station, a clock-in point, a gear room point, a bay, a spawn point, apparatus and a loadout as you add them.

Step-by-step walkthrough: Admin.