Studios
House Robberyhouse-1.jpg

Installation

House RobberyQBCore · Qbox · ESX
PAGE 02 OF 06  ·  OVERVIEW → INSTALLATION → CONFIGURATIONdocs.glitchstudios.dev
Browse docs
cfgQuick start · server.cfg order
# start your framework after its own dependencies
ensure oxmysql
ensure ox_lib
ensure qbx_core
ensure ox_inventory
ensure ox_target
ensure glitch-abstraction
ensure glitch-houserobbery

Requirements#

The server

Framework qbx_core (Qbox). ESX and plain QBCore are not supported.
Resources ox_lib, oxmysql, ox_target, ox_inventory, glitch-abstraction (the Glitch Studios bridge for framework, inventory and target calls)
Interior shells The shells named in config/shells.lua and config/tiers.lua (for example modernhotel_shell, standardmotel_shell, furnitured_midapart, t2_furn_shell and t3_furn_shell). Shells are not included. A shell that is not installed is reported in the server console and skipped.
Database MariaDB 10.3 or newer. No SQL import is needed.
Optional glitch-minigames, glitch-criminaltablet, glitch-xpSystem, glitch-uiElements, glitch-admin, glitch-economy, glitch-crafting, sd-phone, MugShotBase64, rc-interactions, ps-dispatch or cd_dispatch

Optional resources are detected at run time. When one is not running, the matching feature is skipped.

Resource What it adds
glitch-minigames The lockpick minigame. Without it the door uses an ox_lib skill check.
glitch-criminaltablet Area contracts, REP, heat and crew handling. Without it the contact NPC pays the job.
glitch-xpSystem The Burglary XP category and skill tree, including the tier perks. Without it nothing is gated.
glitch-uiElements The in-robbery task list, key hints and the admin page skin.
glitch-admin Staff log entries.
glitch-economy Payout tracking.
glitch-crafting The cache roll in Config.Standalone.cacheDrops.
sd-phone Dodge as a phone contact who texts the address (Config.Phone).
MugShotBase64 Photographs Dodge's face once, only when Config.Standalone.captureFace is on.
rc-interactions Dialogue with the contact and with awake homeowners.
ps-dispatch or cd_dispatch Police alerts. Without one the resource shows a built-in blip and notification to on-duty police.

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.

Installation steps#

  1. Put glitch-houserobbery and glitch-abstraction in your resources folder. The folder name glitch-houserobbery is case-sensitive and must not be renamed.

  2. Add the items in install/ox_inventory_items.lua to ox_inventory/data/items.lua. The loot items use common item codes (laptop, rolex, toaster and so on), so check which ones your inventory already has. The stolen_* items carry the Disassemble button.

  3. Add the shells you own to config/shells.lua and list them per tier in config/tiers.lua.

  4. Set your police job names in Config.Police.jobs and your payout item in Config.Standalone.payout.

  5. Add the resource to server.cfg after its dependencies:

    ensure ox_lib
    ensure oxmysql
    ensure qbx_core
    ensure ox_target
    ensure ox_inventory
    ensure glitch-abstraction
    ensure glitch-minigames
    ensure glitch-uiElements
    ensure glitch-xpSystem
    ensure glitch-criminaltablet
    ensure glitch-houserobbery
    add_ace group.admin command.houserobsadmin allow
    
  6. Optional: for the rc-interactions dialogue, import rc-interactions/glitch_houserobbery.json in /interactioneditor and press Save.

  7. Restart the server. Watch the console for shells that are reported as not installed.

Progress that must survive a restart (met-Dodge flags and chain-drop bad luck counters) is kept in resource KVP. The only database access is the optional sd-phone contact, which is inserted into sd-phone's phone_contacts table. Set Config.Phone.enabled = false to skip it.

[!NOTE] config/, locales/, install/, data/ and rc-interactions/ stay open under escrow, so you can edit them freely.

Updating#

Replace everything except config/, locales/ and data/, then merge any new keys from the new defaults into your own config files. Keep data/layouts.json (shell layouts saved in the city), data/admin.json (overrides saved by the admin menu) and data/dodge.json. Restart glitch-houserobbery after its dependencies.