Requirements#
The server
| Framework | qbx_core (Qbox). ESX and plain QBCore are not supported. |
| Resources | ox_lib, ox_target, ox_inventory, ox_doorlock |
| Heist engine | Glitch Heist Editor (glitch-heistEditor). It runs the heist and is a separate product. |
| Minigames | Glitch Minigames (glitch-minigames), for the hacking and drilling games. |
| Database | None. The package creates no tables. Doors live in ox_doorlock's own table. |
| Optional | glitch-securityCameras (camera steps), vSync (blackout), glitch-criminaltablet (the casino_diamond contract), glitch-xpSystem (heisting XP and perks), ps-dispatch (police alert) |
The optional resources are detected at run time. When one is missing, the matching feature is skipped.
Installation steps#
Install the required resources above and start them before this one.
Put the
glitch-casinoHeistfolder in your resources folder. The folder name is case-sensitive and must match exactly.Add the items from
install/items.luatoox_inventory/data/items.lua. Skip any item your server already has, such asgoldbar,diamondanddrill. Add the weaponWEAPON_BZGAStoox_inventory/data/weapons.luaif you do not have it (the definition is in the comments at the bottom ofinstall/items.lua). The package ships no item images.Create the 35 casino doors in ox_doorlock and put their ids in
Config.Doors(see Doors below).Replace the ids in
Config.CameraIdswith the ones you registered in glitch-securityCameras, if you use it.Add to
server.cfg, after the required resources:ensure ox_lib ensure ox_target ensure ox_inventory ensure ox_doorlock ensure glitch-minigames ensure glitch-heistEditor ensure glitch-casinoHeistRestart the server. Five seconds after start the console prints
[glitch-casinoHeist] ready on the heist engine, or lists what is missing.Open
/heisteditor, pick Diamond Casino and check that the definition loaded.
Items#
shaped_charge, casino_blueprints, casino_vault_keycard, drill, trojan_usb, hacking_laptop, rappel_equipment, casino_usbdevice, casino_penthouse_key, casino_vault_key_one, casino_vault_key_two, goldbar, diamond and the weapon WEAPON_BZGAS. The start-up check warns about every item that ox_inventory does not know.
Doors#
The run opens doors through ox_doorlock. install/doors.json is empty ({}) in this package, so on a new server you create the 35 doors yourself. The names are the keys of Config.Doors. Each entry is either an ox_doorlock id (a number) or a door name (text).
- Number: the door already exists on your server. The ids in
config.luaare rows from the developer's own database, so replace every one with your own. - Name: put a name such as
'casino_vault'inConfig.Doors. If ox_doorlock has no door with that name,server/doors.luacreates it from the entry with the same name ininstall/doors.jsonat start-up and registers the heist again. The console says how many were created, or which ones have no entry.
To use the name path, fill install/doors.json yourself, keyed by door name. Each value is an ox_doorlock door table (coords, model, heading, state, maxDistance, and doors for double doors). The simplest route is to create the doors in the ox_doorlock editor and put their ids in Config.Doors.
Permissions#
The package adds no ACE entries and no commands. /heisteditor belongs to Glitch Heist Editor, so give your admins the permission described in that resource's documentation.
Updating#
Back up config.lua and any door data you filled in, replace the other files, then compare the new config.lua with yours and merge any new keys. Restart glitch-casinoHeist. The files listed in escrow_ignore in fxmanifest.lua are the ones you can edit: config.lua, install/items.lua, install/doors.json, heist/casino.lua, client/cameras.lua, the README, LICENSE and CHANGELOG. Changes you make to the definition in /heisteditor are saved by the engine, not by this package.