XR-MDT

https://docs.xr-core.pl/
Admin
XR-MDT is a highly advanced, modular tablet system for FiveM servers featuring Police, EMS, DOJ, and...
Tokens:41,284
Snippets:378
Trust Score:2.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Generate Serial and Add to qb-inventory

Source: https://docs.xr-core.pl/xr-mdt/weapon-serialization.md

Example of generating a weapon serial number and storing it in the 'info' table for qb-inventory. Also shows how to register the weapon in the MDT.

```lua
local serial = exports['xr-mdt']:GenerateWeaponSerial()
local info = {
    serie   = serial,
    quality = 100
}

Player.Functions.AddItem('weapon_pistol', 1, false, info)

-- Register it in the MDT database
exports['xr-mdt']:RegisterWeapon(citizenid, serial, 'Pistol')
```

--------------------------------

### Add Log Entry Using Global Logging System

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Utilize the xr-mdt global logging system to add custom log entries. This example logs a weapon being taken from an armory.

```lua
exports['xr-mdt']:AddLog(
    source,
    "police",
    "Armory: Weapon Taken",
    "Took Glock 17 (Serial: #SN-A1B2-C3D4)",
    "Items"
)
```

--------------------------------

### Handle Business Bonus (QB-Core Example)

Source: https://docs.xr-core.pl/xr-mdt/api/editable

This function handles bonus distribution to employees. It includes logic for online players using Bridge functions and offline players by directly updating the database for QB-Core. Override this for other frameworks like ESX.

```lua
function Business_HandleBonus(employeeCitizenId, amount, businessName)
    local targetPlayer = Bridge.GetPlayerByCitizenId(employeeCitizenId)
    if targetPlayer then
        Bridge.AddMoney(Bridge.GetSource(targetPlayer), 'bank', amount)
        Bridge.Notify(Bridge.GetSource(targetPlayer),
            string.format(Locales.business.bonus_received_notif, amount, businessName), 'success')
    else
        -- Offline: update bank column directly
        if Config.Framework == 'qb' or Config.Framework == 'qbox' then
            local player = MySQL.single.await('SELECT money FROM players WHERE citizenid = ?', { employeeCitizenId })
            if player then
                local money = json.decode(player.money)
                money.bank = (money.bank or 0) + amount
                MySQL.update('UPDATE players SET money = ? WHERE citizenid = ?', { json.encode(money), employeeCitizenId })
            end
        end
    end
end
```

--------------------------------

### Log a Report Creation

Source: https://docs.xr-core.pl/xr-mdt/features/audit-logs

Example of logging an event where a report is created. This log does not specify an optional debugType, so it will use default routing.

```lua
-- Log a report creation
exports['xr-mdt']:AddLog(
    source,
    "police",
    "Report: Created",
    "Officer created report #105 for Citizen John Doe"
)
```

--------------------------------

### Implement Custom Jail Integration

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Replace the default JailPlayer event to integrate with a custom jail system. This example assumes an export function 'my-custom-jail:SendToJail' exists.

```lua
-- In editable/server/lspd.lua, replace JailPlayer:
EditTable.LSPD.Events.JailPlayer = function(source, targetSource, citizenId, time)
    if targetSource and targetSource > 0 then
        exports['my-custom-jail']:SendToJail(targetSource, time)
    end
end
```

--------------------------------

### Generate Serial and Add to qs-inventory

Source: https://docs.xr-core.pl/xr-mdt/weapon-serialization.md

Example of generating a weapon serial number and adding it to the item's info when using qs-inventory. Also shows how to register the weapon in the MDT.

```lua
local serial = exports['xr-mdt']:GenerateWeaponSerial()
local info = {
    serie = serial
}
exports['qs-inventory']:AddItem(source, 'weapon_pistol', 1, nil, info)

-- Register it in the MDT database
exports['xr-mdt']:RegisterWeapon(citizenid, serial, 'Pistol')
```

--------------------------------

### Generate Serial and Add to ox_inventory

Source: https://docs.xr-core.pl/xr-mdt/weapon-serialization.md

Example of generating a weapon serial number and adding it to a weapon's metadata when using ox_inventory. Also shows how to register the weapon in the MDT.

```lua
-- Example: Giving a weapon with a serial number in ox_inventory
local serial = exports['xr-mdt']:GenerateWeaponSerial()
local metadata = {
    serial      = serial,
    registered  = true  -- Optional flag
}

exports.ox_inventory:AddItem(source, 'weapon_pistol', 1, metadata)

-- Register it in the MDT database
exports['xr-mdt']:RegisterWeapon(citizenid, serial, 'Pistol')
```

--------------------------------

### Customize Tablet Opening Animation

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Replace the default OpenTablet client event to use a custom animation for opening the tablet. This example uses an animation from 'anim@cellphone@pre_selfie'.

```lua
-- In editable/client/main.lua, replace OpenTablet:
EditTable.ClientEvents.OpenTablet = function()
    -- Use a different animation
    RequestAnimDict("anim@cellphone@pre_selfie")
    while not HasAnimDictLoaded("anim@cellphone@pre_selfie") do Wait(10) end
    TaskPlayAnim(PlayerPedId(), "anim@cellphone@pre_selfie", "enter", 3.0, -3.0, -1, 49, 0, false, false, false)
end
```

--------------------------------

### Log a Fine Issued

Source: https://docs.xr-core.pl/xr-mdt/features/audit-logs

Example of logging an event where a player is issued a fine. This uses the 'Money' debugType for routing.

```lua
-- Log a fine being issued
exports['xr-mdt']:AddLog(
    source,
    "police",
    "Fine Issued",
    string.format("Officer fined %s $%s for: %s", citizenName, amount, reason),
    "Money"
)
```

--------------------------------

### Add Missing Columns to Users Table (ESX)

Source: https://docs.xr-core.pl/xr-mdt/common-issues.md

