Spartan Software Docs
Installation

In-game Resource

Install SpartanCAD for FiveM and use current CAD, civilian, unit, ALPR, and ERS controls.

Install: POC or Server Administrator

SpartanCAD hosts your community records. The FiveM resource connects your server to that community and provides the in-game CAD window and optional vehicle screens.

  1. Download the current SpartanCAD resource from your customer downloads.
  2. Extract the spartancad folder into your server's resources directory.
  3. Open Admin Panel > FiveM Integration in your CAD community. Enable FiveM Integration and the resource features your community uses.
  4. Under Resource Authentication, choose Copy Configuration and place that configuration in server.cfg before starting the resource:
set spartancad_community_id "YOUR_COMMUNITY_ID"
set spartancad_key "YOUR_GENERATED_KEY"
ensure spartancad
  1. Start or restart spartancad and confirm your server appears in Detected Servers.
  2. Join FiveM, run /cad, sign in, and select the same community.

Keep the generated key in server.cfg, using set. Do not put it in shared config.lua or use setr for it. If you regenerate the key, replace it in server.cfg and restart the resource; the previous key stops working immediately.

Open, Close, and Move CAD

Use /cad or the default F6 binding, named Open Spartan CAD in FiveM keybind settings. In a configured vehicle, this opens screen interaction unless you have chosen the tablet preference. On foot or in an unconfigured vehicle, it opens the normal CAD window.

Press Escape to leave CAD; an open menu or form may consume the first press. /movecad opens move mode for the popup window: drag to move, use the mouse wheel to resize, and press Escape to save. It does not calibrate a mounted vehicle screen.

Drivers cannot open CAD above the configured speed limit (30 MPH in the current demo configuration). This check also applies when a driver prefers the tablet. Stop the vehicle before testing.

For mounted screens, tablet preference, look around, and POC setup, see 3D CAD Screens.

Player Commands

Commands below are entered in chat. Default keybinds can be remapped in FiveM settings.

CommandWhat it does / requirement
/cadOpen or close CAD; switches back to CAD if the ALPR frame is active.
/cad disable3dSave a local preference to use the popup CAD in vehicles. Run /cad to open it if closed.
/cad enable3dSave a local preference to use supported 3D screens. Close and reopen CAD to apply it.
/cad 3dstatusShow your saved display preference.
/cadlookToggle look around during an active streamed vehicle-screen session; default key is Left Alt.
/movecadMove and resize the popup CAD.
/registervehRegister or update your current vehicle for the civilian selected in the in-game Civilian Portal.
/setmugshotSet the selected civilian's mugshot from your current player character.
/syncidsLink your current FiveM identifiers to the CAD account after signing into the in-game MDC.
/trafficstop [description]Create a traffic stop and attach your on-duty unit. Clear your current call first.
/attach [call number]Attach your on-duty unit to a call. Include the intended call number.
/status ONDTGo on duty after MDC sign-in. Also accepts ARRVD, AVAIL, BUSY, and OFFDT; ARRVD requires an attached call.
/gpsSet a game waypoint to your attached call when its location can be resolved.
/911 [details]Report an emergency from the civilian selected in the in-game Civilian Portal. Details are required.
/alprToggle automatic plate scanning when enabled by the POC.
/alpruiOpen or close the Plate Detector display in a vehicle. This command name is configurable.
/alprscanRequest a manual scan, subject to the scanner's requirements.
/alprloadout [name]Select a configured camera loadout; omit the name to list available loadouts.

Settings for POCs

Edit the supplied configuration files for your community. Demo values may differ from your downloaded release.

FileSettings you may need
config.luaOn-foot tablet animation, popup frame style (tablet or html), notifications, and debug output.
client/plugins/spartan_3dScreen/3d_screen_plugin_config.luaEnable screens, driver opening speed limit, preview behavior, tablet preference, and look-around binding.
client/plugins/spartan_3dScreen/vehicles.jsonSaved vehicle screen placements and camera views. Back up your customized file before replacing a resource version.
client/plugins/spartan_postals/postals_plugin_config.luaPostal set (new, ocrp, old, oulsens, or custom), custom file, and lookup interval.
client/plugins/spartan_livemap/livemap_plugin_config.luaEnable live locations and set fallback update/stale timings. Community FiveM Integration settings also control live map behavior.
client/plugins/spartan_alpr/alpr_plugin_config.luaDuty/vehicle restrictions, camera loadouts, scanning range, target filters, alert reasons, and display options.
client/plugins/spartan_ers/ers_plugin_config.luaOptional ERS records, mugshots, call creation/closure, and import failure notices.

CAD notifications support chat, ox_lib, or none. Start ox_lib first if selected; FallbackToChat controls the fallback. Config.FrameStyle changes the popup frame, while vehicle screens have their own placement.

Live Map and Unit Commands

Sign into the MDC inside FiveM, choose a callsign and department, and go on duty. Check Live Map Sync, Player Discovery, MDC Unit Commands, and CAD Call Events in the community's FiveM Integration panel as appropriate. A browser-only login does not establish the in-game unit session.

ALPR

The Plate Detector offers detections, hits, camera loadouts, and Search CAD for plate returns. Opening its display with /alprui and toggling scanning with /alpr are separate actions. The current demo requires MDC duty for scanning; the POC can also require an emergency vehicle or the driver's seat.

Camera direction, range, plate visibility, target type, occupancy, and speed limits can prevent a capture. A manual scan does not remove those requirements. Alert reasons can include stolen, BOLO, wanted, suspended/revoked, expired, uninsured, and unregistered records. The POC can separately enable clear and no-hit returns.

Search CAD opens a plate lookup when available for the detection. ERS integration can supply records for supported AI traffic; without it, AI traffic has more limited ownership/record information.

ERS

Enable this optional plugin when using a supported Night ERS installation; the current configuration specifies minimum version 1.8.16. Settings control first-interaction records, mugshots, offered and accepted calls, traffic stops, and whether calls close when the corresponding activity ends. The plugin can suppress ERS's own ID and vehicle information displays when CAD supplies those returns.

Troubleshooting

IssueCheck
Resource does not connectCopy both generated community values from FiveM Integration, check that integration is enabled, and restart after a key change.
Player can view the website but unit commands failSign into the MDC inside /cad, select a department/callsign, and go on duty.
/registerveh, /setmugshot, or /911 failsSelect a civilian in the in-game Civilian Portal first; vehicle registration also requires being in a vehicle.
/trafficstop fails while on dutyClear from the currently attached call first.
/gps has no destinationAttach to a call with coordinates or a resolvable postal.
Vehicle screen is visible but cannot be clickedFollow the focus and look-around checks in 3D CAD Screens.
No ALPR capturesCheck duty, enabled scanning, camera loadout, vehicle restrictions, visibility, and range.

For a support check, /cadtextures reports configuration status and /cadtextures reload reloads the vehicle screen configuration. /ersstatus reports ERS integration status. /alprdebug toggles scanner diagnostics; /alprclearunregistered PLATE clears that plate's cached unregistered alert state. These are troubleshooting controls, not routine player setup.

On this page