Studios
Hide & Seekhouse-3.jpg

Installation

SoonHide & SeekQBCore · Qbox · ESX
PAGE 02 OF 06  ·  OVERVIEW → INSTALLATION → CONFIGURATIONdocs.glitchstudios.dev
Browse docs

Requirements#

  • ox_lib
  • ox_target (qb-target is used as a fallback if ox_target is not running)
  • A framework. Tested on Qbox. QBCore and ESX bridges are included but untested.
  • oxmysql is only needed if your framework stores saved positions in SQL. Stats do not use SQL.

Optional integrations#

None of these are needed. Each one is picked up automatically when its resource is started, and you can turn any of them off in Config.Integrations.

Resource What it adds
glitch-arcade Arcade machines open the lobby, and arcade zones count as the lobby area
glitch-mapHandler Maps with a world (the Rust map needs it)
glitch-cloudsLoading Sky swoop when moving into the map (otherwise a plain screen fade)
glitch-uiElements Key hints on the left while spectating
glitch-abstraction Notifications and money through your own abstraction layer
glitch-ambulancejob Revive for downed players. qb-ambulancejob and esx_ambulancejob are also tried
pma-voice Seekers radio
bob74_ipl Interiors for the Bunker, Doomsday Facility, Nightclub, Hangar and Vehicle Warehouse maps

A map with a requires field in config.lua is left out of the vote when that resource is not started. Maps that work out of the box with no extra resources: Server Farm, Casino Back Rooms and Morgue. Maps that need bob74_ipl: Bunker, Doomsday Facility, Nightclub, Hangar and Vehicle Warehouse. The Rust map needs a map-handler resource and the Rust map files, which are not shipped with this package, so it is skipped automatically unless you add them. Without them you still have Server Farm, Casino Back Rooms and Morgue.

Installation steps#

  1. Put the glitch-hideseek folder in your resources folder.

  2. Add this to server.cfg, after ox_lib, ox_target, your framework and any optional resources above:

    ensure ox_lib
    ensure ox_target
    ensure glitch-hideseek
    
  3. Open config.lua and set Config.Lobby (see below). The package ships with placeholder coordinates (0, 0, 0) and Config.LobbyConfigured = false. Until you set the lobby and change that to true, the script prints a console message and the board, target and lobby callbacks stay off.

  4. Make sure the data/ folder is writable by the server. Saved play areas are written to data/zones.json.

  5. Restart the server, or run refresh and ensure glitch-hideseek.