Installation Guide

Place the resource

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

Disable the ambulance job that came with your framework

Do not run qb-ambulancejob, esx_ambulancejob or qbx_ambulancejob alongside oxide-ems. See the per-framework guides for the exact steps.

oxide-ems declares provide 'qb-ambulancejob' so that scripts checking whether that resource exists keep working after it is removed.

Qbox is the exception in one respect: leave qbx_medical running. On Qbox, qbx_medical remains in charge of the downed and dead state, and oxide-ems layers the ambulance job on top of it. Only qbx_ambulancejob is removed.

Add startup order

Start dependencies before the resource:

ensure ox_lib
ensure oxmysql
ensure o-link
ensure oxide-medical
ensure oxide-banking    # optional — treasury accounts and patient invoices
ensure oxide-dispatch   # optional — delivers EMS alerts to a dispatch board
ensure oxide-radio      # optional — department radio channels
ensure oxide-ems

o-link must start before oxide-ems. If a required resource is missing, oxide-ems prints an error in the server console naming exactly which one and refuses to initialise.

Install the SQL tables

Run sql/install.sql against your database.

The install creates tables for departments, facilities (with their placed interaction points), grades, medics, garages, the vehicle fleet, uniforms, radio channels, the supply shop catalog, treasury transactions and unpaid payroll. It also creates the shared oxide_settings table, which is where your settings live once the server has booted once.

If you are upgrading from an earlier pre-release build, run the 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:

Fresh installs only need install.sql — it 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.

These four are the items oxide-ems itself looks for. Images for all four ship in itemimages/, along with antacid.png, antibiotics.png and antiviral.png for the oxide-medical cure items.

The revive and stabilize item. Medics need one item to revive or stabilize a patient. By default this is your framework's existing first-aid item — firstaid on QBCore and Qbox, medikit on ESX — so on a stock server there is nothing extra to register. Change it (or remove the requirement) under Field Care in /ems settings.

The medical bag's default contents. Using a medical_bag unpacks it into:

The last row is not a fixed name. With Include first-aid item switched on (the default), the bag adds whichever first-aid item your framework already ships, so the same default list works everywhere. Turn it off under General → Medical bag in /ems settings if you would rather list one yourself.

Anything in that list your inventory does not recognise simply won't be handed over, and the medic is told some supplies didn't fit. Edit the list under General → Medical bag in /ems settings to match the items your server actually has.

Copy item images

Copy the .png files from itemimages/ 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 medical_bag item's image is medical_bag.png).

Restart the whole server

Not restart oxide-ems — a full server restart.

oxide-ems streams the stretcher prop, and streamed props are registered when the server starts. Restarting only the resource leaves the stretcher invisible or missing for everyone who was already connected. This applies to the first install and to any future update that changes the streamed files.

Review configuration

Almost nothing in oxide-ems is configured in files. On first boot, the values in shared/config.lua and shared/config/ are copied into the oxide_settings database table, and from then on the database is what the server reads. Edit settings in-game with /ems settings, where changes save and apply immediately.

The config files remain useful for two things: they seed a fresh install, and they are the "reset to default" target in the settings editor.

The full per-setting reference is in Configuration.

Everything else — departments, facilities, interaction points, grades, garages, the fleet, uniforms, radio channels and the supply shop catalog — is created in-game through /ems admin and stored in the database. There is no list of hospitals to edit.

Make sure your admins can use the admin tools

The admin panel (/ems admin), the settings editor (/ems settings) 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 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 (the text file that holds your server's settings). 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.

First-time in-game setup

After the SQL is installed, items are registered and the server has fully restarted:

1. Join the server with an admin account.
2. Run /ems admin to open the admin panel.
3. Create a department. The department's internal name must match a job in your framework (for example ambulance). The display label is what players see.
4. Add grades. Give at least one grade the boss flag so somebody can open the management desk.
5. Add a facility — a hospital for emergency work, or a doctor's office for walk-in appointments.
6. Place at least a clock-in point on it. Add beds, lockers, a management desk, a supply counter, a reception desk, x-ray machines and operating tables as you want them.
7. On a hospital, place a respawn point so players who give up respawn there.
8. Add a garage and at least one spawn bay if you want a fleet, then add vehicles.
9. Add supply shop items so medics have somewhere to restock.
10. Hire a test medic with /ems hire <serverID> <deptName> <gradeRank>.
11. Have the test medic clock in at the facility before testing anything else.

The panel shows a setup checklist per department that ticks off ranks, a facility, a clock-in point, a garage and a spawn bay as you complete them.

Step-by-step walkthrough: Admin.