Execute this SQL query to add the 'ssn' and 'charid' columns to the 'users' table if they are missing, typically required when migrating to a newer ESX version or a fresh XR-MDT installation.

```sql
ALTER TABLE `users` ADD COLUMN IF NOT EXISTS `ssn` VARCHAR(20) DEFAULT NULL;
ALTER TABLE `users` ADD COLUMN IF NOT EXISTS `charid` VARCHAR(50) DEFAULT NULL;
```

--------------------------------

### Get Closest Player via Bridge

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Identifies the closest player and returns their ID along with the distance.

```lua
Bridge.GetClosestPlayer()
```

--------------------------------

### Full Business Addition with Custom Branding and Permissions

Source: https://docs.xr-core.pl/xr-mdt/guides/adding-business

Configure a new business with custom branding (display name, logo, colors) and optional custom permissions by defining entries in `JobSettings` and `Grades` within `configs/config.business.lua`.

```lua
Config.Business = {
    TabletCommand = 'bizpad',
    OpenKey = 'DELETE',

    AllowedJobs = {
        'mechanic', 'cardealer', 'realestate', 'taxi',
        'burgershot', 'uwucafe',
        'autoexotica',    -- ← 1. Add to allowed list
    },

    JobSettings = {
        -- ... existing entries ...
        ['autoexotica'] = {                              -- ← 2. Add branding
            DisplayName = 'Auto Exotica',
            LogoFile    = 'images/biz_autoexotica.png',  -- supports .png, .webp, .jpg
            Colors      = {
                primary     = '#8b5cf6',
                primaryDark = '#6d28d9',
                bg          = 'rgba(139, 92, 246, 0.1)'
            },
        },
    },

    Grades = {
        ['default'] = { ... },
        ['autoexotica'] = {                              -- ← 3. Custom permissions (optional)
            ['0'] = { label = 'Intern',        permissions = { ... } },
            ['1'] = { label = 'Sales',         permissions = { ... } },
            ['2'] = { label = 'Senior Sales',  permissions = { ... } },
            ['3'] = { label = 'Manager',       permissions = { ... } },
            ['4'] = { label = 'Owner',         permissions = { ... } },
        },
    },

    MaxInvoicesPerDay = 50,
    MaxBonusAmount = 10000,
}
```

--------------------------------

### Get Closest Vehicle via Bridge

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Finds and returns the nearest vehicle entity to a specified coordinate.

```lua
Bridge.GetClosestVehicle(coords)
```

--------------------------------

### Log an Armory Withdrawal

Source: https://docs.xr-core.pl/xr-mdt/features/audit-logs

Example of logging an event where an item is withdrawn from an armory. This uses the 'Items' debugType for routing.

```lua
-- Log an armory withdrawal
exports['xr-mdt']:AddLog(
    source,
    "police",
    "Armory: Weapon Taken",
    "Took Glock 17 (Serial: #SN-A1B2-C3D4)",
    "Items"
)
```

--------------------------------

### Create Business Invoices and Tariffs Tables

Source: https://docs.xr-core.pl/xr-mdt/guides/adding-business

Manually create the `business_invoices` and `business_tariffs` database tables if they are missing or have an outdated schema. This is essential for invoice functionality.

```sql
-- Run the full table creation from xr-mdt.sql, or manually:
CREATE TABLE IF NOT EXISTS `business_invoices` (
    `id` INT AUTO_INCREMENT PRIMARY KEY,
    `business_name` VARCHAR(50) NOT NULL,
    `citizenid` VARCHAR(50) NOT NULL,
    `amount` INT NOT NULL DEFAULT 0,
    `title` VARCHAR(255) DEFAULT NULL,
    `issuer` VARCHAR(100) DEFAULT NULL,
    `status` VARCHAR(20) DEFAULT 'Pending',
    `created_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

CREATE TABLE IF NOT EXISTS `business_tariffs` (
    `id` INT AUTO_INCREMENT PRIMARY KEY,
    `business_name` VARCHAR(50) NOT NULL,
    `label` VARCHAR(255) NOT NULL,
    `amount` INT NOT NULL DEFAULT 0
);
```

--------------------------------

### Get Player Data via Bridge

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Retrieves the complete player data, including job, metadata, and items, using the framework bridge.

```lua
Bridge.GetPlayerData()
```

--------------------------------

### Register for Tablet Open Event

Source: https://docs.xr-core.pl/xr-mdt/api/client

Handles the 'xr-mdt:client:open' net event, which is received when the server authorizes the tablet to open. Contains session payload data.

```lua
-- Internal event — handled by editable/client/main.lua
RegisterNetEvent('xr-mdt:client:open', function(data)
    -- data.type        = 'police' | 'ems' | 'doj' | 'business'
    -- data.permissions = table of permission flags
end)
```

--------------------------------

### XR-MDT Editable File Structure

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Illustrates the directory structure for editable server and client-side files in XR-MDT, highlighting the main bridge, module-specific files, and their roles.

```Markdown
```
editable/
├── server/
│   ├── main.lua          ← Core bridge, Bridge functions, framework detection, EditTable.Events
│   ├── lspd.lua          ← Police-specific events, queries, helpers
│   ├── ems.lua           ← EMS-specific events and queries
│   ├── doj.lua           ← DOJ/Court events and queries
│   ├── business.lua      ← Business management events, queries, finance
│   ├── sv_items.lua      ← Item registration & tablet access controller (OpenTablet, exports)
│   └── sv_vehicles.lua   ← Vehicle database operations & VIN generation (AddVehicle export)
└── client/
    ├── main.lua          ← Client bridge, animations, dispatch, UI locales, targeting
    ├── lspd.lua          ← Police client commands (panic, backup, dispatch keybinds)
    ├── ems.lua           ← EMS client hooks (stub — add your logic)
    ├── doj.lua           ← DOJ client hooks (stub — add your logic)
    └── business.lua      ← Business client hooks (stub — add your logic)
```
```

--------------------------------

### Get and Update Threat Code

Source: https://docs.xr-core.pl/xr-mdt/api/client

Allows reading the current threat level code and updating it to a new value. Supports 'green', 'yellow', 'orange', and 'red' options.

```lua
-- Get current threat code
local code = exports['xr-mdt']:getCurrentCode()
print(code.label) -- e.g. "CODE RED"

