Configuring this resource

We've made it as simple as possible to configure oCustodyBundle

Our Config.lua file contains all customisable options to make your initial configuration of oCustodyBundle as simple as possible. Many of the values are accompanied by comment lines where needed but you can find the options below with details.

Debugging & Version Checking

These settings are useful to server owners and developers as they allow you to ensure your resource is the most up-to-date version of the script as well as toggle the debugging prints which will be useful to locate an error or where something is not going right.

If you are opening a ticket, the team will ask for your debugging logs.

Framework

We wanted to make sure that any server could make use of the Custody Bundle including public servers who make use of popular FiveM frameworks. At present, we support any of the frameworks listed below to ensure that actions are restricted to jobs. If you don't want to restrict actions, leave this as "standalone".

Supported Frameworks

• oEssentials by OMSolutions

• Policing Essentials by BKing Development

• QBCore

• ESX

Allowed Jobs

You are only required to provide the names of jobs in this table if you are using "QBCore" or "ESX", please ensure these are the exact job names that you have specified in your configuration for the framework.

FMS Integration

If your server makes use of the FMS system by Albo1125 we have introduced a way for CADs to be automatically generated on the system if the custody panic button is activated.

Sound Control

In this section, you will be able to control the volume and radius of the various sounds used by the script to ensure that they are only heard when the user is close to the activating source for that sound. This is extremely useful if you want to make use of custom sounds and adjust the outputted volume around the station.

If you want to adjust the value of that radius in which players are notified of a custody alarm being activated, we suggest you modify the value of CustodyAlarmNotifyRadius this must always end with a decimal.

Commands & Keybinds

We have multiple commands which work with the system to allow users to interact, you can change these here to prevent overlapping or create your own experience for players. As well as this, you can allow them to set their own custom keybinds within FiveM for these commands by setting the value of AllowKeybinds to true.

Buzzer Doors

When adding a custom door, you should copy the template below and populate it with the relevant information.

No two CUSTODYIDENTIFIER can be the same, this will cause issues.

    ["CUSTODYIDENTIFIER"] = {
        BuzzInRequired = false,
        ControlPoint = vec3(x, y, z),
        Doors = {
            ["DOORIDENTIFIER"] = {
                DoorCoords = vec3(x, y, z),
                DoorHeading = 0.0,
                SpawnCode = `DOORSPAWN`
            }
        }
    },

BuzzInRequired - If set to true this door will default to being locked rather than having to be activated by a custody sergeant.

ControlPoint - These are the coordinates where the custody sergeant must stand to accept and reject buzzer requests.

Doors - This is a table of the doors that users are required to be buzzed in at, please populate this with the relevant values. The respective MLOs modding team will be able to assist with the information such as Spawn Code and headings.

No two doors can have the same DOORIDENTIFIER as this will cause issues.

Locked Doors

When adding doors that users will be required to unlock in order to pass through, copy the template below populating it with relevant information. Please note we have included an example of a door which will just open itself and one which will open another door.

Please note no two places can have the same CUSTODYIDENTIFIER.

["CUSTODYIDENTIFIER"] = {
        ["DOORIDENTIFIER1"] = {
            DoorCoords = vec3(x, y, z),
            DoorHeading = 0.0,
            SpawnCode = `DOORSPAWN`,
            AlsoUnlock = {}
        },
        ["DOORIDENTIFIER2"] = {
            DoorCoords = vec3(x, y, z),
            DoorHeading = 0.0,
            SpawnCode = `DOORSPAWN`,
            AlsoUnlock = {
                "DOORIDENTIFIER1",
            }
        },
    },

DoorCoords, DoorHeading, SpawnCode - The relevant modding team for the MLO that you are using will be able to provide you with this information if you are unable to work it out.

AlsoUnlock - This is useful for double doors so both doors are unlocked at the same time rather than just one side, simply put the name of the identifier into the table and the script will handle the rest if that identifier can be found.

No two doors can have the same DOORIDENTIFIER as this will cause issues.

Panic Strips

If you wish to add a Panic Strip to your station, you should look to add the x, y, and z vector3 values to the table for that relevant custody. The same can be repeated for the coordinates of where the sound will be played.

Control points must also be provided for each custody as this is the only place where the disabling alarm is recognised.

Cameras

Adding a custom camera may look daunting at first but simply copy the template below and add it to the table of cameras for that custody. That's all that is needed and the camera will be instantly recognised by the system.

{
    name = "NAME DISPLAYED ON SCREEN",
    coords = vec3(x, y, z),
    rotation = vec3(x, y, z),
    heading = 0.0
}