Studios
Towinghouse-3.jpg

Configuration

SoonTowingQbox
PAGE 03 OF 06  ·  INSTALLATION → CONFIGURATION → EXAMPLESdocs.glitchstudios.dev
Browse docs

Everything is in config.lua, and the file is open in the escrow. So are locales/*.json, shared/utils.lua, client/bridge.lua, server/bridge.lua and sql/.

File What it holds
config.lua Integrations, logs, police and impound settings, the impound form, retrieval, the tow job, the depot, distances, payout checks, call types, spawn points, drop-offs and vehicle models.
locales/en.json Player text, log titles (log_* keys) and the impound form labels (ui_* keys). Copy it to your language code and set setr ox:locale "<code>" to switch language.
client/bridge.lua, server/bridge.lua Every call into another resource: framework, money, keys, vehicle prices, callsigns, logs and the treasury. Edit these to swap a provider.
ui/logo.svg The plain shield on the impound form. Replace it, or point Config.Form.logo at another file or an https URL.

Integrations#

Config.Integrations = {
    taskList      = 'glitch-uiElements',
    vehicleKeys   = 'qbx_vehiclekeys',
    treasury      = 'glitch-treasury',
    crewGroups    = 'sd-phone',
    vehiclePrice  = { 'koja-cardealer', 'qbx' },
    callsignTable = 'phone_mdt_profiles',
    garages       = 'glitch-garages',
    retrieval     = 'auto',
}

Set an entry to false to turn that feature off. vehiclePrice is tried in order and 'qbx' (the qbx_core shared vehicles price) is the last resort. The officer callsign comes from the character's metadata.callsign first. callsignTable is only read while sd-phone runs, and it needs citizenid and callsign or badge columns. retrieval = 'auto' shows the depot retrieval option unless the garages resource is running. Config.Abstraction = 'auto' uses glitch-abstraction when it runs, and false always uses qbx_core.

Logs#

Config.Logs.provider = 'glitch-admin' posts impound logs to glitch-admin's police channel while it runs. Otherwise the resource uses the Discord webhook in Config.Logs.webhook. Leave the webhook empty for no logs, or set enabled = false. Keep the webhook URL out of any file you share.

Police and impounds#

  • Config.impoundTiers is the share of the vehicle price charged per day at each tier: tier1 = 0.01, tier2 = 0.02, tier3 = 0.04. A hold under one day costs half a day.
  • Below Config.rankCustomPrice the server works out the fee itself and ignores the one the form sent. At that grade and above, an officer can type any fee up to Config.maxCustomFee.
  • Config.clampMaxDrift and Config.clampCheckInterval set how far a clamped car may move before the server puts it back, and how often it checks. The check only runs while a car is clamped.
  • Config.lockpickBlockedBags lists entity state bag keys from other scripts that block the police lockpick and the unclamp. The default ctBoost is the key glitch-criminaltablet puts on boosting cars. A key that no script sets does nothing, and {} turns the check off.
  • Config.Form sets the agency name, logo and form number on the impound form.

Tow job#

  • Config.towTruckModel is the truck. Config.payAccount is where tow pay goes (cash). Config.addRadialOption = true adds an End Towing Job item to the ox_lib radial menu during a shift.
  • Config.crew controls the crew bonus. requireShift = true pays a partner only when they are on a tow shift too.
  • Config.rewards.items lists the items given on each paid call, with a percentage chance each.
  • Config.localCallReasons sets the call types, their weights (chance), drop-off lists and pay ranges in dollars. lockedOut calls are lockpick only, with no transport.
  • Config.localCallLocations holds the car spawn points and the house, petrolStation and mechanic drop-offs. Config.jobVehicles lists the models used for civilian calls; they must all be automobile class.

Depot and distances#

Config.locations.startJob holds the depot coords, the ped (s_m_m_trucker_01 with a clipboard), the blip, towTruckSpawn and dropOff, which is both the impound tow drop-off and the police evidence yard. Config.distances holds the radii for the depot, retrieval, ped spawn, clamp, evidence yard, call area and drop-off. Change them together if you move the depot or yard.

Payout checks#

Config.jobSecurity holds the limits the server checks before it pays a driver.

Key Default What it does
arriveDistance Config.jobDistance + 30 Player to job location when the vehicle spawns or is found
documentDistance 15.0 Player to vehicle when the paperwork or lockpick is reported
minDocumentTime 4000 Milliseconds between arriving and documenting
dropOffRadius 40.0 Vehicle to drop-off at completion (keep it above distances.dropOffVehicle)
playerDropOffRadius 75.0 Player to drop-off at completion (keep it above distances.dropOffArrive)
transportedDistance 30.0 How far the vehicle must have left its start spot, capped at half the trip
maxTransportSpeed 30.0 Metres a second, used for the shortest plausible travel time
requireTruck / truckDistance true / 130.0 The tow truck must be this close to the vehicle at completion
minPayoutInterval 30000 Milliseconds between payouts per character
damageThreshold / minPayPercent 150 / 0.4 Health lost (of 1000) before pay is cut, and the lowest share of pay a damaged delivery gets
deliveryTimeout 20 Minutes after documenting before an undelivered call is cancelled
lockedOutDespawn 2 Minutes a finished locked-out car stays before it is removed

config.lua reference#

Setting Default
Config.Debug false
Config.progressType 'Circle'
Config.notificationAnimation 'beatFade'
Config.Abstraction 'auto'
Config.Logs enabled = true, provider = 'glitch-admin', channel = 'police', webhook = ''
Config.PoliceJob 'police'
Config.rankCustomPrice 5
Config.releaseGrade 7
Config.maxCustomFee 1000000
Config.timeToImpound 3000 (ms of paperwork)
Config.timeToImpoundImportant 10 (minutes)
Config.importantVehicleMinutes 360
Config.impoundDistance 15.0
Config.lockpickDistance 6.0
Config.lockpickBlockedBags { 'ctBoost' }
Config.clampMaxDrift 3.0
Config.clampCheckInterval 3000
Config.impoundTiers tier1 = 0.01, tier2 = 0.02, tier3 = 0.04
Config.Form agency = 'POLICE DEPARTMENT', logo = 'logo.svg', formNumber = 'FORM VI-04'
Config.clampProp 'prop_clamp'
Config.Retrieval account = 'cash'
Config.towTruckModel 'towtruck3'
Config.addRadialOption false
Config.payAccount 'cash'
Config.taskListAccent '#36e0f0'
Config.requiredJob false
Config.jobDistance 150
Config.crew enabled = true, bonus = 0.05, radius = 40.0, requireShift = false
Config.rewards metalscrap 3 to 5 (100 percent), cloth 1 to 2 (25 percent)
Config.distances shiftStart = 50.0, retrieval = 15.0, pedSpawn = 60.0, impoundCall = 15.0, yardArrive = 50.0, yardArea = 60.0, yardEvidence = 70.0, truckReturn = 70.0, clamp = 10.0, evidenceOfficer = 30.0, evidenceAbandon = 250.0, callAreaBlip = 60.0, dropOffArrive = 50.0, dropOffVehicle = 25.0
Config.localCallReasons impound $293 to $428; brokenDown (40), transPort (20), outOfFuel (20) $169 to $293; lockedOut (20) $90 to $147
Config.despawnDistance 100
Config.timeToComplete 30 (minutes, keep at 30 or less)
Config.impoundCallOfferTime 15 (minutes)
Config.despawnTimeOut 30 (minutes, keep at 30 or less)