-- Set a new code
exports['xr-mdt']:updateCode('red') -- options: 'green', 'yellow', 'orange', 'red'
```

--------------------------------

### Server Core Module Overview

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Details the responsibilities of `editable/server/main.lua`, including framework detection, the Bridge abstraction layer, EditTable integration points, and event listeners.

```Markdown
This is the **main bridge** between XR-MDT and your framework. It contains:

* Framework detection and object initialization (`QBCore`, `ESX`).
* The `Bridge` abstraction layer for all framework operations.
* `EditTable.Events` — the primary integration points called by the core.
* `EditTable.Functions` — utility helpers.
* Event listeners for dispatch and notifications.
```

--------------------------------

### Open Menu via Bridge

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Opens a context menu for the player, utilizing `ox_lib` or `qb-menu`.

```lua
Bridge.OpenMenu(data)
```

--------------------------------

### Notification System Configuration

Source: https://docs.xr-core.pl/xr-mdt/configuration

Configure the notification system type to be used by the MDT. Supported options are 'ox', 'qb', and 'esx'.

```lua
Config.Notify = {
    Type = 'ox'  -- Options: 'ox', 'qb', 'esx'
}
```

--------------------------------

### Override EMS Treatment Handling

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Override the EMS_HandleTreatment function to adapt to different framework or banking implementations, such as ESX. This example shows how to remove money from a player's bank and add it to the ambulance society.

```lua
function EMS_HandleTreatment(source, citizenId, amount, treatmentName)
    local targetPlayer = Bridge.GetPlayerByCitizenId(citizenId)
    if targetPlayer then
        Bridge.RemoveMoney(Bridge.GetSource(targetPlayer), 'bank', amount)
        Bridge.Bank.AddMoney('ambulance', amount)
    end
end
```

--------------------------------

### Module Toggles Configuration

Source: https://docs.xr-core.pl/xr-mdt/configuration

Enable or disable individual sub-systems of the XR-MDT. Note that the internal key for police is 'EnablePolice'.

```lua
Config.EnablePolice   = true  -- NOTE: Internal key is 'EnablePolice', not 'EnableLSPD'
Config.EnableEMS      = true
Config.EnableDOJ      = true
Config.EnableBusiness = true
Config.EnableDispatch = true
```

--------------------------------

### Integrate Custom Database Driver

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Replace the default Query event to use a custom database driver, such as 'mysql-async'. This allows for custom database query handling.

```lua
-- In editable/server/main.lua, replace Query:
EditTable.Events.Query = function(query, params)
    return exports['mysql-async']:mysql_fetch_all(query, params)
end
```

--------------------------------

### Register Tablet Item for Inventory Use

Source: https://docs.xr-core.pl/xr-mdt/installation

Manually registers the 'tablet' item to open the MDT when used from the inventory. Supports QB/Qbox and generic export usage.

```lua
-- For QB / Qbox (in qb-core/server/main.lua or similar)
QBCore.Functions.CreateUseableItem('tablet', function(source)
    TriggerClientEvent('xr-mdt:client:toggleTablet', source)
end)

-- Or via the export (works from any server script)
exports['xr-mdt']:tablet(source)
```

--------------------------------

### Configure Bodycam System Settings

Source: https://docs.xr-core.pl/xr-mdt/configuration

Set the video resolution, default frames per second (FPS) for active recording, and a lower FPS for background buffering. Specify which jobs are allowed to use the bodycam system.

```lua
Config.Cameras = {
    Resolution  = { width = 1280, height = 720 },
    DefaultFPS  = 12,    -- Active rendering framerate
    IdleFPS     = 0.5,   -- Background buffering framerate
    AllowedJobs = { "police", "pd", "ambulance" }
}
```

--------------------------------

### Minimal Business Addition

Source: https://docs.xr-core.pl/xr-mdt/guides/adding-business

Add a new business to the `AllowedJobs` list in `configs/config.business.lua` for basic integration. Default permissions will be applied automatically.

```lua
-- In configs/config.business.lua:

Config.Business = {
    TabletCommand = 'bizpad',
    OpenKey = 'DELETE',

    AllowedJobs = {
        'mechanic',
        'cardealer',
        'realestate',
        'taxi',
        'burgershot',
        'uwucafe',
        'autoexotica',    -- ← ADD HERE (1 line)
    },

    -- JobSettings: not required for basic setup
    -- Grades: default permissions will apply automatically
}
```

--------------------------------

### Open MDT from Server

Source: https://docs.xr-core.pl/xr-mdt/api/server

This export is used to open the MDT tablet for a specific player from the server. It is not intended to be called directly by client scripts.

```lua
-- Triggered automatically by the client — do not call directly.
-- To open the tablet from server, use the export instead:
exports['xr-mdt']:tablet(source)
```

--------------------------------

### xr-mdt:client:open

Source: https://docs.xr-core.pl/xr-mdt/api/client

Received when the server authorizes the tablet to open. Contains the full session payload.

```APIDOC
## `xr-mdt:client:open`

### Description
Received when the server authorizes the tablet to open. Contains the full session payload.

### Event Data
- **data.type** (`string`) - `'police' | 'ems' | 'doj' | 'business'`
- **data.permissions** (`table`) - table of permission flags

