Installation Guide

Place the resource

Place oxide-police inside your server's resources folder.

Disable the legacy police resource

Do not run qb-policejob or esx_policejob alongside oxide-police. If you are using the Oxide custody system, also disable qb-prison. See the per-framework install guides for the exact disable steps.

oxide-police declares provide 'qb-policejob' so that third-party scripts that check whether a player is handcuffed through exports['qb-policejob']:IsHandcuffed() (a client-side check) keep working after the legacy resource is removed.

Add startup order

Start dependencies before the resource:

ensure ox_lib
ensure oxmysql
ensure screenshot-basic
ensure o-link
ensure oxide-banking    # optional — fine invoicing and department treasury
ensure oxide-dispatch   # optional — powers the MDT Dispatch tab
ensure oxide-police

o-link must start before oxide-police. The oxide-banking and oxide-dispatch lines are optional — leave them out if you do not run those resources. If you do use oxide-dispatch, start it before oxide-police so the MDT Dispatch tab works.

Install the SQL tables

Run sql/install.sql against your database.

The install creates tables for departments, stations, grades, officers, fleet, garages, armory loadouts, uniforms, radio channels, doors, MDT cases, the charge catalog, warrants, BOLOs, criminal records (including fines), mugshots, custody, prisoner job points, the prison shop, treasury transactions, unpaid payroll, the evidence registry, the weapon registry, speed cameras, CCTV cameras, bodycam recordings, and the prison revive point.

If you are upgrading an existing install, run the relevant migration files from sql/migrations/ in order — and only the ones you have not run before. Run each migration once; re-running an ADD COLUMN migration on a database that already has the column will error harmlessly (the column already exists):

Fresh installs only need install.sql — install.sql already includes everything the migrations add.

Register items

Register these item names in the inventory system behind your o-link.inventory adapter. Item registration syntax is framework-specific — see the per-framework guides for copy-paste examples.

If you use ox_inventory (the inventory used by ESX and Qbox servers, and by some QBCore servers), open ox_inventory/data/items.lua and paste these entries into the list. These are the exact names Oxide Police looks for — do not rename them:

['body_cam'] = { label = 'Body Camera', weight = 250, stack = false, close = true },
['police_tablet'] = { label = 'Police Tablet', weight = 250, stack = false, close = true }, -- only if Config.MDT.useItem = true
['police_radio'] = { label = 'Police Radio', weight = 500, stack = false, close = true },
['megaphone'] = { label = 'Megaphone', weight = 1000, stack = false, close = true },
['evidence_camera'] = { label = 'Evidence Camera', weight = 750, stack = false, close = true },
['breathalyzer'] = { label = 'Breathalyzer', weight = 350, stack = false, close = true },
['cctv_camera'] = { label = 'CCTV Camera', weight = 1500, stack = false, close = true },
['prison_food_tray'] = { label = 'Prison Food Tray', weight = 500, stack = true, close = true },
['ziptie'] = { label = 'Zip Tie', weight = 25, stack = true, close = true },
['scissors'] = { label = 'Scissors', weight = 100, stack = false, close = true },
['wheel_clamp'] = { label = 'Wheel Clamp', weight = 2500, stack = false, close = true },
['mouthtape'] = { label = 'Mouth Tape', weight = 50, stack = true, close = true },
['tracking_band'] = { label = 'Tracking Band', weight = 100, stack = false, close = true },
['headbag'] = { label = 'Headbag', weight = 150, stack = true, close = true },
['lockpick'] = { label = 'Lockpick', weight = 100, stack = true, close = true },
['evidence_blood'] = { label = 'Blood Evidence', weight = 50, stack = false, close = false },
['evidence_bullet'] = { label = 'Bullet Evidence', weight = 25, stack = false, close = false },
['evidence_fingerprint'] = { label = 'Fingerprint Evidence', weight = 25, stack = false, close = false },

The handheld radar (WEAPON_RADAR) is a weapon, so it goes in ox_inventory/data/weapons.lua instead — see the next step. After saving, restart ox_inventory (or your server).

