Skip to content

FiveM Integration

PulseCAD connects to your FiveM server through a single resource you download already configured for your community — there's no API key or community ID to paste. Drop it in, ensure it, and your server is talking to the CAD.

The resource is generated on demand for your community (and each of your game servers). It is not a static, checked-in download — every zip is built fresh with your CAD URL, your secret key, your chosen framework, and your enabled features baked in.

What it brings in-game

Feature What it does
Live unit tracking On-duty units appear and move on the dispatch/MDT map in real time
Traffic stops /ts creates a CAD call, puts you on scene, and auto-runs the plate
Panic / officer distress /panic alerts dispatch and every on-duty unit in-game
911 calls /911 (voice), /t911 (text), /a911 (anonymous) route to dispatch
Plate lookup /plate returns a vehicle + flags in chat (no Wraith needed)
ALPR Wraith ARS 2X plate scans are checked against your records → in-game alert
Account linking /cadlink ties a player's game account to their CAD account
Civilian ID /civid, /id, /giveid show a character's ID card in-game
Vehicle registration /reg registers the vehicle you're in to your CAD character
CAD Display (tablet) The full CAD as an in-game tablet/MDT — press F7, auto-logged-in
Active-call blips + GPS routing On-duty officers see live call blips; assigned calls auto-route your GPS
Discord Rich Presence Your callsign, status, and active call show on your Discord status

Many of the above are toggleable per community in Admin → FiveM, along with optional extras (auto-fines, force-registration, station alerting, body cam, mugshots, NPC witness callers, and more). These advanced / immersion extras are off by default - admins opt in per feature. Auto-fines (deducting a CAD citation from the player's in-game bank) in particular starts off. See the full in-game command list.

Install

  1. In the CAD, open Admin → FiveM and click Download. The ZIP is generated on the spot, pre-keyed to your community (and the selected server).
  2. Extract the pulsecad folder into your server's resources, e.g. resources/[pulsecad]/pulsecad.
  3. In server.cfg, after your framework and oxmysql lines, add: 
    ensure pulsecad
  4. Restart the server. On boot you'll see: 
    [pulsecad] framework = esx
[pulsecad] ready -> https://cad.mypulsetech.com | livemap=true alpr=false | type / in chat for the full PulseCAD command list

Keep your key server-side

Your secret API key lives in server/secret.lua, which loads only as a server script. It is what identifies your server to the CAD — treat it like a password. Never move Config.ApiKey into config.lua or a client script; that would expose the key to every player. config.lua is a shared script and never contains the key.

One key per game server

Each game server gets its own key. If you run multiple servers, download a separate resource for each from Admin → Servers (or pick the server in the FiveM tab). You can rotate a key at any time from Admin → FiveM — re-download the resource afterward.

Live tracking and the civilian/officer features identify a player by their in-game license. Each person links once, and they do it themselves - there is no link-code generator on the Admin → FiveM panel:

  1. In the CAD, open the Portal and press Link Your Game (or on your MDT login card / Options → Link FiveM Game) to get a one-time code.
  2. In-game, type: 
    /cadlink <code>
  3. Go on duty in the MDT — you now appear on the live map.

The code is one-time and expires in 10 minutes. After linking once, it persists.

Requirements & frameworks

  • Networking: the game server makes outbound HTTPS calls to the CAD — no inbound ports to open. Your server just needs to reach https://cad.mypulsetech.com.
  • Frameworks: works standalone, and with ESX, QBCore, and QBox. The download config defaults to auto-detect; set it explicitly in Admin → FiveM if you prefer. (Framework is only needed for money-based features like auto-fines and job-based force-registration.)
  • ALPR: requires Wraith ARS 2X (wk_wars2x). The hook is inert without it. See ALPR.
  • Body cam / mugshots (optional): require screenshot-basic. If you enable either, ensure screenshot-basic before ensure pulsecad.

Updating

There are two independent update paths:

Live config reload (no restart).
When you change settings in Admin → FiveM (or press Push update), installed servers re-pull the restart-free config within about 10 seconds — feature on/off toggles, smart-sign targets, live-map interval, and disconnect grace all apply in place. Command words and keybinds are registered when the resource starts, so renaming a command needs a re-download + restart.
New resource version (code changes).
FiveM does not allow a resource to rewrite its own .lua/.js files at runtime, so there is no in-game code auto-updater. When a newer resource version ships, an installed server can detect it (the boot version vs. the CAD's current version), but updating the code means re-download the zip from Admin → FiveM, replace the pulsecad folder, and restart. Your key and settings are preserved because they're generated fresh into the new download.

For developers editing the resource

The resource version lives in RESOURCE_VERSION (server/fivem/resource.ts). Bump it on any change to the generated resource so installed servers can tell they're out of date.

Next