### Example
```lua
-- Internal event — handled by editable/client/main.lua
RegisterNetEvent('xr-mdt:client:open', function(data)
    -- data.type        = 'police' | 'ems' | 'doj' | 'business'
    -- data.permissions = table of permission flags
end)
```
```

--------------------------------

### Customize Fine System with Discord Logging

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Replace the default FinePlayer event to log fines to a Discord webhook. Ensure 'YOUR_WEBHOOK_URL' is replaced with your actual Discord webhook URL.

```lua
-- In editable/server/lspd.lua, replace FinePlayer:
EditTable.LSPD.Events.FinePlayer = function(source, targetSource, citizenId, amount, reason)
    local success = Bridge.RemoveMoney(targetSource, 'bank', amount)

    PerformHttpRequest('YOUR_WEBHOOK_URL', function() end, 'POST',
        json.encode({
            embeds = {{ title = '💰 Fine Issued', description = string.format('**%s** was fined $%s\nReason: %s', citizenId, amount, reason), color = 16711680 }}
        }), {['Content-Type'] = 'application/json'})

    return success
end
```

--------------------------------

### Register Weapon on Sale

Source: https://docs.xr-core.pl/xr-mdt/weapon-serialization.md

Hook into the 'weaponshop:weaponSold' event to generate a weapon serial, add the weapon to inventory with metadata, and register it in the MDT.

```lua
-- Example: In your weapon shop script
AddEventHandler('weaponshop:weaponSold', function(source, weaponModel, citizenid)
    local serial = exports['xr-mdt']:GenerateWeaponSerial()

    -- Add to inventory with metadata
    exports.ox_inventory:AddItem(source, weaponModel, 1, { serial = serial })

    -- Register in MDT
    exports['xr-mdt']:RegisterWeapon(citizenid, serial, weaponModel)
end)
```

--------------------------------

### Configure Webhook Routing and Categories

Source: https://docs.xr-core.pl/xr-mdt/configuration

Set up Discord webhooks for various event types and job categories. Webhooks are prioritized from specific types to job categories, then to a main webhook. Includes titles and colors for job categories.

```lua
Config.Webhooks = {
    Main = 'https://discord.com/api/webhooks/...',

    Types = {
        Money    = '',    -- Financial actions
        Items    = '',    -- Inventory operations
        Database = '',    -- SQL operations (debug only)
        JobChange = '',   -- Job/duty changes
    },

    Jobs = {
        POLICE   = 'https://discord.com/api/webhooks/...',
        EMS      = '',
        DOJ      = '',
        BUSINESS = '',
        System   = '',
    },

    Categories = {
        POLICE   = { Title = '🚔 LSPD',    Color = 3447003  },
        EMS      = { Title = '🚑 EMS',     Color = 3066993  },
        DOJ      = { Title = '⚖️ DOJ',     Color = 15844367 },
        BUSINESS = { Title = '🏢 Business', Color = 15105570 },
        System   = { Title = '⚙️ System',  Color = 9807270  }
    }
}
```

--------------------------------

### Configure Business Branding

Source: https://docs.xr-core.pl/xr-mdt/guides/adding-business

Define custom branding for the business in the `JobSettings` table within `configs/config.business.lua`. This includes a display name, logo file path, and optional accent colors. Place the logo file in `web/dist/images/`.

```lua
Config.Business = {
    -- ...
    JobSettings = {
        -- ... existing entries ...

        ['autoexotica'] = {
            DisplayName = 'Auto Exotica',
            LogoFile    = 'images/biz_autoexotica.webp',
            Colors      = {
                primary     = '#8b5cf6',
                primaryDark = '#6d28d9',
                bg          = 'rgba(139, 92, 246, 0.1)'
            },
        },
    },
    -- ...
}
```

--------------------------------

### Open MDT Tablet Programmatically

Source: https://docs.xr-core.pl/xr-mdt/api/client

Opens the MDT tablet for the local player, bypassing any item checks. Use this to grant programmatic access to the tablet interface.

```lua
exports['xr-mdt']:openTablet()
```

--------------------------------

### Play Tablet Animation

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Plays a specific animation for opening the MDT tablet. Ensure the animation dictionary is loaded before playing.

```lua
EditTable.ClientEvents.OpenTablet = function()
    RequestAnimDict("amb@world_human_seat_wall_tablet@female@base")
    while not HasAnimDictLoaded("amb@world_human_seat_wall_tablet@female@base") do Wait(10) end
    TaskPlayAnim(PlayerPedId(), "amb@world_human_seat_wall_tablet@female@base", "base", 8.0, -8.0, -1, 50, 0, false, false, false)
end
```

--------------------------------

### Implement Database Query Handling

Source: https://docs.xr-core.pl/xr-mdt/api/editable

This function is crucial for all MDT database operations. Override it if you are not using oxmysql to ensure proper SQL query execution and error handling. It accepts a raw SQL query string and parameterized values.

```lua
EditTable.Events.Query = function(query, params)
    local status, result = pcall(function()
        return MySQL.query.await(query, params)
    end)
    if not status then
        EditTable.Functions.ReportError(EditTable.Functions.ErrorCodes.DATABASE_ERROR,
            string.format("Query Failed: %s\nError: %s", query, result))
        return {}
    end
    return result
