Studios
Paintballhouse-3.jpg

Configuration

SoonPaintballQbox
PAGE 03 OF 06  ·  INSTALLATION → CONFIGURATION → EXAMPLESdocs.glitchstudios.dev
Browse docs

Everything is in config.lua, and the file is open in the escrow. The main blocks:

  • Config.AdminCommand: the /paintballadmin menu (see Admin).
  • Config.AnticheatIgnore, Config.AnticheatExport: anticheat exceptions (see Anticheat).
  • Config.SaveSkinEvent: server event that saves the player's skin after their outfit is restored. Only used when glitch-appearance is running. Some clothing resources save the skin from a client event, for example illenium-appearance:server:saveAppearance. Put that event name here if yours does. The default is nil, which saves nothing.
  • Config.Plausibility: limits on what clients can report (see Hit checks).
  • Config.Arcade: label, desk box zone, return point, optional blip, the "walk away leaves the lobby" distance (leave, false to turn it off) and an optional second siteBlip.
  • Config.Cabinet: draws the lobby screen on an arcade cabinet prop. It is off in the package. Turn it on only if you have an interior with that prop, and set near to it.
  • Config.KeepSlots, MaxPlayers, MinPlayers, MaxLobbies, HostOnlySettings, LobbyIdleMinutes, BucketBase: lobby limits. BucketBase starts a range of routing buckets, one per match. Pick a range nothing else uses.
  • Config.Settings: default, minimum and maximum for each lobby setting (score to win, time limit, respawn time, lives, flag captures).
  • Config.Wager, Config.Prize: money.
  • Config.IntroSeconds, SummarySeconds, PassiveSeconds, OutOfBoundsSeconds, Wall: match flow.
  • Config.Radio: pma-voice channel range for team radios.
  • Config.XP: XP amounts and the category name used with glitch-xpSystem. It is disabled in the package.
  • Config.Streaks, MultiKills, KillFeed: kill feed text, colours and timings.
  • Config.GunGameLadder, OITC, CTF, Killstreaks, Heal: mode rules.
  • Config.Armour, Siphon, Outlines, SiphonHealth: default lobby rules.
  • Config.Uniforms: team clothing for freemode peds. The values are first guesses, so check them on your server.
  • Config.Keys: default keys. Players can rebind them in the GTA settings.

Wagers and prizes#

If Config.Wager.enabled is true the host can set a wager between min and max. Each player picks cash or bank when they ready up. The wager is taken when the match starts. Winners split the pot, less houseCut (5 percent by default). A draw refunds everyone. Leaving or dropping mid-match forfeits the wager. An admin kick refunds it.

If the framework refuses to pay a winner, the wager hold is kept and the player gets their stake back when they return from the match. The failure is printed in the server console so you can compensate by hand.

Config.Prize is a prize paid by the house to every winner, in money or an item. Lobbies start with it and an admin can change it per lobby.

Maps and saved settings#

data/maps.lua holds the built-in map list. data/maps.json replaces that list when it exists and contains at least one valid map, so it is the file that wins. The package ships a data/maps.json with five maps. To change a map, edit data/maps.json (or delete it to fall back to data/maps.lua). A restart is needed for either file.

Each map has spawns for the red team, the blue team and free-for-all, a play area (centre, radius, floor and roof), optional flag and heal points, and the modes it offers.

data/settings.json stores the values an admin panel changes at run time: desk position, wager limits, XP amounts and the default lobby rules. It is {} in the package. Each key found there overrides the matching config.lua value at start. Without an admin panel you can leave it empty and edit config.lua instead.

The default maps are Import Warehouse, Smuggler Hangar, Stab City, Cargo Ship and Military Aircraft Carrier. The warehouse and the hangar need bob74_ipl: they carry requires = 'bob74_ipl', and the resource hides and refuses a map whose requires resource is not running. The same field works for your own maps. The carrier also depends on its IPL being loaded, which the resource cannot check, so set enabled to false for any map that does not load on your server in data/maps.json. Team and free-for-all spawns away from a map's fallback point are first guesses, so check them on your server.

Admin#

The resource has no full admin panel. A small standalone menu is included, and two optional exports let you build a custom admin panel.

