Before You Begin#
Before installing Arcade Creator, make sure your server meets the minimum requirements. Only the first two are mandatory; everything else turns a feature on.
Requirement | Status | Notes |
|---|---|---|
| Required | Database access. Arcades, machines, scores and settings all live in MySQL. |
| Required | Callbacks and shared helpers. It must start before the arcade. |
| Required | Ships in the same download. It loads the game's own arcade interior; without it nobody can walk inside. |
Framework | Optional |
|
Inventory | Optional | Only so a claw-machine plushie also becomes an item the player keeps. |
Vehicle keys | Optional | Hands over the keys of a car taken out of the basement garage. |
| Optional | Only for the creator's camera, which photographs a venue for its purchase panel. |
Everything framework- or third-party-specific sits behind a small bridge file, and the resource picks each one by looking at what is already running:
Layer | Looked for |
|---|---|
Framework |
|
Inventory |
|
Vehicle keys | Thirteen systems, including |
Notifications |
|
Every optional integration degrades silently. If a resource is missing, that feature simply does not appear — nothing errors and nothing blocks the arcade from running.
github.comReleases · overextended/oxmysqlMySQL resource for FXServer.github.comReleases · overextended/ox_libA FiveM resource and script library for Lua and JS.Downloading Arcade Creator#
After purchasing Arcade Creator, the resource is automatically linked to your CFX Portal account. Sign in with the same account used during checkout, open Granted Assets and download the latest version.
After extracting the download you should have two folders:
[arcade]/
├── qs-arcades/ -- the script
│ ├── config/ -- what you may edit
│ ├── locales/ -- 41 translations
│ ├── custom/ -- bridges to your framework
│ └── sql/database.sql -- import this once
└── arcade_interior/ -- loads the game's arcade interiorThe folder must be named
qs-arcades. The database tables, the ace permissions and every command are built from that name; renaming it breaks all three.
Installing the Resource#
Move both folders into your server's resources directory. They can live anywhere, together or apart, as long as both are started.
resources/
└── [arcade]/
├── qs-arcades/
└── arcade_interior/Open your server.cfg and make sure every dependency starts before the arcade does:
ensure oxmysql
ensure ox_lib
# Framework (only the one you run)
ensure qb-core
# ensure qbx_core
# ensure es_extended
# Optional
ensure ox_inventory
ensure screenshot-basic
# The arcade, last
ensure arcade_interior
ensure qs-arcadesThe loading order matters. Detection only sees resources that are already started, so a framework or inventory listed after qs-arcades is invisible to it and the server falls back to standalone.
The Database#
Import sql/database.sql once, before the first start. It creates the core tables and seeds the six arcades the base game already has on the map.
mysql -u root -p your_database < sql/database.sqlSOURCE sql/database.sql;Tables | Hold |
|---|---|
| The venues themselves — where they are, what they cost — and who owns each one, with its machines, upgrades and safe. |
| Staff and their rights, and who was inside when the server stopped. |
| Every leaderboard entry, and the trophies each venue has earned. |
| The finance ledger behind the business panel. |
| The in-game settings panel, decor, the jukebox station and the door states. These create themselves on first start if they are missing. |
The seed uses
INSERT IGNORE, so re-importing the file never overwrites a venue you edited — but it does put back any of the six built-in arcades you deleted. New columns added by an update are created automatically on start; you do not re-import for those.
Claiming Admin Access#
The creator places venues and the settings panel configures the whole server, so both sit behind an ace permission. Add these to server.cfg and restart:
# The in-game settings panel (/arcadeconfig)
add_ace group.admin command.arcadeconfig allow
# The venue creator (/arcadecreator)
add_ace group.admin command.arcadecreator allow
# Console-only tools
add_ace group.admin command.qsarcades allow
add_ace group.admin command.arcadepoints allowIf somebody is refused, the server console says so by name and prints the exact line to add. Both panels can also be opened by anyone when the matching switch in Settings → Creator & camera is turned on — useful on a test server, never on a live one.
Configuring the Resource#
Almost nothing is configured in files. Prices, permissions, income, the garage, doors, language and the command names are all edited in game with /arcadeconfig and saved to the database, so an update never wipes them.
The one file worth opening is config/config.lua, which holds only what has to be known before the server starts:
-- Extra console output. Leave it false on a live server.
Config.Debug = false
-- Each of these is detected automatically. Add your own resource
-- name on the left only if you renamed one of them.
Config.Framework = DependencyCheck(frameworks) or 'standalone'
Config.Vehiclekeys = DependencyCheck(vehicleKeys) or 'none'
Config.Inventory = DependencyCheck(inventories) or 'none'Everything else under
config/andlocales/is yours to edit and survives an update. Files outside those folders are overwritten, so make your changes in the settings panel instead.
Verifying the Installation#
Restart your server and read the boot lines in the console. The resource prints what it detected and how many venues it loaded:
[qs-arcades] client adapter loaded: qb
[qs-arcades] loaded 6 arcade points
[qs-arcades] achievements loaded: 0 rows
[qs-arcades] jukebox loaded: 6 arcadesThen join and work through the first loop:
Walk up to an arcade
All six are on the map with a blip. Press
Eat the door: a panel opens with photos, the price and a Buy button. If the door does nothing,arcade_interioris not started.Buy it and go inside
The venue becomes yours and the door turns into an Enter prompt. Inside you should see the bar, the office door and empty machine slots.
Buy and place a machine
Sit at the office laptop, buy a cabinet, then open the placer with
/arcadeplace. Pick a slot, confirm, and play it.Open the panels
F7opens the business panel,/arcadeconfigthe settings and/arcadecreatorthe venue creator. If a panel refuses to open, the ace is missing.
Nothing needs a restart from here on. Every price, permission, decor option and new venue is saved live and reaches every player already connected.