For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuration

Configuration is split across three layers:

  • shared/main_config.lua — global, server-wide settings (framework, money, daily featured, level system, admins, locale strings).

  • shared/ui_config.lua — UI defaults and web locale strings sent to the tablet UI.

  • shared/jobs/<jobId>.lua — per-job content (reward, dialog, taskbar, blips, vehicle, locations).

Framework

Config.framework = {
    name = "auto",          -- "esx" | "qb" | "auto" (auto-detects)
    targetScript = "ox_target", -- "ox_target" | "qb-target" | "qtarget"
    useOxNotify = true,     -- send notifications via ox_notify
    debug = false,          -- enable verbose debug + zone outlines
}

Money

Config.moneyOptions = {
    moneyName = "money",
    moneyIsItem = false,
}

The featured job is deterministic — picked from a sorted, alphabetical pool seeded by the UTC date, so all players see the same featured job and a server restart never changes it within the same day.

Vehicle Cleanup

General

Admins

Listed identifiers gain access to the in-game admin panel (KPIs, charts, per-job stats, job config, lobby view, and the job editor).

Bucket Retention

Per-job Configuration (Shared Structure)

Every job in shared/jobs/ follows the same skeleton. Example from shared/jobs/cleaner.lua:

Last updated