Studios
Mechanic Menuhouse-3.jpg

Installation

SoonMechanic MenuQbox
PAGE 02 OF 07  ·  OVERVIEW → INSTALLATION → CONFIGURATIONdocs.glitchstudios.dev
Browse docs

Requirements#

Framework qbx_core (Qbox) with qbx_vehicles. ESX and plain QBCore are not supported.
Resources ox_lib, oxmysql
Server A FiveM server artifact with OneSync enabled.
Database The player_vehicles and players tables that Qbox already creates. The resource adds no tables and writes only through qbx_vehicles.
Optional glitch-admin (presets, car photo in the header, default log sink), glitch-photos (part photos), glitch-mechanicJob (Extras rows, engine and turbo sound pickers), glitch-emergencyVehicles (emergency light groups), glitch-uiElements (key hint bar), al_lightbars (airhorn on emergency cars), glitch-poolcleaning (net event guard reports)

It was tested with qbx_core 1.24.0, qbx_vehicles 1.4.2, ox_lib 3.40.0 and oxmysql 2.14.2.

The fonts and icons ship inside the resource. The rim photos from Config.PhotoCdn are the only thing the menu loads from outside it, and setting that to '' stops them too.

Installation steps#

  1. Put the glitch-mechanicMenu folder in your resources folder. The folder name is case-sensitive, and other resources call the exports by that name.

  2. There are no items, images or SQL files to install.

  3. Add to server.cfg, after ox_lib, oxmysql, qbx_core and qbx_vehicles, and after any optional integrations you run:

    ensure ox_lib
    ensure oxmysql
    ensure qbx_core
    ensure qbx_vehicles
    ensure glitch-mechanicMenu
    
  4. Give your staff the command. Config.Restricted is group.admin, and ox_lib adds the command.glitchmechanic ACE for that group when the resource starts. Anyone in the group can open the menu, save and use presets:

    add_principal identifier.license:YOUR_LICENSE group.admin
    
  5. Open config.lua and set each entry in Config.Integrations that you do not run to false. Empty Config.LegacyPayCallbacks and Config.NoExtrasModels unless the names in them exist on your server.

  6. If another resource already streams the gen9 paints (qbx_customs, for example), delete the two data_file lines in fxmanifest.lua along with the paints and stream folders, so the paints load only once.

  7. Restart the server, get in a car you own and type /glitchmechanic.

[!NOTE] Saving writes the full ox_lib properties of the car to the mods column of player_vehicles through qbx_vehicles. Back up your database before you try it on a live server.

Commands#

Command Who What
/glitchmechanic Config.Restricted (group.admin) Open the customiser for the car you are in, save the look to the owner and use presets

Updating#

Keep a copy of config.lua and any locale files you added or edited, replace the rest of the folder, then merge your settings into the new config.lua. The resource has no database changes to apply. Read CHANGELOG.md first: in 1.2.0, Config.RequirePaidConfirm became true by default, so paid workshop callbacks must now call ConfirmSessionPaid.