end
```

--------------------------------

### QB-Core Item Schema

Source: https://docs.xr-core.pl/xr-mdt/installation

Defines item properties for QB-Core, including name, label, weight, and usability.

```lua
["tablet"]   = { name='tablet',   label='Tablet',            weight=500,  type='item', unique=false, useable=true, shouldClose=true },
["bodycam"]  = { name='bodycam',  label='Bodycam',           weight=150,  type='item', unique=true,  useable=true, shouldClose=true },
["gps"]      = { name='gps',      label='Tracker',           weight=100,  type='item', unique=false, useable=true, shouldClose=true },
["document"] = { name='document', label='Printed Document',  weight=10,   type='item', unique=true,  useable=true, shouldClose=true }
```

--------------------------------

### Item Names Configuration

Source: https://docs.xr-core.pl/xr-mdt/configuration

Define the internal names for various items used by the MDT system. Ensure these match your inventory item names.

```lua
Config.Items = {
    tablet        = 'tablet',
    bodycam       = 'bodycam',
    gps           = 'gps',
    document      = 'document',
    tracking_band = 'tracking_band'
}
```

--------------------------------

### Open MDT Client Event

Source: https://docs.xr-core.pl/xr-mdt/how-to-use.md

This event is triggered by the server to open the MDT client, routing the signal to the correct application based on player data.

```lua
TriggerClientEvent('xr-mdt:client:open', source, data)
```

--------------------------------

### openTablet

Source: https://docs.xr-core.pl/xr-mdt/api/client

Opens the MDT tablet for the local player programmatically (bypasses item check).

```APIDOC
## `openTablet`

### Description
Opens the MDT tablet for the local player programmatically (bypasses item check).

### Request Example
```lua
exports["xr-mdt"]:openTablet()
```
```

--------------------------------

### Enable Debug Mode in XR-MDT

Source: https://docs.xr-core.pl/xr-mdt/common-issues.md

Set `Config.Debug` to `true` in `config.main.lua` to enable verbose logging and debugging features. Remember to disable it on production servers.

```lua
Config.Debug = true
```

--------------------------------

### Create a Dispatch Alert

Source: https://docs.xr-core.pl/xr-mdt/api/client

Spawns an interactive dispatch alert popup visible to specific jobs. Use this for custom alert systems requiring detailed information and optional blips/sounds.

```lua
exports['xr-mdt']:createAlert({
    code        = '10-31',
    title       = 'Store Robbery',
    description = 'Alarm registered at 24/7 store',
    coords      = GetEntityCoords(PlayerPedId()),
    sound       = 'POLICERobbery',
    blip = {
        sprite = 161,
        scale  = 1.0,
        color  = 3,
        name   = 'Robbery'
    },
    jobs = {'police'}
})
```

--------------------------------

### Register Weapon in MDT Database

Source: https://docs.xr-core.pl/xr-mdt/weapon-serialization.md

Use the `RegisterWeapon` export to log a weapon's serial number, owner's citizen ID, and model into the MDT evidence system. Returns a boolean indicating success.

```lua
exports['xr-mdt']:RegisterWeapon('QJB12345', 'SN-A1B2-C3D4', 'Combat Pistol')
```

--------------------------------

### Create Dispatch Alert via Export

Source: https://docs.xr-core.pl/xr-mdt/how-to-use.md

External scripts can create dispatch alerts using this export function. Ensure the 'xr-mdt' resource is correctly referenced.

```lua
exports['xr-mdt']:createAlert(data)
```

--------------------------------

### Verify Business Tables Exist

Source: https://docs.xr-core.pl/xr-mdt/guides/adding-business

Check if the necessary database tables for business invoices and tariffs are present. This is a crucial step before enabling business features.

```sql
SHOW TABLES LIKE 'business_%';
```

--------------------------------

### xr-mdt:client:toggleTablet

Source: https://docs.xr-core.pl/xr-mdt/api/client

Trigger the tablet open/close sequence from an external script (e.g., from a usable item).

```APIDOC
## `xr-mdt:client:toggleTablet`

### Description
Trigger the tablet open/close sequence from an external script (e.g., from a usable item).

### Usage
```lua
TriggerClientEvent('xr-mdt:client:toggleTablet', source)
```
```

--------------------------------

### AddLog Server Export

Source: https://docs.xr-core.pl/xr-mdt/api/server

Records an audit log to the mdt_logs database table and forwards it to a Discord webhook. Use this for tracking significant player actions.

```lua
exports['xr-mdt']:AddLog(
    source,
    "police",
    "Report: Created",
    "Officer created report #105 for citizen John Doe",
    "General" -- Webhook category from Config.Webhooks.Types
)
```

--------------------------------

### Handle New Dispatch Event

Source: https://docs.xr-core.pl/xr-mdt/api/client

Registers for the 'xr-mdt:client:newDispatch' net event, sent by the server when a new dispatch arrives. Forwards data to the NUI.

```lua
RegisterNetEvent('xr-mdt:client:newDispatch', function(data)
    -- data contains: code, title, description, location, coords, blip, sound
    print("New dispatch: " .. data.title)
end)
```

--------------------------------

### Configure Global Business Limits

Source: https://docs.xr-core.pl/xr-mdt/guides/adding-business

Adjust global limits for business operations, such as the maximum number of invoices per day and the maximum bonus payout amount. These settings are found in the main business configuration file.

```lua
Config.Business = {
    -- ...
    MaxInvoicesPerDay = 50,    -- max invoices per day (per player)
    MaxBonusAmount    = 10000, -- max bonus payout amount
}
```

--------------------------------

### TriggerDispatch

Source: https://docs.xr-core.pl/xr-mdt/api/client

A simplified wrapper that routes to the server dispatch system. Does not require coordinates or blip data.

```APIDOC
## `TriggerDispatch`

### Description
A simplified wrapper that routes to the server dispatch system. Does not require coordinates or blip data.

### Parameters
#### Path Parameters
- **code** (string) - Standard 10-code (e.g. `'10-90'`).
- **title** (string) - Event name.
- **description** (string) - Context description.
- **location** (string) - Street / area label.
- **jobs** (table) - Target job names.

### Request Example
```lua
exports["xr-mdt"]:TriggerDispatch(
    '10-90',
    'Jewelry Store Robbery',
    'Smash & Grab detected in lower chambers.',
    'Vangelico Jewelry',
    {'police'}
)
```

