Configuration Reference

Reference for the shipped oxide-police config files and DB-backed settings.

Use /police settings for resource-wide settings. On first boot, the current config-file values are seeded into oxide_settings; after that, the database is the source of truth and file values are factory defaults used by reset-to-default and new-key backfill. Departments, stations, grades, garages, armories, uniforms, channels, detention points, and placed cameras remain in their existing admin/database workflows under /police admin.

SpeedCam.Models, FleetCatalog, and PlaceableObjects.props contain locale-baked labels. Those labels are frozen into the database when their top-level key is first seeded. After changing ox:locale, delete the corresponding oxide_settings rows and restart oxide-police to seed the new labels (this also discards saved edits to those keys):

DELETE FROM oxide_settings
WHERE resource = 'oxide-police'
  AND setting_key IN ('SpeedCam', 'FleetCatalog', 'PlaceableObjects');

shared/config.lua

Global

Doors

Speed unit

Radar

CitizenEmail

Controls outbound auto-emails sent to citizens via olink.phone / oxide-phone after a speed camera catch or a field citation. The From strings use a single %s substitution that is filled with the department name (e.g. traffic@lspd.gov).

SpeedCam

shared/config/bodycam.lua

Bodycam recording

Officers actively watching another officer's feed can capture clips that upload to Fivemanage or post to a Discord webhook. Recording happens on the watcher's machine — wearers never produce frames themselves. Native game audio cannot be captured from the browser layer; only mic and page audio are recorded.

Fivemanage uploads require the FIVEMANAGE_MEDIA_API_KEY convar (the same key used by the mugshot pipeline).

shared/config/breathalyzer.lua

The breathalyzer reads BAC from your drunk system. Edit Config.Breathalyzer.sources to plug in whichever resource your server uses; the first source that returns a numeric value wins.

Source descriptor types:

• { type = 'metadata', key = '<key>' } — character metadata via o-link
• { type = 'export', resource = '<res>', fn = '<fn>' } — server-side export
• { type = 'client_export', resource = '<res>', fn = '<fn>' } — client-side export
• { type = 'client_callback' } — registers oxide:police:client:reportBac for adapter use

shared/config/cctv.lua

shared/config/charges.lua

Config.DefaultCharges is the seed catalog imported into the police_charges_catalog table the first time the resource starts with an empty catalog. It ships with 100 entries spanning traffic infractions (1xx), traffic misdemeanors (2xx), public order (3xx-4xx), property (5xx), violent (6xx), weapons (7xx), drugs (8xx), financial (9xx), and miscellaneous (10xx).

Each entry has:

After first import, charges are managed through the MDT's Catalog tab (admin only). Editing this file does not retroactively modify the database; use the MDT to update charges already in the catalog.

shared/config/compat.lua

Per-framework compatibility shim toggles.

Global

Config.Compatibility['qb-core']

Config.Compatibility['g-multijob']

Config.Compatibility['es_extended']

shared/config/custody.lua

Per-station jail config (jail cells, stripping mode, holding cells, mugshot booth) lives in the database and is set through /police admin. This file holds resource-wide constants only.

shared/config/evidence.lua

Tracing a casing back to a gun

With includeWeaponSerial on, a spent casing records the serial of the weapon that fired it. When an officer collects the casing, the evidence locker shows the serial and the name it is registered to, and the same serial can be looked up in the MDT's Weapons tab.

The serial is worked out on the server from the weapons the shooter is actually carrying, so a modified game client cannot invent a serial or hide its own. Two situations deliberately record no serial rather than guess:

• the shooter is carrying two of the same model with different serials, or one of them has no serial at all — there is no single right answer;
• the weapon isn't an inventory item, which is how some frameworks handle weapons.

Turn includeWeaponSerial off if your server doesn't use weapon registration. Casings collected before you turned it on simply show no serial; nothing breaks.

Sealing evidence lockers when a case closes

Every case gets its own evidence locker, and by default those lockers stay open forever — including for cases closed years ago. Turning on locker.sealOnCaseClose means that closing a case seals its locker: officers can still see everything inside from the evidence screen, but the locker itself will not open, so nothing can be added, removed or swapped after the fact.

Reopening the case unseals the locker again, and the contents are untouched throughout.

This is off by default, so updating changes nothing. Turn it on deliberately — officers used to closing a case and then reaching back into the locker will notice.

To reclaim the space, an admin can permanently empty a sealed locker with /police purgeevidence (see the admin guide). That destroys the contents and cannot be undone, which is why it is admin-only and why the locker has to be sealed first.

Excluding players from evidence drops (EvidenceIsDropExempt)

Config.Hooks.EvidenceIsDropExempt runs client-side before any drop is sent. Return true and the local player leaves no bullet casings, blood, or vehicle fingerprints. Use it to exempt minigames or other special states with your own resource's exports:

Config.Hooks.EvidenceIsDropExempt = function()
    if exports['pug-paintball']:IsInPaintball() then return true end
    return false
end

shared/config/field_actions.lua

Tickets

Carry

Headbag

Cuffs

Ziptie

StationServices

shared/config/field_tools.lua

WheelClamp

