Force Register (ForceReg)

Requires players to register on the CAD via a nag screen or freezing them. This can be restricted to specific jobs or ACE permissions.

Activation Guide

1. Download and Install the Resource

This submodule is already enabled by default when installing the Sonoran CAD FiveM resource.

2. Adjust the Configuration

The CAD display settings are stored inside of the /configuration/forcereg_config.lua file.

3. (OPTIONAL) Utilize the Tablet's Auto Link

The tablet resource can be configured to automatically link the user when they login, removing the need for users to manually type this in.

Configuration

forcereg_config.lua

Option	Description	Default Value
captiveOption	The mode to use for telling players to sign up.	Nag
captiveMessage	Message to show to the player.	See Config
verifyMessage	Message to show how to confirm the player registered.	See Config
whitelist.enabled	Restrict forcing registration to only the configured people	false
whitelist.mode	What the whitelist will use to check if a player is whitelisted	qb-core Options: qb-core, esx, ace
whitelist.aces	Ace permissions that will pass the whitelist and will get the ForceReg notifications if whitelist.mode is set to ace.	forcereg.whitelist
whitelist.jobs	QBCore of ESX jobs that will pass the whitelist and get the ForceReg notifications if whitelist.mode is set to qb-core or esx.	police

ACE Permissions

The ACE whitelist is inactive with the shipped defaults (whitelist.enabled = false and whitelist.mode = "qb-core"). To use ACE access, enable the whitelist and set whitelist.mode = "ace". The default whitelist.aces entry is forcereg.whitelist, and the list is configurable; any listed node can pass the whitelist.

For example:

add_ace group.sonoran_cad_linked forcereg.whitelist allow

Grant this node only to the role that should receive ForceReg registration notifications when the ACE whitelist is enabled.

Commands

In-game commands can be used to

• /link Opens the link menu in-game

Modes

In the configuration file, the captiveOption can be set to Nag or Freeze. This changes the behavior of the link menu popup.

Nag Mode

When the captiveOption is set to Nag an in-game text message will display at the top, informing the user to run the /link command to connect to the CAD.

Freeze Mode

When the captiveOption is set to Freeze the link menu will be automatically displayed and users will be unable to close it until they have linked their CAD account.

Link Menu

The link menu displays a code and button to link. Selecting the Link CAD button will automatically open sonorancad.com/id in an external browser, with the code already entered.

If the user is not yet logged into Sonoran CAD in their browser, they must do so first.

After linking, the user will be automatically joined to the CAD community if not already.

Event

This event is sent to the client after the check is completed.

Event: "SonoranCAD::forcereg:PlayerReg"

Parameters:
    identifier: The identifier checked
    exists: true/false, if the identifier is linked to a CAD account