If you use qb-inventory (common on QBCore), the syntax is different — see the QBCore install guide for copy-paste entries.

Register the handheld speed radar weapon

oxide-police ships a streamed addon weapon (WEAPON_RADAR) for the handheld speed radar. The model files (w_pi_radar.ydr, w_pi_radar.ytd) and weapon meta files (weapons.meta, weaponarchetypes.meta, weaponanimations.meta, pedpersonality.meta) are streamed automatically from oxide-police/stream/.

You also need to register the weapon as an inventory item for your framework so officers can equip it from an armory loadout. The exact item / weapon-table syntax differs per framework — see the per-framework guides.

The handheld radar only activates when the officer equips WEAPON_RADAR and is on duty. The vehicle radar is independent: vehicles in your fleet must have has_radar enabled (set per fleet entry in /padmin).

Copy item images

Copy the .png files from items/ into the image directory used by your inventory resource.

Common locations:

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

Every image file is named after its item (the body_cam item's image is body_cam.png).

Review configuration

Adjust these files to fit your server:

• shared/config.lua — global settings: salary interval, treasury mode, door hotkey, radar / speedcam units
• shared/config/charges.lua — pre-loaded charges catalog (100 entries)
• shared/config/mdt.lua — MDT permissions, warrant / BOLO defaults, fine caps
• shared/config/custody.lua — jail uniform, locker stash size, prison revive cutscene
• shared/config/interactions.lua — cuffing, escort, search, tackle, hands-up, carry
• shared/config/field_actions.lua — tickets, cuffs / lockpick, ziptie, headbag, station services
• shared/config/field_tools.lua — wheel clamp, mouth tape, tracking band, impound
• shared/config/evidence.lua — evidence types, weapon ballistics, registrable items, GSR
• shared/config/fleet_catalog.lua — vehicles offered in the fleet manager
• shared/config/breathalyzer.lua — drunk-resource integration sources
• shared/config/bodycam.lua / shared/config/cctv.lua — viewer settings
• shared/config/radio.lua / shared/config/megaphone.lua — voice tools
• shared/config/mugshot.lua — mugshot upload endpoint and webhook
• shared/config/prisonerjobs.lua / shared/config/prisonshop.lua — prison economy
• shared/config/objects.lua — placeable scene props
• shared/config/compat.lua — QBCore / ESX / Qbox compatibility shims

Full per-key reference: Configuration.

Make sure your admins can use the admin tools

The admin panel (/padmin) and the admin commands are for your server admins — the people you already trust to run admin tools. A player counts as an admin if they are in a group that has the standard admin permission.

If you have already set up admins for other Oxide resources (or for txAdmin), you are done — they can use these tools too, 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, ESX, and Qbox.

Set up media uploads (FiveManage)

Mugshots and bodycam clips are saved to the cloud through a service called FiveManage, using a single key set in your server.cfg (the text file that holds your server's settings). The same key also powers bait car dashcam clips if you run oxide-baitcar.

The short version: create a free FiveManage account, make a Media token, and add it to server.cfg:

set FIVEMANAGE_MEDIA_API_KEY "your_key_here"

Then restart your server. For the full step-by-step walkthrough (account, team, token, where to paste it), see Setting up FiveManage media uploads.

If you skip this, mugshots and bodycam recordings will not upload, but the rest of the resource works normally.

First-time in-game setup

After SQL is installed, items registered, and the server is running:

1. Join the server with an admin account.
2. Run /padmin to open the admin panel.
3. Create a department. The department name must match a job in your framework (e.g. police, lspd, bcso).
4. Add grades that match your framework's job grades.
5. Add at least one station with a clock-in point.
6. Add radio channels if using the police radio.
7. Add a garage and at least one vehicle to the fleet if testing fleet features.
8. Add custody / prison points if testing the jail flow.
9. Hire a test officer with /phire <serverID> <deptName> <gradeRank>.
10. Have the test officer clock in at the station before testing dispatch, MDT, evidence, fleet, or prison.