Letting tow drivers remove clamps. By default only police touch wheel clamps, so a clamped car stays clamped until an officer is free. externalJobs lets you name other jobs that may help, keyed by the job name your framework uses:

externalJobs = {
    ['tow']      = { allowApply = false, requireOnDuty = false },
    ['mechanic'] = { allowApply = false, requireOnDuty = true },
},

These jobs remove clamps through their targeting menu (aim at the clamped vehicle) or the externalCommand chat command, which is there for servers running no targeting script.

MouthTape

TrackingBand

Impound

Want impounded cars sent to your own impound/garage system? See Custom Impound.

shared/config/fleet_catalog.lua

Shipped categories: Patrol, Pursuit, Tactical, Motorcycle. cost is both purchase price and replacement cost when added to a department.

shared/config/interactions.lua

Cuffing

Escort

Search

Vehicle

Tackle

HandsUp

Tap vs hold. Tapping the key puts the player's hands up standing, exactly as before. Holding it past HoldThreshold drops them to a knee instead. Either pose counts as "hands up", so officers can still search, cuff and use field tools on a kneeling suspect.

With KneelSticky on (the default), the kneel stays put once you let go of the key and clears on the next tap — nobody wants to hold a key down for a whole traffic stop. Set it to false if you would rather releasing the key stand the player back up.

If you swap the animation, keep the flag at 1. The standing pose uses flag 50, which only moves the upper body — reuse it on the kneel and the player stays standing and just waves their arms.

OfficerTargetMenu

Powers the on-duty officer's contextual ox_target options on other players plus the /cuff and /uncuff chat commands. Each action is toggled with its own enable flag and shows a FontAwesome icon. The cuff, search, and escort options are on by default; every other action is off by default. Options only appear when they make sense (for example, take-out-of-vehicle shows only for a cuffed suspect who is seated in a vehicle). Because aiming at a seated suspect actually hits the vehicle's body or glass, "Take Out of Vehicle" also appears when you third-eye the vehicle itself while it has a restrained occupant — no need to catch the ped through a window.

Sounds

CuffedDisabledControls

shared/config/licenses.lua

License types offered in the MDT person profile's Licenses tab. IDs are passed straight to olink.license.*, so each id must also exist in the framework's licenses table (e.g. on ESX, as a row in the licenses table) for native UIs to label it.

Default shipped licenses: Driver's License, Weapons Permit, Business License, Pilot's License, Boating License. Add new entries or remove existing ones to match the licenses your server uses.

shared/config/mdt.lua

The MDT's charge-catalog editor (the Catalog tab) is not grade-based — it is only available to server admins (the admin permission, the same one that gates /police admin — see Admin → Permissions).

Adjusting jail time before booking

When allowJailOverride is on, the jail total in the Charges tab and the station booking panel becomes an editable field instead of a fixed label. The officer can raise or lower it — for time served, a plea deal, or a booking that got interrupted — up to limits.maxJailPerCall. Setting it to 0 books the arrest and its fine with no jail time at all.

Two things to know:

• The charge records never change. Each charge keeps the jail time from the catalog; only the sentence actually served is adjusted. Every adjustment is written to the department activity log and the server log with the original total, the new total, and the officer who made the change.
• The rule is enforced on the server. Hiding the field with allowJailOverride = false, or restricting it with permissions.overrideJail, cannot be bypassed by a modified client.

Turning individual MDT tabs off

Config.MDT.modules has one true/false per tab. Leaving it alone changes nothing — every tab defaults to on.

A disabled tab disappears from the navigation for every officer and its server actions are refused, so it cannot be reached by a modified client. If you disable the tab an officer is currently on, the MDT opens on the first tab that is still enabled.

Turning off charges only removes the MDT's arrest tab — booking a suspect at a station still works.

dispatchEnabled above still works and is treated as modules.dispatch when you haven't set that key, so existing configs need no changes.

shared/config/megaphone.lua

shared/config/mugshot.lua

Requires the convar:

set FIVEMANAGE_MEDIA_API_KEY "your_key_here"

Setting up FiveManage media uploads

Three features in this resource save pictures and video to the cloud so officers can view them later:

• Mugshots — booking photos taken during arrests
• Bodycam clips — short video recordings captured while watching an officer's feed
• Bait car dashcam clips — video from the oxide-baitcar resource (these upload through this resource's pipeline)

All three use a service called FiveManage to store the files. You only need one FiveManage key, and that single key powers all three features. The key is not set in any config file — it lives in your server.cfg (the text file that tells your server which resources to start and holds your server's settings).

Follow these steps once:

set FIVEMANAGE_MEDIA_API_KEY "the_token_you_copied"

shared/config/objects.lua

Shipped props: do-not-cross barrier, A-frame barrier (with and without lights), road-work-ahead barrier, traffic barrier (with and without lights), traffic cone, taller traffic cone, traffic road pole, unmarked traffic cone, spike strip.

shared/config/prisonerjobs.lua

Mining

Cleaning

Electrical

shared/config/prisonshop.lua

The shop location, meal windows, and paid catalog are admin-configured through /police admin → Detention → Prison Shop. Until a location is placed, the shop is dormant.

Next Steps