Installation

Requirements

Dependency	Required	Notes
FiveM server with `lua54` enabled	Yes
MySQL 5.7+ or MariaDB 10.3+	Yes	`utf8mb4`, so track titles with emoji or CJK survive a round trip.
`ox_lib`	Yes	Callbacks, points, dialogs, notifications, keybinds, locales.
`oxmysql`	Yes	Locations, playlists and the audit log.
`ox_target`	Optional	Booth interaction. Without it, the script falls back to a text prompt on E.
`ox_inventory`	Optional	Only used when the usable item is turned on (off by default).
`xsound`	Optional	Alternative playback engine, auto-detected. See Audio backend.

A framework is not required. On a standalone server, jobs and gangs resolve empty and access control falls back to ACE permissions and identifier lists.

ox_target and ox_inventory are deliberately not listed as hard dependencies, so a server that uses neither still boots cleanly.

Steps

Drop the resource into your server, e.g. resources/[nex]/nexdev_djsystem/.

Add it to your server.cfg after its dependencies:

ensure oxmysql
ensure ox_lib
ensure ox_target        # optional
ensure ox_inventory     # optional
ensure nexdev_djsystem

Add the ACE permissions:
add_ace group.admin nexdev_djsystem.admin allow add_ace group.admin nexdev_djsystem.creator allow
See Permissions for what each one grants and how to hand the builder role to someone who isn’t a full admin.
Start your server. The database tables are created automatically on first start — no SQL to run.
Replace the soundboard URLs. config/soundboard.lua ships with placeholder https://cdn.yourserver.com/... addresses that resolve to nothing. See Soundboard.

That’s it — the four shipped booths appear on the map.

Step 5 is not optional if you want the soundboard. Every shipped clip URL is a placeholder and will silently do nothing until you point it at real files you host.

The database

You do not need to import any SQL. The script runs CREATE TABLE IF NOT EXISTS for all three tables on start.

Table	Holds
`nexdev_djsystem_locations`	Booths created or edited with the in-game creator. Config booths are not stored here.
`nexdev_djsystem_playlists`	Player playlists, keyed to a stable framework identifier.
`nexdev_djsystem_logs`	Audit trail — privileged actions, queue additions, playlist writes, location changes and security events.

install.sql sits in the resource root for reference, for DBAs who prefer to provision schema out of band, and for backup and restore. It is not required. If the database is unreachable the script still runs — config booths load and playback works. Only the persistence features (saved booths, playlists, audit rows) report “the database is unavailable” and refuse. The audit table is never pruned automatically. If you want that, schedule it yourself:

DELETE FROM `nexdev_djsystem_logs` WHERE `created_at` < DATE_SUB(NOW(), INTERVAL 30 DAY);

Configure

Work through these in order:

config/config.lua — keybind, command, framework, audio defaults, permissions, security limits, UI defaults.
config/locations.lua — delete the shipped booths you don’t want, add your own.
config/soundboard.lua — replace every placeholder URL.
config/effects.lua — lighting presets and defaults. Usually fine as shipped.

See Configuration.

The Discord webhook

The webhook URL is not a config key, because config/config.lua is readable by every connected client. Set it as a server-only convar in server.cfg instead:

set nexdev_djsystem_webhook "https://discord.com/api/webhooks/..."

Use set, never setr. setr replicates the value to every client, which leaks your webhook URL to anyone connected.

Leave it unset to disable webhook logging entirely.

Checking it worked

On a healthy start the server console prints:

[nexdev_djsystem] info  startup  DJ system ready (framework: qbx)

Walk to one of the shipped booths and press F7 (or run /dj). The panel should open with the booth’s name in the header. From F8:

lua print(GetResourceState('nexdev_djsystem'))

Should print started. If it prints missing or stopped, fix server.cfg and restart.

Updating

Your booths, playlists and logs all live in MySQL and are preserved automatically. Booths you added to config/locations.lua, and every other file under config/, are yours — keep your edited copies when you replace the resource files.

Replace the resource files with the new version, keeping your edited config/ files.
Restart the server.

The script checks for updates on start and prints a notice in the server console when a newer version is available.

Get Started

Scripts

Changelog

Requirements

Steps

The database

Configure

The Discord webhook

Checking it worked

Updating

​Requirements

​Steps

​The database

​Configure

​The Discord webhook

​Checking it worked

​Updating

Requirements

Steps

The database

Configure

The Discord webhook

Checking it worked

Updating