Configure

Requirements

FS-Lib

Optional integrations:

QBox, QBCore, ESX, or NAT2K15 for framework jobs
SonoranCAD for unit, department, and availability data
LUX CAD for active-unit and department data

Installation

Copy the FS-Scoreboard resource folder into your server's resources directory.

Start FS-Lib before FS-Scoreboard in server.cfg:

ensure FS-Lib
ensure FS-Scoreboard

Configure public options in config.lua. Configure the optional Discord webhook in the server-only server_config.lua file.

Restart the server or restart FS-Scoreboard from the server console.

General settings

Prop

Type

Players can always use roster search, service quick filters, and the configured sort. Theme and grouping choices are stored per player through FiveM KVP storage.

Source modes

Mode	Data source
`standalone`	Basic player list without CAD or framework jobs
`framework`	QBox, QBCore, ESX, or NAT2K15 jobs
`sonoran`	SonoranCAD units only
`sonoran_hybrid`	SonoranCAD first, then framework jobs as fallback
`lux`	LUX CAD active units only
`lux_hybrid`	LUX CAD first, then framework jobs as fallback

Legacy source aliases such as hybrid are still accepted but should be migrated to sonoran_hybrid or lux_hybrid.

Framework jobs

Config.FrameworkJobs.Framework = "auto" detects qbx_core, qb-core, es_extended, or the configured NAT2K15 resource. Set it to qbox, qb, esx, or nat2k15 to force a provider.

Use ServiceJobs and TypeCategories to map jobs into law, fire, ems, or dispatch. Jobs listed in CivilianJobs are shown as civilians. Labels can override framework job names shown on the roster.

LUX CAD

LUX modes use the server-only lux_api_key convar:

server.cfg

set lux_api_key "YOUR_LUX_API_KEY"

Set Config.Source to lux or lux_hybrid. The active-unit cache refreshes internally every 30 seconds and matches players by Discord identifier.

Testing status

LUX CAD support has not yet been fully tested against a live LUX CAD installation. Please report incorrect matching, department, or availability behavior.

SonoranCAD

Set Config.Source to sonoran or sonoran_hybrid and configure the SonoranCAD connection used by FS-Lib. Config.DepartmentAliases maps CAD abbreviations to the display names used on the roster.

Streamer mode

config.lua

Config.StreamerMode = {
    Mode = "optional", -- "off", "optional", or "enforced"
    Default = false,
    NameMode = "all", -- "none", "civilians", or "all"
    HideServerIds = true,
    HideCallsigns = true,
    HideConnectionInfo = true
}

Optional mode lets each player save their preference. Enforced mode applies masking to everyone. Masked aliases remain stable while the roster is open.

Presentation only

Streamer mode changes what the UI renders. The original player data still reaches the local NUI, so it is not an authorization or data-security boundary.

Civilian services

Civilian services replace the old flat custom-job settings while keeping /setjob:

config.lua

Config.CivilianServices = {
    Command = "setjob",
    PermissionEnabled = false,
    Permission = "fs_scoreboard.setjob",
    Services = {
        "Tow",
        {
            Name = "Taxi",
            Permission = "fs_scoreboard.setjob.taxi"
        }
    }
}

A string entry such as "Tow" has no service-specific permission. Use the expanded table form only when a service needs its own ACE. When PermissionEnabled is true, players need the global ACE and the selected service's ACE, if one is configured.

server.cfg

add_ace group.admin fs_scoreboard.setjob allow
add_ace group.taxi fs_scoreboard.setjob.taxi allow

The service list and command suggestion only show choices available to that player.

Commands

/scoreboard toggles the scoreboard UI.
/setjob list shows the civilian services available to you.
/setjob <service> selects a civilian service.
/setjob clear removes your civilian service.

If Config.CivilianServices.Command is changed, replace /setjob with that command.

Keybinds

The default GRAVE key mapping is the backtick/tilde key. Players can change it in Settings → Key Bindings → FiveM.