Studios
Hide & Seekhouse-3.jpg

Configuration

SoonHide & SeekQBCore · Qbox · ESX
PAGE 03 OF 06  ·  INSTALLATION → CONFIGURATION → EXAMPLESdocs.glitchstudios.dev
Browse docs

Everything is in config.lua. The main parts:

  • Config.Lobby is the first thing to set. The coordinates are placeholders. Set coords (the board), returnPoint (where players go after a match) and leave.center (walking further than leave.radius from it removes a player from the queue). Optionally set ped for a host NPC and blip.enabled = true for a map blip.
  • Config.Integrations switches the optional resources on or off. 'auto' uses the resource when it is started.
  • Config.Defaults and Config.Limits hold the starting match settings and the allowed range for each one. The server clamps every value the host sends.
  • Config.Modes lists the three modes. Names and descriptions come from locales/en.lua (mode_<id> and mode_<id>_d).
  • Config.Maps lists the maps. Each has a spawn, a play area (center, radius, minZ, maxZ), an optional world and an optional requires. Set enabled = false to drop a map. The radii are generous, so tighten them if players find a way out of an interior.
  • Config.Rewards pays money and/or an item at the end of a match. Everything is 0 by default. Nothing is paid when fewer than minPlayers started or the seek phase was shorter than minSeekTime.
  • Config.Stats turns the stats and the leaderboard on or off. Stats are kept in the resource KVP, so no SQL is needed.
  • Config.AdminResources lists the other resources allowed to call the AdminSaveZones export, which writes data/zones.json. This resource is always allowed. It is empty in this package, so only this resource can write the file.
  • Config.AdminGroup is the ACE principal that can use /hideseek (default group.admin).
  • Config.Debug = true allows one-player test matches and prints debug lines.

Text is in locales/en.lua. To translate, edit the strings there.

Voice channels#

When Config.Radio is on and pma-voice is running, the seekers radio uses channels 950 to 959, one per round. Those channels are locked to the active seekers. Do not use them for anything else. Change Config.Radio.base if they clash with your own radio setup.

Commands#

Command Who What
/leavehideseek everyone leave the lobby or the match
/hideseek status group.admin lobby and match state
/hideseek end group.admin end the running match with no winner
/hideseek reset group.admin end the match and empty the lobby

Configuration reference#

These settings come from the inspected package. Tables contain nested fields; edit them using the examples in the supplied file. Keep secrets in server-only configuration.

config.lua defaults#

Setting Default / editing guidance
Config.Debug false
Config.Integrations Table; fields and examples are in the supplied configuration file.
Config.AdminResources Table; fields and examples are in the supplied configuration file.
Config.AdminGroup 'group.admin'
Config.LobbyConfigured false
Config.Lobby Table; fields and examples are in the supplied configuration file.
Config.MinPlayers 2
Config.MaxPlayers 16
Config.Defaults Table; fields and examples are in the supplied configuration file.
Config.Limits Table; fields and examples are in the supplied configuration file.
Config.Choices Table; fields and examples are in the supplied configuration file.
Config.Modes Table; fields and examples are in the supplied configuration file.
Config.ModeOrder Table; fields and examples are in the supplied configuration file.
Config.Tag Table; fields and examples are in the supplied configuration file.
Config.BlindSeekers true
Config.Radio Table; fields and examples are in the supplied configuration file.
Config.Spectate true
Config.HiderSpectate Table; fields and examples are in the supplied configuration file.
Config.ResultsTime 15
Config.RoundBreak 15
Config.LobbyCard true
Config.CloudSwoop true
Config.Announce Table; fields and examples are in the supplied configuration file.
Config.Ping Table; fields and examples are in the supplied configuration file.
Config.Bounds Table; fields and examples are in the supplied configuration file.
Config.Wall Table; fields and examples are in the supplied configuration file.
Config.Bucket Table; fields and examples are in the supplied configuration file.
Config.ProtectPosition true
Config.HiderControls Table; fields and examples are in the supplied configuration file.
Config.MatchControls Table; fields and examples are in the supplied configuration file.
Config.Rewards Table; fields and examples are in the supplied configuration file.
Config.Stats Table; fields and examples are in the supplied configuration file.
Config.Maps Table; fields and examples are in the supplied configuration file.
Config.Sounds Table; fields and examples are in the supplied configuration file.