Installation

Requirements

QBCore, Qbox, or ESX framework
ox_lib — callbacks, zones, notify, progress, skill checks
ox_inventory — loot rewards and required tools
ox_target — interaction zones at house entrances (or qb-target)
oxmysql — database access
qb-core — bridge dependency for GetCoreObject() on Qbox stacks
rm-lib — mission/progress UI during robberies

Optional (recommended):

cd_dispatch or ps-dispatch — police alerts (Config.Dispatch)
tgg-minigames — richer lockpick/hack minigames (falls back to ox_lib skill checks if not running)

Step 1 — Upload the resource

Place the rm-houserobbery folder into your server's resources directory:

resources/
  [rm-scripts]/
    rm-houserobbery/

Step 2 — Add to server.cfg

ensure ox_lib
ensure oxmysql
ensure ox_inventory
ensure ox_target
ensure qb-core
ensure rm-lib
ensure rm-houserobbery

Make sure rm-houserobbery starts after all dependencies.

Step 3 — Configure the script

config/config.lua

Framework — Config.Framework: 'qbox', 'qb', 'qb-core', or 'esx'
Language — Config.Lan: matches a key in locales/*.lua (e.g. 'en')
Target — Config.Target: 'ox_target' or 'qb-target'
Dispatch — Config.Dispatch: 'cd_dispatch', 'ps-dispatch', or false
Robbery hours — startHours / endHours (in-game clock window)
Police — MinimumPolice, PoliceJobs, dispatch chances for lockpick success/fail
House tiers — requiredHackingDeviceByLevel, houseTierInteriors, loot in LootItems / RewardItemCountByLevel
House Thief XP — Config.HouseThiefXp:
- enabled — master toggle for the built-in XP skill
- autoCreateTable — if true, auto-creates the XP table on start (requires DB CREATE privilege)
- baseXpPerLevelStep, levelCommand, levelCommandEnabled — progression curve and /level command

config/houselocations.lua

House entrance coordinates and house list — merged into Config at load.

See Configuration for the full reference.

Step 4 — Database

Either:

Leave Config.HouseThiefXp.autoCreateTable = true and ensure your DB user can create tables, or
Run install/house_thief_xp.sql manually (HeidiSQL / phpMyAdmin) if you prefer not to auto-create.

Ensure your oxmysql connection string in server.cfg points at the correct database.

Step 5 — Add items to ox_inventory

Merge install/ox_items.txt into ox_inventory/data/items.lua so every item referenced in Config.LootItems and your tools (lockpick, houselaptop, mansionlaptop, etc.) exists with matching names. Adjust weights and labels to match your economy.

Step 6 — Restart the server

Perform a full restart so dependencies, the database, and the resource load cleanly. Players use ox_target (or qb-target) at configured entrances during robbery hours.

Troubleshooting

Problem	Fix
Target options missing	Ensure `ox_target` (or `qb-target`) starts before `rm-houserobbery`; check `Config.Target`
Loot / items error	Confirm `ox_inventory` is running; add all items from `install/ox_items.txt`
Database / "table" errors	Run `install/house_thief_xp.sql` manually, or enable `autoCreateTable` and grant `CREATE` on the DB
Wrong language	Set `Config.Lan` to a key that exists in `locales/*.lua`
Dispatch not firing	Check `Config.Dispatch` and that `cd_dispatch` / `ps-dispatch` is started
Minigames always fallback	Install `tgg-minigames` or rely on `ox_lib` skill checks
rm-lib errors	Ensure `rm-lib` is installed and started before `rm-houserobbery`

Config file reference

File	Purpose	Editable
`config/config.lua`	Framework, language, target, dispatch, hours, police, loot, XP	Yes
`config/houselocations.lua`	Entrance coords and house definitions	Yes
`locales/*.lua`	UI strings	Yes
`opensource/server/server.lua`	Bridge, XP + SQL, optional webhook	Yes (opensource)
`opensource/client/client.lua`	Bridge, minigame fallbacks	Yes (opensource)
`install/house_thief_xp.sql`	Manual DB schema for House Thief XP	Optional
`install/ox_items.txt`	Example ox_inventory item definitions	Merge into your items

Installation

On this page