Requirements#
Required:
- FiveM server artifact with OneSync enabled
- qbx_core (Qbox)
- ox_lib
- ox_inventory
- ox_target
- oxmysql
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 pma-voice 7.0.1.
Optional. These are other Glitch Studios products or common community resources. They are detected at run time, and the matching feature is skipped when one is not running:
- pma-voice: locked team radio channels in team modes
- mm_radio: the player's own radio channel is rejoined after a match
- glitch-appearance: the exact look (face, hair, clothes) is saved before the uniform goes on and restored after
- glitch-xpSystem: XP for kills, wins and finishing a match
- glitch-photos and screencapture: map preview photos from an admin panel
- glitch-arcade: a cabinet set to VR Paintball opens the desk window
- glitch-mapHandler: maps that live in a separate world (set
worldon the map) - glitch-cloudsLoading: sky swoop when going into an arena
- glitch-uiElements: key hint HUD
- glitch-treasury and glitch-economy: house cut bookkeeping
- bob74_ipl: loads the interiors some of the default maps are in (see Maps and saved settings)
Installation steps#
- Copy the
glitch-paintballfolder into yourresourcesfolder. - Add
ensure glitch-paintballto yourserver.cfg, after ox_lib, oxmysql, qbx_core, ox_inventory and ox_target. - Database. The two tables are created when the resource starts. If your database user cannot create tables, run
sql/install.sqlonce by hand. - Edit
config.lua: set the desk position (Config.Arcade.desk) and the return point (Config.Arcade.returnPoint), then setConfig.Arcade.configured = true. The package ships withconfigured = falseand both positions at Legion Square. Until you change it, no desk, blip or target is created, lobbies are refused and the server console says so at every start. - Check for conflicts. The resource listens to the
weaponDamageEventserver event and cancels damage into and out of arenas, between teammates and during spawn protection. Any other resource that cancels or rewrites that event for the same players (some anticheats, damage modifiers, safe-zone scripts) will fight with it. Test a match with your anticheat running. If it flags players for spectating, infinite match ammo or one-shot modes, exempt them while they are in a match withConfig.AnticheatIgnoreandConfig.AnticheatExport(see Anticheat). - Optional: give your staff the admin menu (see Admin).
- Start the server and walk up to the desk. The ox_target option is called VR Paintball.
The minimum number of players to start a match is Config.MinPlayers (2). Set Config.Debug = true to allow solo test matches while you set up.
Stuck on a step?Ask in the Discord →