Admin Settings

Onboarding & FiveM Integration

Server Files & Keys is where the CAD and your FiveM server are wired together. It is also the page with every secret your community has on it.

The resource package

FiveM Resource Package downloads the server resources with your community's keys already injected. That is the only supported way to install them.

Cloning the public repository and starting it yourself gives you a resource with no keys in it, which will not connect. The download is what makes it yours.

Install it the way the setup block on that page describes, and start it in your server.cfg.

Your own settings

A few things are set in config.lua inside the resource package rather than in the dashboard: the plate reader switches, the weapons that should never trigger a shots-fired report, the folder name of your emote or phone resource. Every new download replaces that file, so a change you make there lasts only until your next update.

To keep a change, put it in config-custom.lua in a resource of your own, lux-cad-custom, which no download contains. Write only the lines you change:

Config.WkAlprAutoLock = false
Config.WitnessIgnoredWeapons = { "WEAPON_PAINTBALL" }

The resource itself is three small files, on Custom Emote Config. It also holds your own animations; if you only want settings, leave its animations file as it is.

• Start it above lux-cad in server.cfg: your settings are read once, when lux-cad starts.
• After a change: restart lux-cad-custom, then restart lux-cad.
• The server console confirms it. At start-up it lists the settings it took from your file — and when it took none, it says why: a typo in the file, the resource started after lux-cad, or the file missing from files in its fxmanifest.lua. A file with an error is not applied at all, so LUX never runs with only half of your settings.
• Every player can read the file. Never put a key or password in it. ComId and the connection settings come from your download and cannot be changed from it.

The credentials

Rotating a key invalidates the old one. Rotate when it has leaked, then re-download the resource package so your server has the new value. A rotated key with an old package installed is a server that has stopped talking to the CAD.

The panel shows whether the radio key has been used recently, which is the quickest way to tell a configuration problem from a quiet night.

LUX-streets (Roxwood add-on)

The lux-streets resource is a separate, key-less add-on with its own download. It supplies the street names the HUD uses for locations in Roxwood, so postal and street lookups match what players see in-game.

Community API

Under Community API you manage the key that lets your own tooling read and update your community's data — units, incidents, reports, characters, vehicles, civilian services and more — over HTTPS.

One active key per community. Rotating replaces the value; revoking lets you issue a new one. Either takes up to a minute to take effect, because the gateway caches the lookup briefly.

The full reference, with every endpoint and field, is the public API documentation at docs.lux-cad.com. It is written for the developers building against it rather than for this handbook.

Migrations

Migrations is where you open an import window so your players can bring characters across from another CAD. It is a window you open and close rather than a one-off action — while it is open, players see an import button in their character list. See Characters.

Getting a community in the first place

Deploying a new community is invite-only during the pilot: you join the LUX CAD Discord, request access, and get walked through onboarding. That is a conversation rather than a form, which is why there is no self-service button for it.