Configuration

All configuration lives in two editable files: shared/settings.lua and shared/creator.lua. Everything else (jobs, grades, permissions, locations, store items, outfits) is configured in-game through the Boss Creator and saved to the database.

Bridges#

Every bridge auto-detects the first supported resource that is running, in the priority order shown — or can be forced to a specific resource name.

Settings.Appearance = 'auto'  -- clothing/appearance resource used for outfits
-- auto priority: illenium-appearance > fivem-appearance > bl_appearance
--   > crm-appearance > rcore_clothing > codem-appearance > tgiann-clothing
--   > qb-clothing > esx_skin > skinchanger
 
Settings.Inventory = 'auto'   -- inventory used for stashes, store items, deliveries
-- auto priority: tgiann-inventory > qb-inventory > qs-inventory > ps-inventory
--   > ox_inventory > origen_inventory > core_inventory > codem-inventory
 
Settings.Society = 'auto'     -- where the society/job money lives
-- auto priority: bablo-banking > qb-management > esx_addonaccount

Salary system#

The resource can take over salary payouts from the framework, so bosses can set per-grade salaries in the boss menu and creator.

Settings.SalarySystem = {
    enabled = true,        -- master switch for the custom salary payout system
    intervalMinutes = 10,  -- how often salaries are paid out
    societyFunded = false, -- true = paychecks come out of the job's society money (skipped when it cannot afford)
    offDutyPay = false     -- true = also pay employees who are off duty (QBCore/Qbox duty system)
}
 
Settings.SalaryLimit = 25000 -- highest salary a grade can be given from the boss menu / creator

enabled = true — the resource pays every online employee on its own timer. A grade uses the custom salary set for it in the boss menu / creator; grades with no custom salary fall back to the job’s default framework payment, and jobs without a boss menu are paid their normal framework salary.

enabled = false — nothing here pays out and the “Set Salary” action is hidden in the boss menu. The framework handles salaries exactly as it did before (grade salaries set in the creator are still written into the job data, so the framework’s own paycheck keeps using them).

Wardrobe duty#

Settings.WardrobeOnDuty = false -- put employees on duty when they equip a job outfit from a wardrobe

When enabled, equipping a job outfit from a wardrobe also sets the employee on duty through the framework, so putting on the uniform is enough to clock in. Uses the QBCore/Qbox duty system — it has no effect on ESX.

Outfit accessories#

Settings.OutfitProps = {
    hats = true,       -- uniform hats and helmets apply with the outfit
    glasses = false,   -- false = personal, the employee keeps their own
    ear = false,
    watches = false,
    bracelets = false
}

Outfits never change who the employee is — face, hair and tattoos always stay their own. This setting controls the accessory props on top of that: anything set to false is treated as personal, so equipping a uniform never puts the outfit creator’s watch or earrings on the employee and never removes the employee’s own. Set a part to true if your uniforms include it (aviators for a motorcycle unit, for example).

Store deliveries#

Settings.OrderCheckMinutes = 10 -- how often the server checks for due store orders

Orders are stored with a delivery time; this only controls how often that list is polled. An order can therefore land up to this long after its delivery time (a 2-minute item on a 10-minute check arrives in 2–12 minutes). Lower it for punctual deliveries, raise it to do fewer database queries.

History retention#

Old statistics rows are deleted automatically on startup:

Settings.RevenueHistoryDays = 30      -- how long to keep revenue data (in days)
Settings.AttendanceHistoryDays = 14   -- how many days of attendance history to keep
Settings.TransactionHistoryDays = 30  -- how many days of transaction history to keep

Debug#

Settings.Debug = true -- verbose console logging

Boss Creator command#

Configured in shared/creator.lua:

Creator.Command = "bosscreator"    -- the command that opens the Boss Creator
 
Creator.UsePermissions = true      -- false = everyone can use the command
Creator.Permissions = {
    "admin",
    "superadmin"
}

On QBCore and Qbox, the listed groups are checked against framework permissions and ace permissions (god, admin and command are always accepted as well). On ESX, the player’s group must exactly match one of the listed groups.