Requirements#
The server
| Framework | qbx_core (Qbox). ESX and plain QBCore are not supported. |
| Resources | ox_lib, ox_target, ox_inventory |
| Server | FiveM artifact with OneSync enabled |
| Database | None |
| Tested with | qbx_core 1.24.0, ox_inventory 2.48.0, ox_lib 3.40.0, ox_target 1.17.2 |
| A heist resource | The engine has no heists of its own. Install one that registers a definition, or write your own (see Examples). |
Optional resources (detected at run time; the matching feature is skipped when one is not running)
glitch-minigames |
Needed by any step with a hacking, drilling or lockpick phase. Those steps refuse to start without it. |
ox_doorlock |
Doors with kind = 'ox' |
ps-dispatch |
Police alerts. A plain notification and blip are used without it. |
glitch-criminaltablet |
Contracts, lineups, the server-wide heist slot and REP (Config.Tablet) |
glitch-xpSystem |
XP and perk effects (Config.XP) |
glitch-crafting |
Job loot rolls |
glitch-economy |
Crime bookkeeping |
glitch-admin |
Log channel and the glitchTestingMode state bag |
glitch-abstraction |
Money and player helpers on non-Qbox setups |
glitch-uiElements |
On-screen task list, key hints and the editor's wardrobe look |
glitch-notifications |
Objective notifications |
rc-interactions |
Dialogue before a start step (Config.Interactions) |
| Clock resource | Renewed-Weathersync or another resource that publishes the hour in a state bag (Config.Clock) |
Installation steps#
Put the
glitch-heistEditorfolder in your resources folder. The folder name is case-sensitive.There are no items to add, no SQL to run and no images to copy.
Add to
server.cfg, after ox_lib, ox_target, ox_inventory and qbx_core, and before any resource that registers heists:ensure ox_lib ensure ox_target ensure ox_inventory ensure qbx_core ensure glitch-heistEditor # your heist resources go hereGive your staff the editor:
add_ace group.admin command.heisteditor allow add_principal identifier.license:YOUR_LICENSE group.adminCheck
Config.DirtyMoneyandConfig.PoliceJobsinconfig.luaagainst your server.Start the server and run
/heisteditor.
[!NOTE] The resource writes to its own
datafolder. The package ships it empty. Do not copy another server'sdatafolder into yours.
Commands#
| Command | Who | What |
|---|---|---|
/heisteditor |
command.heisteditor |
Open the editor |
/heistreset [heist] |
Config.Restricted |
End every running heist as failed and clear cooldowns, or only the named heist |
Updating#
Keep the data folder and your config.lua changes, replace everything else and restart the resource. Heist resources register again whenever the engine restarts, so they need no restart of their own.