Studios
Racinghouse-3.jpg

Installation

SoonRacingQbox
PAGE 02 OF 06  ·  OVERVIEW → INSTALLATION → CONFIGURATIONdocs.glitchstudios.dev
Browse docs

Requirements#

The server

Framework qbx_core (Qbox). ESX and plain QBCore are not supported.
Resources ox_lib, oxmysql, ox_inventory, ox_target
Menus glitch-uiElements (free Glitch Studios resource). It draws the hub, the car selector and the key hints. The console prints an error on start when it is missing or not started.
Database MariaDB or MySQL 8. The tables are created on start.
Used when present qbx_vehiclekeys (race cars get keys), qbx_density (open world traffic), Renewed-Weathersync (weather is handed back after a private race)
Optional sd-phone, glitch-xpSystem, glitch-admin, glitch-arcade, glitch-mapHandler, glitch-treasury, glitch-shotMaker, glitch-pauseMenu, glitch-hud, glitch-audioProps

The package was tested with qbx_core 1.24.0, ox_inventory 2.48.0, ox_lib 3.40.0, ox_target 1.17.2 and oxmysql 2.14.2.

Each optional resource is detected at run time and its feature is skipped when it is not running. Config.Integrations can switch each one off even when it runs. Without glitch-xpSystem, licence tiers are judged by wins alone.

Installation steps#

  1. Copy the glitch-racing folder into your resources folder. The name is case-sensitive and the manifest and exports expect exactly glitch-racing.
  2. Add the three items from install/items.lua to ox_inventory/data/items.lua: racing_headset, race_token and racing_usb.
  3. The tables listed in sql/glitch_racing.sql are created when the resource starts. If your database user cannot create tables, run that file once by hand.
  4. Add the resource to server.cfg after its dependencies:
ensure oxmysql
ensure ox_lib
ensure qbx_core
ensure ox_inventory
ensure ox_target
ensure glitch-uiElements
ensure glitch-racing
  1. Permissions. Staff come from the admin ACE, and from mod or moderator. To let a player use the creators without the matching licence, give them an ACE in server.cfg:
add_ace identifier.license:YOUR_LICENSE glitch-racing.create allow
add_ace identifier.license:YOUR_LICENSE glitch-racing.stunt allow
  1. Open config.lua and set Config.VRZones to where the VR Racing spot should be. It is an ox_target box. Players can also open the hub with the headset item.
  2. Start the server, walk up to the spot or use the headset, and run a test race with a throwaway character.

Back up the database before the first install on a live server. The stunt creator stores whole tracks as JSON, and pot money moves through your framework.

Updating#

  • Back up config.lua and the glitch_racing_* tables first.
  • Replace the resource files, then merge any new keys from the new config.lua into yours. config.lua, the locale file, sql/, install/ and the README are not encrypted, so your edits stay readable.
  • Add any new items from install/items.lua.
  • Restart the resource. Missing tables are created on start. Snap points taught in the stunt creator live in the resource KVP and are kept.
  • Restart glitch-racing after restarting any of its dependencies.