Everything lives in shared/config.lua. Keys and webhooks go in server/custom/apiKeys.lua, which only the server loads.
General#
| Key | Default | Description |
|---|---|---|
Config.Debug |
false |
Prints debug messages. |
Config.Framework |
'auto' |
'qbx', 'qb', 'esx' or 'auto'. |
Config.UnemployedJob |
'unemployed' |
QBCore and ESX: the job someone gets when they are fired. On Qbox firing only removes the business job. |
Config.MenuExtraItems |
{ 'paperbag' } |
Shared items every business may put on its menu, next to its own <job>_ items. |
Config.ItemImagePath |
inventory:imagepath convar |
Where item images are served from. Defaults to nui://ox_inventory/web/images. |
Config.Logs |
true |
Posts tablet changes to the Discord webhook in server/custom/apiKeys.lua. false turns logs off. Change the post itself in server/custom/logs.lua. |
Where the tablet opens#
| Key | Default | Description |
|---|---|---|
Config.UI.Mode |
'auto' |
'sd-tablet', 'lb-tablet', 'standalone' or 'auto'. Auto uses sd-tablet or LB Tablet when one is installed, otherwise standalone. The tablet never opens on a phone. |
Config.UI.Command |
'businesstablet' |
Standalone only. Opens and closes the tablet. false removes the command. |
Config.UI.Key |
'' |
Standalone only. Default key for the command. Players can change it in their key bindings. |
Config.UI.Theme |
'dark' |
Standalone only. 'dark' or 'light'. |
Config.UI.Animation |
true |
Standalone only. The player holds a tablet prop while it is open. |
Ranks, commission and permissions#
| Key | Default | Description |
|---|---|---|
Config.Roles.AllowSalaryEdit |
false |
Lets the boss change each rank's salary. Off by default because framework paychecks are paid by the server, not the business. |
Config.Roles.MaxSalary |
500 |
Highest salary the boss can set. |
Config.Roles.MaxGrades |
10 |
Most ranks a business can have. |
Config.DefaultCommissions |
{ 20, 25, 30, 35, 40, 45 } |
Commission percent per rank (lowest first) until the boss sets their own. Ranks past the end use the last value. |
Config.DefaultPermissions |
see below | What a rank may do until the boss changes it on the Permissions page. |
On Qbox and QBCore, rank edits are saved by the tablet and applied again on every start, so the framework's job file is never rewritten. On ESX they go into job_grades, which needs an ESX Legacy version with ESX.RefreshJobs. No framework files need editing.
[!WARNING] On Qbox,
qbx:cleanPlayerGroupsmust be"false"(see Installation). With it on, staff on ranks made on the tablet lose the job at every restart.
The top grade is the boss and always has every permission. These permissions can be given to the other ranks:
| Permission | Allows |
|---|---|
view_dashboard |
Seeing the dashboard. On by default. |
view_staff |
Seeing the staff list. On by default. |
manage_staff |
Hiring, firing and changing ranks, handing out application forms. |
pay_staff |
Paying wages owed and changing auto-pay. |
view_transactions |
Seeing the transaction history. On by default. |
add_transactions |
Ringing up sales on New sale. On by default. |
view_menu |
Seeing the menu. On by default. |
manage_menu |
Adding, editing and removing menu items. |
view_commissions |
Seeing commission rates. |
manage_commissions |
Changing commission rates. |
manage_roles |
Renaming, adding and removing ranks. |
manage_permissions |
Changing what each rank may do. |
view_blacklist |
Seeing the blacklist. On by default. |
manage_blacklist |
Adding and removing blacklist entries. |
view_communications |
Reading announcements and alerts. On by default. |
manage_communications |
Posting, pinning and removing announcements, and seeing who read them. |
view_logs |
Seeing the activity log. |
view_members |
Seeing memberships. |
add_members |
Selling memberships. |
manage_memberships_actions |
Cancelling and changing memberships. |
manage_memberships |
Editing membership tiers. |
use_loyalty |
Looking up loyalty cards and redeeming rewards. On by default. |
manage_loyalty |
Changing the stamps needed and the reward. |
A business can add permissions of its own, such as using a work vehicle, when it registers. They show on the Permissions page under their own group. See Registering a Business.
Loyalty cards and the customer phone app#
| Key | Default | Description |
|---|---|---|
Config.Loyalty.stamps |
10 |
Paid orders for one reward, used when a business leaves it out. |
Config.Loyalty.reward |
'Free meal' |
What the reward is called. |
Config.Loyalty.minSpend |
10 |
An order must total at least this to earn a stamp. |
Config.BusinessApp.enabled |
true |
sd-phone apps for businesses that turn on features.app, loyalty or ordering. |
Config.BusinessApp.prefix |
'glitch-biz-' |
App identifier prefix. The full identifier is the prefix plus the job name. |
Config.OpenNotice.cooldown |
1200 |
Seconds between "we're open" phone notices from the dashboard, shared by all staff of a business. |
Config.OpenNotice.body |
'We are open! Come and see us.' |
Text of that notice. |
Integrations#
| Key | Default | Description |
|---|---|---|
Config.Integrations.Banking |
'auto' |
Business accounts: 'omes_banking', 'Renewed-Banking', 'qb-banking', 'qb-management', 'okokBanking', 'esx_addonaccount' (society_<job> accounts) or 'custom'. Auto uses the first one running. |
Config.Integrations.Billing |
'auto' |
Invoices for billed sales and memberships: 'sd-phone' or your own in server/custom/billing.lua. With no billing resource, billing is turned off. |
Config.Integrations.Phone |
'auto' |
Phone numbers, paycheck texts and bank app rows: 'sd-phone', 'lb-phone' or 'none'. With none, paycheck notices show as notifications. |
To add a resource that is not listed, set the option to 'custom' where it exists and edit the matching file in server/custom/.
Payroll#
| Key | Default | Description |
|---|---|---|
Config.Payroll.Mode |
'auto' |
'bank' pays wages straight into the employee's bank. 'collect' (Qbox only) leaves a paycheck to collect at the bank, which needs a banking resource that pays out pendingPaychecks, such as omes_banking. Auto picks collect on Qbox with omes_banking running, otherwise bank. |
Config.Payroll.CollectMessage |
'Your paycheck from %s (%s) is waiting at Darlinghurst Bank.' |
Phone text in collect mode. The first %s is the business, the second the amount. Change the bank name to your own. |
Config.Payroll.TextSender |
{ number = '7220', name = 'Pacific Standard' } |
Who the paycheck text comes from. |
Config.Payroll.BankLabel |
'%s wages' |
Bank statement line in bank mode. |
The boss sets auto-pay (on or off, day of the week and time) on the Payroll page.
Keys and image links#
server/custom/apiKeys.lua holds the Discord webhook for Config.Logs and an optional Cloudflare R2 bucket (AccountId, AccessKeyId, SecretAccessKey, Bucket, PublicUrl). With R2 filled in, image links pasted on the tablet (menu screens, shop artwork) are copied to your bucket so they keep working after the original link expires. Without it the link is saved as pasted.