Requirements#
The server
| Framework | qbx_core (Qbox). qb-core and es_extended bridges are included but have not been tested on a live server. |
| Resources | ox_lib, oxmysql, ox_target, ox_inventory. On qb-core and ESX the bridge falls back to the framework inventory without ox_inventory. Native Qbox (without the qb-core compatibility layer) needs ox_inventory. |
| Server | OneSync enabled. |
| Props | The pickle_casinos props, from your own pickle_casinos download. They are escrowed to Pickle Mods and are not part of this package. A small stream-only resource, glitch-casino-props, ships with it as a template. |
| Licence | A pickle_casinos licence on the Cfx account of the server. glitch-casino is an edition of pickle_casinos by Pickle Mods and replaces it. |
| Database | MariaDB or MySQL through oxmysql. |
| Optional | ox_doorlock (door for /casino on and /casino off), object_gizmo (placement gizmo in the creator), qbx_vehicles (lucky wheel cars), omes_banking, Renewed-Banking, qb-management or qb-banking (house casino society accounts), pickle_xp (lucky wheel xp prizes) |
| Glitch Studios | glitch-treasury (casino tax), glitch-admin (logs), glitch-uiElements (key hints, rigging drawer, item feed), glitch-spawnselector and glitch-cloudsLoading (the chip tracker waits for the spawn), glitch-pauseMenu (casino names in the map legend). None of them is required and each has a fallback. |
Tested with qbx_core 1.24.0, ox_inventory 2.48.0, ox_lib 3.40.0, ox_target 1.17.2, oxmysql 2.14.2 and ox_doorlock 1.22.1.
Installation steps#
Make sure the server's Cfx account owns pickle_casinos. Stop and remove any old
pickle_casinosfolder. Both use the same events and database tables, so they cannot run together.Copy
__INSTALL/glitch-casino-propsinto your resources folder. From your own pickle_casinos download, copy thestreamfolder and the.fxapfile into it. If you rename the folder, setConfigSV.PropsResourceto the new name.Put the
glitch-casinofolder in your resources folder. The folder name is case-sensitive.Add the items.
__INSTALL/Items/ox_inventory.luahas them for ox_inventory and__INSTALL/Items/qbcore.luafor qb-core.__INSTALL/Itemsalso holdsesx_limit.sqlandesx_weight.sqlfor ESX. Copy__INSTALL/Imagesinto your inventory's image folder. The chip item can have any name and you pick it per casino in/casinos; the example item files call itcasino_chips. Use your own images for the chip item andlucky_ticket.Create the tables. They are made when the resource starts. If your database user cannot create tables, run
__INSTALL/install.sqlonce by hand.Add to
server.cfg, after ox_lib, oxmysql, ox_target, your framework and your inventory:ensure glitch-casino-props ensure glitch-casino add_ace group.admin admin allowLook through
config.luaandconfig_sv.lua. At minimum checkConfig.ImageDirectory,Config.Currency,Config.CreatorOptions.stores,Config.LuckyWheel,Config.CasinoSociety,Config.EntryNoticeandConfigSV.OpenClose.Start the server, go to where the casino should be and run
/casinosas an admin. Create the casino, then add a cashier and the games.
[!WARNING] Without the props, tables and machines are invisible. The games stay closed and the console prints
games are closed: the pickle_casinos props are not loadedevery 5 minutes untilglitch-casino-propsruns.
If your server does not accept the .fxap under the new resource name, put the files in a folder called pickle_casinos instead and set ConfigSV.PropsResource = "pickle_casinos".
Permissions#
| Setting | Who it covers |
|---|---|
Config.AdminGroups |
Casino admins: /casinos, /hhscreen, /slotscreen, /mapobjects, /setwheelticket and the owner picker. Framework groups and ACEs. |
ConfigSV.OpenClose.aces |
Who may use /casino on and /casino off. Defaults to admin. The console always can. |
ConfigSV.Rigging.ace |
Who may open /casinoadmin. Defaults to admin. |
Updating#
Replace the resource folder with the new one and keep your own files in profile/. Casinos, tables and machines live in the database and are not touched. Screen positions saved with /hhscreen and /slotscreen, and map props hidden with /mapobjects, are kept in the resource's KVP store, so they survive an update. harbourheist_screen.json, slot_screen.json and mapobjects.json are only the defaults used before the first save. Leave glitch-casino-props as it is.