⚙️Configuration

Check the instructions below.

All configuration options are located in config.lua.

Framework

Field	Description	Example Value
Framework	Server framework. Options: new-qb, esx, old-qb	"new-qb"

Police Job Names

Field	Description	Example Value
PoliceJobNames	Jobs allowed to use handcuffs.	["police", "sheriff"]

Commands and Timers

Field	Description	Example Value
Command	Command to open the electronic menu.	"emenu"
UpdateTime	Interval for updating electronic cuffs (seconds).	1
Minigame	Enables a minigame for cuffing.	false

Menu Dialogs

Define actions available in the electronic menu:

Config.MenuDialogs = {
    title = "Cuff Type",
    items = {
        [1] = {
            header = "Soft Cuff / Uncuff",
            description = "Soft cuff is a soft cuff",
            callback = "gfx-cuffsystem:client:SoftCuff",
        },
        [2] = {
            header = "Hard Cuff / Uncuff",
            description = "Hard cuff is a hard cuff",
            callback = "gfx-cuffsystem:client:Hardcuff", 
        },
        [3] = {
            header = "Drag / Undrag",
            description = "Control the person you cuffed",
            callback = "gfx-cuffsystem:client:DragUndrag",
        },
        [4] = {
            header = "Put / Out of Vehicle",
            description = "Control the person you cuffed",
            callback = "gfx-cuffsystem:client:PutOutOfVehicle", 
        },
    }
}

Items and Animations

Item	Description	Example Values
handcuffs	Configures soft and hard cuffing.	Animations for player and target.
electroniccuff	Configures electronic cuffs.	Animations for player and target.
headbag	Reserved for headbagging.	Empty by default.

Notifications

Customize notifications for various actions:

Config.Notifications = {
    ["cuffedabt"] = "Cuffed about ",
    ["shock"] = "Shock",
    ["uncuff"] = "Uncuff",
    ["gps"] = "GPS",
    ["electroniccuffs"] = "Electronic Cuffs"
}

---

How to Use

Basic Features

1. Open the Menu Use the /emenu command to access the electronic menu.

2. Choose Cuff Type

   • Soft Cuff: Allows limited movement.

   • Hard Cuff: Restricts all actions.

3. Advanced Actions

   • Drag or undrag a player.

   • Place or remove a player from a vehicle.

4. Electronic Cuffs

   • Track players using GPS.

   • Apply shocks if necessary.

---

For Developers

Exports

Client-Side

• Use the provided callback functions for custom integrations:

  • gfx-cuffsystem:client:SoftCuff

  • gfx-cuffsystem:client:Hardcuff

  • gfx-cuffsystem:client:DragUndrag

  • gfx-cuffsystem:client:PutOutOfVehicle

Server-Side

• Integrate with your framework for logging or additional actions.