### Notes
`TriggerDispatch` triggers `TriggerServerEvent('xr-mdt:server:triggerDispatch', data)` which then calls `EditTable.Events.SendDispatch(data)` — fully customizable in `editable/server/main.lua`.
```

--------------------------------

### Add Printer Configuration

Source: https://docs.xr-core.pl/xr-mdt/guides/adding-police-unit

Add a new printer entry to `Config.Printers` in `configs/config.main.lua` to define a printer location at the new unit's base.

```lua
Config.Printers = {
    -- ... existing printers ...
    {
        Coords   = vector3(x, y, z),  -- printer coordinates at SASP base
        Label    = 'SASP Printer',
        Distance = 20.0
    },
}
```

--------------------------------

### xr-mdt:client:newDispatch

Source: https://docs.xr-core.pl/xr-mdt/api/client

Sent by the server when a new dispatch arrives. Forwards data to NUI.

```APIDOC
## `xr-mdt:client:newDispatch`

### Description
Sent by the server when a new dispatch arrives. Forwards data to NUI.

### Event Data
- **data** (`table`) - Contains: `code`, `title`, `description`, `location`, `coords`, `blip`, `sound`

### Example
```lua
RegisterNetEvent('xr-mdt:client:newDispatch', function(data)
    -- data contains: code, title, description, location, coords, blip, sound
    print("New dispatch: " .. data.title)
end)
```
```

--------------------------------

### Configure Weapon Serialization

Source: https://docs.xr-core.pl/xr-mdt/weapon-serialization.md

Customize the serial number prefix and format in the main configuration file. The format uses 'X' for random alphanumeric characters.

```lua
Config.WeaponSerialization = {
    Enabled = true,
    Prefix  = 'SN',             -- Serial Number Prefix (e.g., SN-XXXX-XXXX)
    Format  = 'XXXX-XXXX-XXXX', -- X = random alphanumeric character (0-9, A-Z)
}
```

--------------------------------

### Configure Bodycam Access

Source: https://docs.xr-core.pl/xr-mdt/guides/adding-police-unit

Update `Config.Cameras` in `configs/config.main.lua` to include the new job identifier in `AllowedJobs` and `ViewerJobs` for bodycam functionality.

```lua
Config.Cameras = {
    AllowedJobs = { "police", "pd", "ambulance", "sasp" },  -- ← add here
    ViewerJobs  = { "police", "pd", "ambulance", "sasp" },  -- ← and here

    JobPrefixes = {
        police    = "POLICE",
        ambulance = "AMBULAN",
        sasp      = "SASP",      -- ← new prefix
    },
    -- ...
}
```

--------------------------------

### Add Global Player Targeting via Bridge

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Configures options for global player targeting.

```lua
Bridge.AddGlobalPlayer(options)
```

--------------------------------

### Trigger Server-Side Dispatch

Source: https://docs.xr-core.pl/xr-mdt/api/client

A simplified wrapper to route alerts to the server dispatch system. Useful for basic alerts where coordinates or blip data are not needed.

```lua
exports['xr-mdt']:TriggerDispatch(
    '10-90',
    'Jewelry Store Robbery',
    'Smash & Grab detected in lower chambers.',
    'Vangelico Jewelry',
    {'police'}
)
```

--------------------------------

### Items & Inventory Functions

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Functions for managing player items and inventory.

```APIDOC
## Bridge.GetItem

### Description
Returns item data from the player's inventory.

### Signature
`(source, item) → table?`

## Bridge.GetItemCount

### Description
Returns the quantity of an item the player has.

### Signature
`(source, item) → number`

## Bridge.AddItem

### Description
Adds an item to the player's inventory.

### Signature
`(source, item, count, slot?, metadata?) → boolean`

## Bridge.RemoveItem

### Description
Removes an item from the player's inventory.

### Signature
`(source, item, count, slot?) → boolean`

## Bridge.RegisterUsableItem

### Description
Registers a usable item. Uses `ox_inventory:registerHook` when available.

### Signature
`(name, handler)`
```

--------------------------------

### Webhook Configuration Structure

Source: https://docs.xr-core.pl/xr-mdt/features/audit-logs

Defines the structure for configuring global and faction-specific webhooks for various log types, including routing rules and embed appearance.

```lua
Config.Webhooks = {
    -- Primary global fallback webhook if others are not set
    Main = "https://discord.com/api/webhooks/...",

    -- Global fallback webhooks for faction logs and administrative logs
    AdminMain = "https://discord.com/api/webhooks/...",
    FactionMain = "https://discord.com/api/webhooks/...",

    -- Faction-specific webhooks.
    Jobs = {
        LSPD = {
            Faction = "https://discord.com/api/webhooks/...",
            Admin = "https://discord.com/api/webhooks/...",
        },
        EMS = {
            Faction = "",
            Admin = "",
        },
        DOJ = {
            Faction = "",
            Admin = "",
        },
        Business = {
            Faction = "",
            Admin = "",
        },
    },

    -- Webhooks for specific action types (overrides Jobs faction webhooks if set)
    Types = {
        Database = "",
        Money = "",
        Items = "",
        JobChange = "",
        Duty = "",
        Commands = "",
    },

    Routing = {
        -- Fallback routing for any log type not explicitly specified below
        ["Default"] = "faction",

        -- Administrative events (personnel, access, code changes, deletions)
        ["Hired"] = "both",
        ["Fired"] = "both",
        ["Promotion/Demotion"] = "both",
        ["Badge Changed"] = "both",
        ["Suspension"] = "both",
        ["License Issued"] = "both",
        ["Code Changed"] = "both",
        ["Report: Deleted"] = "both",
        ["Armory: Delete Kit"] = "both",
        ["Employee Note Created"] = "both",
        ["Employee Note Deleted"] = "both",

        -- Faction operational events
        ["Armory: Return"] = "faction",
        ["Armory: Collect"] = "faction",
        ["Armory: Save Kit"] = "faction",
        ["Armory: Collect Kit"] = "faction",
        ["Armory: Weapon Taken"] = "faction",
        ["Invoice Issued"] = "faction",
        ["Invoice Paid"] = "faction",
        ["Document: Created"] = "faction",
        ["Document: Updated"] = "faction",
        ["Document: Printed"] = "faction",
        ["Document: Received"] = "faction",
        ["Document: Signed"] = "faction",
        ["Document: Profile Printed"] = "faction",
        ["Duty: Started (CODE 1)"] = "faction",
        ["Duty: Break (CODE 2)"] = "faction",
        ["Duty: Ended (CODE 3)"] = "faction",
        ["Duty: Started"] = "faction",
        ["Duty: Break"] = "faction",
        ["Duty: Ended"] = "faction",
        ["Case Created"] = "faction",
        ["Medical Record Added"] = "faction",
        ["Patient Note Added"] = "faction",
        ["Citizen Lookup"] = "faction",
        ["Citizen Note Added"] = "faction",
        ["Warrant Issued"] = "faction",
        ["Jail Sentence"] = "faction",
        ["Fine Issued"] = "faction",
        ["Incident Report Created"] = "faction",
        ["Report: Created"] = "faction",
        ["Report: Updated"] = "faction",
    },

    -- Appearance & Colors for Discord Embeds
    Categories = {
        LSPD = { Color = 2123412, Title = "🚓 LSPD LOGS" },
        EMS = { Color = 15158332, Title = "🚑 EMS LOGS" },
        DOJ = { Color = 15844367, Title = "⚖️ DOJ LOGS" },
        Business = { Color = 3066993, Title = "💼 BUSINESS LOGS" },
        System = { Color = 8359053, Title = "⚙️ SYSTEM LOGS" },
    }
}