Standalone menu: Config.AdminCommand is true in the package, so the /paintballadmin command exists once you grant the ACE permission below. Without that permission nobody can use it. Give your staff the permission in server.cfg:

add_ace group.admin command.paintballadmin allow
add_principal identifier.license:YOUR_LICENSE group.admin

/paintballadmin lists the lobbies. Pick one to end it now (the leader wins), cancel it (wagers refunded, no stats) or close it. The server checks the permission again on every action. From the server console the command prints the lobby list. Set Config.AdminCommand = false if you use a custom panel instead.

Optional exports for a custom admin panel (the server trusts the caller, so check your own permissions first):

  • exports['glitch-paintball']:AdminState() returns lobbies, online players, offline holds, maps, settings, loadouts, modes and limits.
  • exports['glitch-paintball']:AdminAction(action, data) returns ok, message. Actions: createLobby, set, prize, start, endNow, abort, close, kick, add, returnItems, saveMaps, resetMaps, saveSettings, captureImage. Long actions answer "working on it" and notify data.src when done.

Anticheat#

A match legitimately trips some checks: spectating, match weapons that are not inventory items, one-shot modes and the minigun killstreak. Config.AnticheatIgnore lists check ids to exempt while a player is in a match, and Config.AnticheatExport names the resource and its two exports:

Config.AnticheatIgnore = { 'CHECK-01', 'CHECK-02' }
Config.AnticheatExport = { resource = 'my-anticheat', ignore = 'Ignore', unignore = 'Unignore' }

ignore(src, list) is called when a player enters a match and unignore(src, delayMs) when they leave. Both settings are empty in the package, so nothing is called.

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.AnticheatIgnore Table; fields and examples are in the supplied configuration file.
Config.AnticheatExport nil
Config.SaveSkinEvent nil
Config.Plausibility Table; fields and examples are in the supplied configuration file.
Config.OutlineMax 8
Config.AdminCommand true
Config.Arcade Table; fields and examples are in the supplied configuration file.
Config.Cabinet Table; fields and examples are in the supplied configuration file.
Config.KeepSlots Table; fields and examples are in the supplied configuration file.
Config.MaxPlayers 24
Config.MinPlayers 2
Config.MaxLobbies 12
Config.HostOnlySettings true
Config.LobbyIdleMinutes 20
Config.BucketBase 74000
Config.Settings Table; fields and examples are in the supplied configuration file.
Config.HeadshotKills true
Config.Hitmarkers true
Config.PaintFx true
Config.Wager Table; fields and examples are in the supplied configuration file.
Config.Prize Table; fields and examples are in the supplied configuration file.
Config.Clouds true
Config.IntroSeconds 14
Config.SummarySeconds 15
Config.SpawnSpacing 3.0
Config.PassiveSeconds 3
Config.UnlimitedSprint true
Config.OutOfBoundsSeconds 5
Config.Wall Table; fields and examples are in the supplied configuration file.
Config.HitWindowMs 150
Config.RespawnCooldown 10
Config.RespawnSeconds 4
Config.Radio Table; fields and examples are in the supplied configuration file.
Config.XP Table; fields and examples are in the supplied configuration file.
Config.Streaks Table; fields and examples are in the supplied configuration file.
Config.StreakEndMin 5
Config.MultiKillWindow 4.0
Config.MultiKills Table; fields and examples are in the supplied configuration file.
Config.LongshotDistance 60.0
Config.Teams Table; fields and examples are in the supplied configuration file.
Config.FFAColor Table; fields and examples are in the supplied configuration file.
Config.KillFeed Table; fields and examples are in the supplied configuration file.
Config.GunGameLadder Table; fields and examples are in the supplied configuration file.
Config.OITC Table; fields and examples are in the supplied configuration file.
Config.CTF Table; fields and examples are in the supplied configuration file.
Config.Killstreaks Table; fields and examples are in the supplied configuration file.
Config.Heal Table; fields and examples are in the supplied configuration file.
Config.Armour false
Config.Siphon true
Config.Outlines false
Config.SiphonHealth 50
Config.KillCreditSeconds 10
Config.Uniforms Table; fields and examples are in the supplied configuration file.
Config.Keys Table; fields and examples are in the supplied configuration file.