Studios
Racinghouse-3.jpg

Configuration

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

Configuration files#

File Purpose
config.lua Everything you tune: permissions, licences, lobby limits, cars, economy, creators, phone app, manual gearbox, wheel support and integrations.
locales/en.lua Text shown to players.
install/items.lua Item definitions to paste into ox_inventory.
sql/glitch_racing.sql The tables, for servers where the database user cannot create them.

Main keys#

Key Default What it does
Config.Debug false Debug messages in the console. Also lists prop models the server does not stream.
Config.Hub.item 'racing_headset' Usable item that opens the hub. false turns the item off.
Config.Hub.itemRequiredForSpot false true makes the VR spot work only while the player carries the item.
Config.Permissions.host { licence = nil } Licence needed to host a lobby.
Config.Permissions.streetCreator ACE glitch-racing.create Street creator access. Staff and the creator access list also pass.
Config.Permissions.stuntCreator licence A or ACE glitch-racing.stunt Stunt creator access.
Config.Permissions.publish licence B or ACE glitch-racing.create Making a track public.
Config.Permissions.importRockstar ACE glitch-racing.stunt Importing GTA Online jobs by URL. Admins always can.
Config.Licences D, C, B, A, S Each tier has an id, label, level, wins and colour. A player holds the highest tier they meet on both level and wins.
Config.Lobby.maxPlayers 16 Players per lobby. Everything a host sends is clamped to the lobby limits on the server.
Config.Lobby.maxLaps 20 Highest lap count.
Config.Lobby.maxRaceMinutes 45 Hard limit. Anyone still racing after this is a DNF.
Config.Lobby.dnfModes off, first, half When the DNF timer starts. dnfTimer (30000 ms) is how long the rest get.
Config.Lobby.inviteRange 0 0 invites anyone online. Above 0, only players within that many metres.
Config.Lobby.idleTimeout 15 Minutes a lobby that never started stays open.
Config.Buckets.raceBase 7100 The race bucket is this plus the lobby id.
Config.Buckets.creatorBase 7600 The creator bucket is this plus the server id. Pick ranges nothing else uses.
Config.OpenWorld.localsOff parked, traffic and scenarios 0.0, peds 0.3 Density values applied to each racer's client in open world races, through qbx_density.
Config.Personal.requireOwned false true allows only vehicles the driver owns.
Config.Personal.blockedClasses boats, helis, planes, emergency, military, trains Vehicle classes refused in personal car races.
Config.VR.selectTime 30 Seconds to pick a car before a random one is chosen.
Config.VR.sets seven sets Sports, Muscle, Compacts, Super, Off-road, Motorcycles and Open Wheel. Each has a licence and a vehicles list.
Config.Race.countdown 3 Seconds of 3-2-1.
Config.Race.lineup 7000 Milliseconds of grid flyover before the countdown. 0 turns it off.
Config.Race.startGhost 4 Seconds collision races stay ghost after GO.
Config.Race.maxPropsPerTrack 3000 Tracks with more props are refused.
Config.Race.disarm true Puts weapons away when the race loads (ox_inventory).
Config.Race.tough.enabled true VR and track cars dent and scrape but cannot die. Your own car is never affected.
Config.Spectate.modes follow, chase, heli, trackside, hood Camera modes, cycled with cameraKey (C).
Config.Spectate.allowPublicWatch true Anyone can watch a public race in progress from the hub.
Config.Announcer enabled, voice on, 4 lines Text race-control feed with frontend sounds.

Economy#

Key Default What it does
Config.Economy.entryCurrency 'cash' 'bank', 'cash' or an ox_inventory item name such as race_token.
Config.Economy.maxEntryFee 25000 Highest entry fee a host can set.
Config.Economy.houseCut 0.10 Share of the pot removed. Reported to glitch-treasury as a sink when it runs.
Config.Economy.splits 1 finisher: 100%, 2: 70/30, 3: 60/30/10 Pot share by finishing place.
Config.Economy.payout 'bank' Where pot winnings go.
Config.Economy.minPlayersForPayout 2 Solo races never pay out and refund the entry.
Config.Economy.tokenItem 'race_token' Item used for token entry and podium rewards. false turns tokens off.
Config.Economy.tokenRewards 3, 2, 1 Tokens for first, second and third in multiplayer races.
Config.Economy.tokenCooldownSeconds 120 Minimum seconds between token payouts to the same character.
Config.Economy.tokenMinRaceSeconds 45 A shorter race pays no tokens.

An entry fee goes into the pot when the lobby starts. Races with no finisher refund every entry. Entries are also refunded if the resource restarts before the race settles. A prize that cannot be paid right away, for example because the driver went offline, is stored in glitch_racing_pending and paid at their next login. Failed refunds when a lobby closes are queued the same way.

XP#

Config.XP pays through glitch-xpSystem in the racing category. It is off in the package (enabled = false). The amounts are base 40 per finisher, perOpponent 15, positionBonus 60, 35 and 20, dnf 10, soloMultiplier 0.25, personalMultiplier 1.25, maxPerRace 600 and cooldownSeconds 60. factor must match the category's xpFactor in glitch-xpSystem so the level bar on the end screen is right.

Creators#

Key Default What it does
Config.Creator.minCheckpoints 3 Smallest track the creators accept.
Config.Creator.maxTracksPerPlayer 25 Saved tracks per player.
Config.Creator.maxTrackBytes 3145728 A saved track larger than this is refused. A track is also refused over 500 checkpoints.
Config.Creator.maxSessionObjects 3000 Props in a shared editing session.
Config.Creator.maxSyncBytes 262144 Largest creator sync message accepted.
Config.Creator.mirrorThumbnails false true copies thumbnail links to sd-phone's storage so they do not rot.
Config.Creator.cdnHost false Links already on this host are not copied.
Config.Creator.thumbnailHosts {} Optional allowlist of image hosts for copying. Empty allows any public https host. Local and IP hosts are always skipped.
Config.Creator.propPhotoBase false Prop photo link for the stunt prop browser. @@MODEL@@ is replaced with the model name. glitch-shotMaker provides its own when it runs.
Config.Creator.importSearchMax 40 Highest job file number tried by the GTA Online import fallback.
Config.Creator.streetProps eleven props Props the street creator can place.

VR spots and phone app#

Config.VRZones is a list of ox_target boxes (label, coords, heading, size, blip) that open the hub in VR mode. The shipped entry is a sample position, so move it. In VR mode players race VR or track cars in a private world only, and non-admins are held to that on the server. Config.VRRange (10.0) is how close non-admins must be to a VR spot to host or accept invites, and Config.VRLeaveRange (50.0) removes them from a waiting lobby when they walk away.

Config.Street controls the sd-phone app: enabled, identifier, name, description, defaultApp (false means installed from the App Store), item ('racing_usb', or false for everyone) and startRange (200 m from the start line when the host starts).

Manual gearbox and wheel#

Config.Manual holds the gearbox: enabled, the command name (false removes the command), default keys, clutch rules, stalling, launch control, exhaust pops, the rev limiter and money-shift damage. Config.Wheel is off by default and needs a helper program on the player's PC. Both blocks are commented in config.lua.

Integrations#

Config.Integrations has one switch per optional resource: glitch-admin, glitch-arcade, glitch-mapHandler, glitch-treasury, glitch-xpSystem, glitch-audioProps, glitch-shotMaker and sd-phone, plus pauseMenuLegend. It also holds creatorRoleDefault (Discord role names for the Track Creator option through glitch-admin's role gate) and staffLevels (glitch-admin level numbers). Change creatorRoleDefault to your own role names, or the option stays limited to staff.