```

--------------------------------

### AddDispatch

Source: https://docs.xr-core.pl/xr-mdt/api/client

Directly adds a dispatch entry to the local NUI panel without going through the server. Use for client-local alerts.

```APIDOC
## `AddDispatch`

### Description
Directly adds a dispatch entry to the local NUI panel without going through the server. Use for client-local alerts.

### Request Example
```lua
exports["xr-mdt"]:AddDispatch({
    code        = '10-65',
    title       = 'Traffic Stop',
    description = 'Vehicle stopped on Route 68',
    location    = 'Route 68',
    jobs        = {'police'},
    time        = GetGameTimer()
})
```
```

--------------------------------

### HandleSentence

Source: https://docs.xr-core.pl/xr-mdt/api/editable

Handles the application of a full sentence (fine and jail time) to a player, supporting both online and offline scenarios. It deducts fines, updates society accounts, and manages jail time.

```APIDOC
## HandleSentence()

### Description
Called when a full sentence (fine + jail) is applied. Handles both online and offline players.

### Parameters
- **source** (any) - The source of the event.
- **citizenId** (string) - The citizen ID of the player.
- **fine** (number) - The amount of fine to apply.
- **jailTime** (number) - The amount of jail time to apply.
- **reason** (string) - The reason for the sentence.
- **authorName** (string) - The name of the player or system applying the sentence.

