Andrew's Duty Log

Overview

Andrew’s Duty Log is a FiveM resource designed for tracking duty time for players in various departments. It records when a player starts and stops duty and automatically submits a summary to a Discord webhook. This is ideal for roleplay servers with Law Enforcement, Fire Rescue, or other role-specific jobs.

Key Features:

• Start/stop duty tracking with an in-game command.

• Automatic calculation of duty duration.

• Submission of duty logs to Discord via webhook.

• Department and subdivision management.

• Permission-based access to departments.

• Customizable Discord formatting via webhook.

---

Script Workflow

1️⃣ Starting Duty

• Player types the in-game command (e.g., /duty — configurable in the main script).

• The script:

  • Checks the player’s department permission.

  • Records the start time.

  • Marks the player as “on duty.”

2️⃣ Stopping Duty

• Player types the same command again.

• The script:

  • Calculates total duty duration.

  • Formats a Discord embed message.

  • Submits the log to the configured webhook.

  • Resets duty state for the player.

3️⃣ Automatic Department Verification

• Each department has its own permission and subdivisions.

• Players can only log duty for departments they are allowed to use.

• Subdivision names are included in the Discord log for clarity.

---

Configuration

Config.lua Overview

Config = {}

-- Discord webhook used to post duty logs
Config.webhookURL = "https://discord.com/api/webhooks/YOUR_WEBHOOK_HERE"

-- Departments allowed to use the system
Config.allowedDepartments = {
    departmentKey = {
        permission = "dutylog.permission",
        displayName = "Department Name",
        subdivisions = {
            { name = "subdivisionKey", displayName = "Subdivision Name" }
        }
    }
}

---

Config Options

Field	Type	Description
webhookURL	string	Discord webhook to which duty logs are sent. Replace with your server’s webhook.
allowedDepartments	table	Table of departments recognized by the system.
permission	string	ACE permission required to start duty for this department.
displayName	string	Friendly name shown in Discord embeds.
subdivisions	table	Subdivisions under the department, each with a name and displayName.

---

Example Departments

Config.allowedDepartments = {
    leo = {
        permission = "dutylog.leo",
        displayName = "Law Enforcement",
        subdivisions = {
            { name = "swat", displayName = "Special Weapons and Tactics" },
            { name = "detective", displayName = "Detective" }
        }
    },
    safr = {
        permission = "dutylog.safr",
        displayName = "Fire Rescue",
        subdivisions = {
            { name = "sar", displayName = "Search and Rescue" }
        }
    },
    civ = {
        permission = "dutylog.civ",
        displayName = "Civilian Affairs",
        subdivisions = {
            { name = "civilian", displayName = "Civilian" }
        }
    }
}

Tip: To add more departments, copy a block, change the permission, displayName, and subdivisions.

---

In-Game Command Usage

Action	Command	Result
Start Duty	/duty	Records start time, marks player on duty.
Stop Duty	/duty	Calculates duration, sends Discord log, resets state.

The actual command name is defined in the main script. Confirm your version if it differs.

---

Discord Webhook Logging

When a player stops duty, the script sends a formatted embed to the webhook:

• Player Name

• Department

• Subdivision

• Start Time

• End Time

• Total Duty Duration

Webhook Example:

{
    "username": "Duty Log",
    "embeds": [
        {
            "title": "Duty Session Completed",
            "fields": [
                { "name": "Player", "value": "JohnDoe" },
                { "name": "Department", "value": "Law Enforcement" },
                { "name": "Subdivision", "value": "SWAT" },
                { "name": "Start Time", "value": "12:00 PM" },
                { "name": "End Time", "value": "1:15 PM" },
                { "name": "Duration", "value": "1 hour 15 minutes" }
            ],
            "color": 3066993
        }
    ]
}

---

Permissions System

• Uses ACE permissions.

• Players must have the department-specific permission to start/stop duty.

• Example ACE permission setup in server.cfg:

add_ace group.admin dutylog.leo allow
add_ace group.admin dutylog.safr allow
add_ace group.admin dutylog.civ allow

Replace group.admin with your server groups as needed.

---

Subdivisions

• Departments can have multiple subdivisions.

• Example:

  • Department: Law Enforcement

  • Subdivisions: SWAT, Detective

• Subdivisions are recorded in Discord for clarity.

• Players select subdivision automatically or via command arguments depending on implementation.

---

Adding New Departments/Subdivisions

1. Open config.lua.

2. Add a new entry under Config.allowedDepartments:

newdept = {
    permission = "dutylog.newdept",
    displayName = "New Department",
    subdivisions = {
        { name = "sub1", displayName = "Subdivision 1" },
        { name = "sub2", displayName = "Subdivision 2" }
    }
}

1. Add ACE permissions for the department in server.cfg.

---

Notes & Tips

• Multiple duty sessions: Each start/stop is tracked individually.

• Discord Webhook Security: Ensure your webhook URL is private.

• Server Restart: Players on duty when the server restarts may lose session tracking — consider persistent storage if required.

• Customization: You can edit embed colors, titles, and field formatting in the main Lua script.