Studios
Arcadehouse-3.jpg

Installation

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

Requirements#

The package holds four folders:

  • glitch-arcade, the product.
  • glitch-abstraction, the Glitch Studios compatibility layer that glitch-arcade needs for money, notifications and targets. It is free and GPL-3.0 licensed, with its own LICENSE and README.
  • glitch-uiElements, a lite build of the Glitch Studios UI library. The admin and owner menus and the placement key hints call it directly, so it must be running. It is bundled, so you do not need to download it separately.
  • free-addons/glitch-degenatron, the optional Penetrator add-on (see below).

Required:

  • ox_lib, recent release (3.20 or newer).
  • oxmysql, 2.7 or newer.
  • glitch-abstraction, included in this package. It handles money, notifications and targets, so one install covers Qbox, QBCore and ESX. If your server already runs a newer glitch-abstraction, keep that one.
  • glitch-uiElements, included in this package as a lite build. Use one copy only: if you already run the full glitch-uiElements, keep it and skip the bundled folder.
  • A target resource that glitch-abstraction supports: ox_target or qb-target.
  • A supported framework: Qbox, QBCore or ESX.

Optional, none of them included:

  • glitch-paintball, glitch-hideseek and glitch-racing. If one is not running, machines set to it use their built-in fallback game or show as out of order.
  • glitch-admin. If it is running, players with its panel_arcade permission can use the staff menu without the ACE below. Set Config.AdminPanelAction = false to turn this off.
  • glitch-degenatron, the free add-on.

Installation steps#

  1. Copy glitch-abstraction, glitch-uiElements and glitch-arcade into your resources folder. Copy free-addons/glitch-degenatron too if you want Penetrator.
  2. Start them after their requirements in server.cfg:
    ensure ox_lib
    ensure oxmysql
    ensure glitch-abstraction
    ensure glitch-uiElements
    ensure glitch-arcade
    
  3. Give your staff the ACE for the staff command (skip this if you only use the glitch-admin panel):
    add_ace group.admin command.arcadeadmin allow
    add_principal identifier.license:YOUR_LICENSE group.admin
    
    The command name is Config.AdminCommand and the group is Config.AdminGroup in config.lua.
  4. The database table is created on first start. If your database user cannot create tables, run install/sql.sql yourself.
  5. Restart the server and type /arcadeadmin in the city.

Updating and your data#

Everything your server creates lives in data/arcade.json (machines, owners, tills, zones) and data/scores.json (city boards), plus the glitch_arcade_passes table in your database. Before you replace the glitch-arcade folder with a new version, copy data/ somewhere safe and put it back afterwards. A new package ships empty data files, and copying them over yours erases your machines and tills. If data/arcade.json ever cannot be read, the resource prints an error and stops saving so the file is not overwritten.

Optional: Penetrator add-on#

free-addons/glitch-degenatron (also called Degenatron) is a port of the Degenatron game Penetrator by utku (utkuali/degenatron-arcade-games), with arcade hook-up by Glitch Studios. It is licensed under GPL-3.0, so it ships free and unescrowed, with its licence. The rest of the package is proprietary (see LICENSE). To use it, copy it into your resources, ensure glitch-degenatron, and set a machine's game to Penetrator. Without it, those machines play Orbit Blaster.