### Returns
- **boolean** - True if the sentence was handled successfully, false otherwise.
```

--------------------------------

### Add Job to AllowedJobs List

Source: https://docs.xr-core.pl/xr-mdt/guides/adding-business

Add the new business's framework job name to the `AllowedJobs` array in `configs/config.business.lua`. Ensure the name exactly matches the framework's job definition.

```lua
Config.Business = {
    TabletCommand = 'bizpad',
    OpenKey = 'DELETE',

    AllowedJobs = {
        'mechanic',
        'cardealer',
        'realestate',
        'taxi',
        'burgershot',
        'uwucafe',
        'autoexotica',    -- ← NEW BUSINESS
    },
    -- ...
}
```

--------------------------------

### Define Custom Permissions Per Business

Source: https://docs.xr-core.pl/xr-mdt/guides/adding-business

Use this Lua code to define custom permissions for different job grades within a specific business. Ensure grade keys are strings.

```lua
Grades = {
    ['default'] = { ... },

    -- ========================================================
    -- AUTO EXOTICA — Luxury Car Dealership
    -- ========================================================
    ['autoexotica'] = {
        ['0'] = {
            label = 'Intern',
            permissions = {
                dashboard_view   = true,
                employees_view   = true,
                employees_manage = false,
                invoices_create  = false,   -- interns can't create invoices
                invoices_view    = true,
                invoice_custom   = false,
                tariff_view      = true,
                tariff_manage    = false,
                admin            = false,
            }
        },
        ['1'] = {
            label = 'Sales Associate',
            permissions = {
                dashboard_view   = true,
                employees_view   = true,
                employees_manage = false,
                invoices_create  = true,
                invoices_view    = true,
                invoice_custom   = false,
                tariff_view      = true,
                tariff_manage    = false,
                admin            = false,
            }
        },
        ['2'] = {
            label = 'Senior Sales',
            permissions = {
                dashboard_view   = true,
                employees_view   = true,
                employees_manage = false,
                invoices_create  = true,
                invoices_view    = true,
                invoice_custom   = true,    -- can set custom invoice amounts
                tariff_view      = true,
                tariff_manage    = false,
                admin            = false,
            }
        },
        ['3'] = {
            label = 'Floor Manager',
            permissions = {
                dashboard_view   = true,
                employees_view   = true,
                employees_manage = true,    -- manages employees
                invoices_create  = true,
                invoices_view    = true,
                invoice_custom   = true,
                tariff_view      = true,
                tariff_manage    = true,    -- manages tariff/price list
                admin            = false,
            }
        },
        ['4'] = {
            label = 'Owner',
            permissions = {
                dashboard_view   = true,
                employees_view   = true,
                employees_manage = true,
                invoices_create  = true,
                invoices_view    = true,
                invoice_custom   = true,
                tariff_view      = true,
                tariff_manage    = true,
                admin            = true,    -- full access
            }
        },
    },
}
```

--------------------------------

### Define New Police Unit in config.police.lua

Source: https://docs.xr-core.pl/xr-mdt/guides/adding-police-unit

Add a new entry to the `Config.PoliceJobs` table to define a new police unit. Ensure the key matches your framework's job name. This configuration includes display information, command bindings, prefixes, blip settings, status codes, document links, and grade-specific permissions.

```lua
Config.PoliceJobs = {
    ['police'] = { ... }, -- existing LSPD
    ['sheriff'] = { ... }, -- existing LSSD

    -- ========================================================
    -- SASP — San Andreas State Police (NEW UNIT)
    -- ========================================================
    ['sasp'] = {
        -- 1. DISPLAY DATA
        DisplayName   = 'San Andreas State Police',
        ShortName     = 'SASP',
        LogoFile      = 'images/sasp.webp',    -- place file in web/dist/
        Theme         = 'sasp',                -- CSS theme class
        Colors        = {
            primary     = '#7c3aed',           -- main accent color (purple)
            primaryDark = '#5b21b6',           -- darker variant
            bg          = 'rgba(124, 58, 237, 0.1)'  -- element background
        },

        -- 2. COMMAND / KEYBIND
        TabletCommand = 'saspmdt',   -- /saspmdt opens the tablet
        OpenKey       = 'F8',        -- keyboard shortcut

        -- 3. PREFIXES
        CamPrefix     = 'SASP',     -- Bodycam ID: SASP-XXXXXXXXX
        PlatePrefix   = 'SASP',     -- License plate: SASP 123

        -- 4. GPS
        BlipColor     = 27,         -- Blip color on map (FiveM Blip Color ID)

        -- 5. STATUS CODES (THREAT LEVEL)
        Codes = {
            { id = 'green',  label = 'CODE GREEN',  color = '#22c55e', description = 'Stable situation.' },
            { id = 'yellow', label = 'CODE YELLOW', color = '#eab308', description = 'Heightened awareness.' },
            { id = 'red',    label = 'CODE RED',    color = '#ef4444', description = 'Active threat.' },
            { id = 'black',  label = 'CODE BLACK',  color = '#0f172a', description = 'Critical state.' },
        },

        -- 6. DOCUMENT LINKS
        Documents = {
            { title = 'SASP Handbook', url = 'https://docs.google.com/document/d/YOUR-ID' },
            { title = 'SASP Database', url = 'https://docs.google.com/spreadsheets/d/YOUR-ID' },
        },

        -- 7. PERMISSIONS PER GRADE
        Grades = {
            ['0'] = {
                label = 'Trooper',
                permissions = {
                    dashboard_view    = true,
                    profiles_view     = true,
                    profiles_edit     = false,
                    reports_view      = true,
                    reports_create    = true,
                    reports_delete    = false,
                    warrants_view     = true,
                    warrants_create   = false,
                    warrants_delete   = false,
                    vehicles_view     = true,
                    vehicles_edit     = false,
                    convictions_create = false,
                    employees_view    = true,
                    employees_manage  = false,
                    dispatch_view     = true,
                    cameras_view      = false,
                    admin             = false,
                    code_change       = false,
                    custom_fine       = false,
                    custom_sentence   = false,
                    weapons_view      = true,
                    units_view        = true,
                    units_manage      = false,
                }
            },
            ['1'] = {
                label = 'Senior Trooper',
                permissions = {
                    dashboard_view    = true,
                    profiles_view     = true,
                    profiles_edit     = true,
                    reports_view      = true,
                    reports_create    = true,
                    reports_delete    = false,
                    warrants_view     = true,
                    warrants_create   = true,
                    warrants_delete   = false,
                    vehicles_view     = true,
                    vehicles_edit     = true,
                    convictions_create = true,
                    employees_view    = true,
                    employees_manage  = false,
                    dispatch_view     = true,
                    cameras_view      = true,
                    admin             = false,
                    code_change       = false,
                    custom_fine       = true,
                    custom_sentence   = true,
                    weapons_view      = true,
                    units_view        = true,
                    units_manage      = false,
                }
            },
            ['2'] = {
                label = 'Corporal',
                permissions = {
                    dashboard_view = true, profiles_view = true, profiles_edit = true,
                    reports_view = true, reports_create = true, reports_delete = true,
                    warrants_view = true, warrants_create = true, warrants_delete = false,

```

--------------------------------

### Restart XR-MDT Resource

Source: https://docs.xr-core.pl/xr-mdt/guides/adding-business

Ensure the XR-MDT resource is restarted after making configuration changes to apply them. This command is run in the server console.

```bash
ensure xr-mdt
```

--------------------------------

### Toggle MDT Devices and Documents

Source: https://docs.xr-core.pl/xr-mdt/api/server

These exports allow direct control over MDT-related device toggles for players, bypassing item checks for certain functions. The `document` export opens a specific viewer.

```lua
-- Force-open tablet for a player
exports['xr-mdt']:tablet(source)

-- Force-toggle bodycam without item requirement
exports['xr-mdt']:toggleBodycam(source)
```

--------------------------------

### Custom Banking Resource Integration

Source: https://docs.xr-core.pl/xr-mdt/installation

Overrides default Bridge.Bank functions to integrate a custom banking resource. Requires implementing GetBalance, AddMoney, and RemoveMoney.

```lua
function Bridge.Bank.GetBalance(accountName)
    return exports['my-custom-bank']:FetchMoney(accountName)
end

function Bridge.Bank.AddMoney(accountName, amount, reason)
    return exports['my-custom-bank']:AddMoney(accountName, amount)
end

function Bridge.Bank.RemoveMoney(accountName, amount, reason)
    return exports['my-custom-bank']:RemoveMoney(accountName, amount)
end
```
Tokens:
Raw