Configuration Reference

Every setting in oxide-fire, what it does, and what it is set to out of the box.

Where settings actually live

This is the most important thing to understand before you change anything.

oxide-fire keeps most of its settings in a database table, not in its config files.

• On the very first start, the values in shared/config.lua and shared/config/*.lua are copied into the shared oxide_settings table.
• From then on, the database is what the server reads for those settings.
• You change them in game with /fire settings. Changes save to the database and take effect straight away. No restart is needed, with the few exceptions noted below.
• Each setting has a Reset to default button. It puts back the value your config file had when oxide-fire last started.

What that means in practice:

1. Editing a config file on a server that has already started once does not change a setting that lives in the database. To use a value from the file, edit and save the file, restart oxide-fire (or the whole server), then press Reset to default on that setting in /fire settings.
2. When you update oxide-fire, settings that are new in the update are copied from the new config files automatically. Your existing settings keep your values.
3. If you want to set things up before the server ever starts, editing the config files works fine. That is what they are for.

Opening the editor:

/fire settings

Admin only. The editor has a search box, a Basic and an Advanced tier (Advanced shows the settings most servers never need to touch), and three categories in the sidebar:

Settings that stay in the config files

Some settings are not in the editor and never go into the database: how fires burn, the hose, the tools, the apparatus classes, hydrants, model swaps and the sounds and animations. You change those in the config files, then restart oxide-fire. They are listed in Settings that stay in the config files at the bottom of this page.

What is not a setting at all

Departments, stations, interaction points, grades, apparatus bays, apparatus, uniforms, gear-room loadouts, radio channels, incident sites and wildfire zones are not settings. You build them in game with /fire admin, and they are stored in their own database tables. See Admin.

Core

General

Config key: Config.AllowMultiDepartment in shared/config/department.lua.

Duty & Payroll

About the two salary modes. With Treasury-funded salaries on, a department that runs out of money stops paying, but nothing is lost. Each unpaid salary is recorded as back pay, the firefighter is told (at most once a minute), and a boss sees the total in the Payroll app and can pay it once the treasury has money again.

Without a banking resource, turn off Use banking accounts. Otherwise the treasury reads 0 and every payment from it fails. With it off, a new department's balance starts at 0, so fund it from the admin panel's Overview screen.

Config keys: Config.RequireStationClockIn, Config.SalaryInterval, Config.UseBankingAccount, Config.BankingAccountStartBalance, Config.PlayerManagement, Config.UnpaidPayrollDecayDays and Config.Boss in shared/config/department.lua.

Stations

Lockers are per character, per station. A locker that has already been opened since the server started keeps its old size until the next restart.

Config keys: Config.LockerSlots, Config.LockerMaxWeight, Config.StationZoneRadius, Config.StationZoneDistance and Config.MaxLoadoutItems in shared/config/department.lua.

Apparatus

Apparatus catalog

Each entry has:

It ships with:

Add entries for the fire vehicles installed on your server. An entry can also carry its own tank, foam and outlets numbers instead of its class's. Those three can only be written in the config file:

Config.ApparatusCatalog = {
    { model = 'firetruk', label = 'Engine', class = 'engine', type = 'car', cost = 60000 },
    { model = 'lguard', label = 'Chief Car', class = 'chief', type = 'car', cost = 30000 },
    -- An example with its own tank sizes (litres) and outlets:
    -- { model = 'my_engine', label = 'Engine 7', class = 'engine', type = 'car', cost = 75000, tank = 4000, foam = 300, outlets = 4 },
}

After editing the file on a running server, restart oxide-fire and press Reset to default on Apparatus catalog. That replaces the whole saved list with the file's list.

Config keys: Config.ApparatusCatalog, Config.MaxApparatusPurchase and Config.RefillOnReturn in shared/config/apparatus.lua.

Fires

Fires & Calls

Call generator

Game feedback

Game-style feedback while fighting a fire: points pop up as burning spots go out, mistakes take points away, and a card on the right shows the player's points and how far the fire is from out. See Features for what each player sees.

Points are feedback only. They are never paid and never saved. Salaries stay as they are.

Points

Config keys: Config.FireDifficulty, Config.FireCalls and Config.FireFeedback in shared/config.lua.

Safety

Breathing air (SCBA)

Face piece

Set the face piece to a mask your clothing pack actually has. If you use a clothing script that swaps in a full SCBA outfit, see the oxide-fire:client:scbaMask event in Exports.

Renaming the SCBA item takes effect straight away. The old item name stays usable until the next restart, but no longer does anything. A change to Air per cylinder reaches each firefighter's cylinder at their next refill.

Smoke

Rescue carries

Victim search

The default casualty models are a_m_m_business_01, a_f_y_business_01, a_m_y_hipster_01, a_f_m_bevhills_01, a_m_m_skater_01, a_f_y_tourist_01, a_m_y_genstreet_01, a_f_m_downtown_01, a_m_o_genstreet_01 and a_f_o_genstreet_01.

Config keys: Config.Scba, Config.Smoke, Config.Carry and Config.Rescue in shared/config/safety.lua.

Station Life

Station

Rig checks

Lightning fires

Config keys: Config.Station and Config.Lightning in shared/config/station.lua.

Integration

Framework Compat (advanced)

Each block only applies when that framework or resource is running.

ESX

Job table sync

Changes to job sync fully apply after a restart of oxide-fire. See the ESX guide.

g-multijob

QBCore and Qbox

No settings. Both work through o-link with nothing to switch on.

Config key: Config.Compatibility in shared/config/department.lua.

Settings that stay in the config files

These settings are not in /fire settings and are never stored in the database. The config file is always what the server uses.

To change one:

Times are in milliseconds (1000 = 1 second) and distances in metres, unless noted.

Config.Fire

Config.Fire = {
    renderDistance = 300.0,
    flameDistance = 150.0,
    nativeFireDistance = 60.0,
    maxNodesPerIncident = 35,
    maxNodesTotal = 70,
    maxIncidents = 6,
    -- ...
    spread = {
        enabled = true,
        minHp = 0.6,            -- only points above this share of their strength spread
        minDistance = 1.8,
        maxDistance = 3.2,
        windBias = 0.6,         -- how strongly wind steers the spread (0 = not at all)
        windSpeed = 3.0,        -- m/s used when no weather resource reports wind
        windChance = 0.1,
        rainSlow = 0.7,         -- heavy rain cuts the spread chance by this share
        structureReach = 6.0,   -- a structure fire spreads to unburnt fire points this close
    },
    -- ...
}

Raising the limits costs frame rate. About 35 burning points cost roughly 6% of a player's frame rate, and the game keeps about 128 fires per player.

Config.Fire.hotspot

Each smouldering point is marked with burnt ash on the ground, embers and a faint orange glow, so firefighters can see where to soak it or pull it apart with an axe (see Features). Each player's game draws the marker from the fire it already knows about, so nothing extra is sent over the network, and nothing in it is solid.

Config.Fire.hotspot = {
    enabled = true,
    distance = 60.0,
    maxMarkers = 16,
    decals = {
        { type = 4421, size = 1.8, alpha = 0.85 },
        { type = 4425, size = 1.1, alpha = 0.95 },
    },
    embers = { asset = 'core', name = 'ent_amb_fbi_cinder', scale = 0.8 },
    glow = { color = { 255, 96, 24 }, range = 2.2, intensity = 2.5, height = 0.3, distance = 40.0 },
    prop = false,
    soaked = { asset = 'core', name = 'fire_extinguish', scale = 1.0, ms = 2500 },
    overhauled = { asset = 'core', name = 'ent_dst_wood_chunky', scale = 1.2, embersScale = 1.8, ms = 1500 },
}

Config.FirePresets

The numbers behind each difficulty. The difficulty itself is picked in /fire settings.

The default values are in the difficulty table in Features.

Config.Calls

Config.Tools

The serverRange, reportMs, maxReportsPerSecond and maxIdsPerReport values are anti-cheat limits. Leave them alone.

Config.Apparatus

Config.ApparatusClasses

air = true means the class carries spare SCBA cylinders firefighters can refill from. stash is the size of every unit's equipment compartment.

Config.ApparatusClasses = {
    engine = { label = 'Engine', tank = 3000, foam = 200, outlets = 3, air = true, stash = { slots = 30, weight = 150000 } },
    ladder = { label = 'Ladder', tank = 1000, foam = 0, outlets = 2, air = true, stash = { slots = 40, weight = 200000 } },
    rescue = { label = 'Rescue', tank = 0, foam = 0, outlets = 0, air = true, stash = { slots = 50, weight = 250000 } },
    chief  = { label = 'Chief', tank = 0, foam = 0, outlets = 0, stash = { slots = 15, weight = 60000 } },
    brush  = { label = 'Brush', tank = 1500, foam = 100, outlets = 2, stash = { slots = 20, weight = 100000 } },
}

Units already in the fleet keep the tank, foam and outlet numbers they were created with. Change those per group in the admin panel's Apparatus screen.

Config.Hydrants

Weapon item names depend on your inventory, so the approved gear list carries both spellings: ox_inventory uses WEAPON_FIREEXTINGUISHER and WEAPON_HATCHET, qb-inventory uses weapon_fireextinguisher and weapon_hatchet.

Config.Supply

Config.Hose

The models, hand, sockets, nozzleFallback, couplings and anim values place the nozzle in the hand and the couplings on the caps. Leave them alone.

Config.HudLayout

Most servers keep their own HUD in the top corners of the screen: the player's name, money, job and ID, a server logo, a compass. Chat, notifications and dispatch alerts often sit just below. Fire's on-screen panels start lower down so they leave that space clear:

• Top left: the attack line panel (pattern, water and foam), and the carry, drag and axe panels.
• Top right: the SCBA air ring, with the fire card (points and how far the fire is knocked down) under it.

All four are a percentage of the screen height, so they look the same at every resolution. On a 1080p screen, 1 is about 11 pixels: the default 30 puts the panels about 324 pixels from the top. Allowed: 0 to 90.

If your server's corner HUD is taller and still sits under Fire's panels, raise top. If there is empty space above them, lower it. For example, to start both panels a little higher:

Config.HudLayout = {
    topLeft = { top = 24, side = 3 },
    topRight = { top = 24, side = 3 },
}

The bars along the bottom of the screen (line length and keys) and the markers over the truck and the flames do not move.

With Oxide HUD (free) installed, these values are not used. The HUD knows where its own widgets and minimap are, so it places both panels just clear of them, together with the controls along the bottom of the screen: the keys, the line length bar above them, and the controls admins see while placing points. Each player can drag any of the three to another spot in the HUD editor (/hud), or switch any of them off in game from the editor's Layers tab. While the editor is open, each one shows a sample so the player can see what they are moving. Each corner panel shares its spot with other jobs' panels that use Oxide HUD, and the controls share theirs with other resources' key prompts, since only one shows at a time. Everything Fire draws over the game, the markers over the truck and the flames included, hides whenever the HUD hides: in the pause menu, during a cinematic, while the player is dead or downed, and during character selection. It stays on screen while a Fire menu, the tablet or the phone is open.

Without Oxide HUD (or with an older o-link), the panels sit exactly where these values put them, and the controls stay at the bottom centre. There is nothing else to set up.

Config.UseHudAccent

Fire's on-screen panels (attack line, carry, drag and axe, the SCBA air ring, the fire card, and the keys and line length bar along the bottom) pick up the server's accent colour from Oxide HUD's Config.Theme when it is set. Green, amber and red keep their meaning. Without Oxide HUD, or with no accent set there, the panels keep Fire's own red.

Default true. To always keep Fire's own colours:

Config.UseHudAccent = false

Config.ModelSwaps

If a model is missing from a player's game build, admins on the server get a notification naming the model, and it is written to the console. The notification points here: set the replacement in Config.ModelSwaps in shared/config.lua and restart oxide-fire. Model swaps are not in /fire settings.

Each swap is a row with the shipped model name and your replacement:

Config.ModelSwaps = {
    { from = 'voodoo2', to = 'voodoo' },  -- example: use a different wreck model
}

The hose nozzle (oxide_fire_nozzle), the coupling (oxide_fire_coupling_attack) and the SCBA backpack and belt (oxide_fire_scba_m, oxide_fire_scba_f, oxide_fire_scba_belt) ship in this resource's stream/ folder. If one of those is reported missing, the install is incomplete: check the stream/ folder is there and restart the whole server.

Config.SafetyFx and Config.StationFx

Animations, sounds and screen effects, all from the base game:

• Config.SafetyFx.maskAnim: putting the mask on.
• Config.SafetyFx.pack: the SCBA worn on the back while the mask is on. male and female are the pack models (other peds wear the male one), belt the waist belt, bone and beltBone where they hang (24818 SKEL_Spine3 and 11816 SKEL_Pelvis). The shipped models fit those bones with no offset or rotation; set those only for your own models. hideInVehicles (true) hides them in a seat.
• Config.SafetyFx.warnSound and alarmSound: the head-out sound and the low-air alarm. alarmSound.range (15.0) is how far other players hear the alarm.
• Config.SafetyFx.smoke: the screen effect in smoke, and the cough animation.
• Config.SafetyFx.carry and drag: the carry and drag animations and positions. drag.turnRate (60.0) is how fast A and D turn while dragging.
• Config.SafetyFx.victim: how casualties lie, and hearRadius (10.0), how close a firefighter must be to hear someone trapped.
• Config.StationFx.bell: the station bell sound.
• Config.StationFx.rigCheckAnim: the clipboard animation during a rig check.

Translations

Every message players see is in locales/en.json. To translate: