clock-in.md

description
An in-game way to utilize Sonoran CMS's clock in/out system.

Clock In

{% hint style="success" %} Looking for VPS, web, or dedicated hosting? Check out our official server hosting! {% endhint %}

This module is a in-game way of automatically* clocking in/out of Sonoran CMS's system.

Installation / Configuration

{% hint style="info" %} With core version v1.4.0 the Clock In resource was converted to a core module and no longer requires manual installation just configuration. {% endhint %}

1. Configure Clock In Module

Locate the clockin module within your [sonorancms]/sonorancms/server/modules and open the clockin_config.json file

{
    "enableCommand": true,
    "command": "clockin",
    "useAcePermissions": false,
    "qbcore": {
        "use": false,
        "autoClockInJobs": [
            "police",
            "ems",
            "fire"
        ]
    },
    "esx": {
        "use": true,
        "autoClockInJobs": [
            "police",
            "ambulance"
        ]
    }
}

Configuration

Config Option	Description
enableCommand	Registers the specified command that allows you to toggle clock in/out.
command	If enableCommand is true, this will be the registered command to toggle clock in/out.
useAcePermissions	If enableCommand is true, this will enable ace permissions for the specific command, must give command.whateverTheCommandIs
qbcore.use	Enables qbcore integration
qbcore.autoClockInJobs	Will automatically clock in/out the player's Sonoran CMS account with they clock in/out of a job with the name in the array of autoClockInJobs
esx.use	Enables ESX integration
esx.autoClockInJobs	Will automatically clock in/out the player's Sonoran CMS account with they clock in/out of a job with the name in the array of autoClockInJobs

2. Add your API ID

Ensure all players have added their API ID to the CMS!