Install FiveDash on your city.

One resource and one line in server.cfg. It detects the framework, links the server to the panel and keeps itself up to date.

Console · Your City RPFXServer

Before you start

fivedash works with any framework.

What fivedash does on each framework
FrameworkIn-game whitelistStore delivery
Creative Network EnchantedItems, vehicles, money, VIP and commands
QboxItems, vehicles, money, VIP and commands
QBCoreItems, vehicles, money, VIP and commands
ESXItems, vehicles, money, VIP and commands
ox_coreItems, vehicles, money, VIP and commands
vRP and vRPexItems, vehicles, money, VIP and commands

* Through the framework's own whitelist: on QBCore and Qbox, with the whitelist on and a WhitelistPermission of its own (like whitelisted); on ESX, with esx_whitelist. An unlock covers the Discord of whoever already tried to join the city. On ox_core and other frameworks, the whitelist stays on Discord.

A MySQL driver
oxmysql, mysql-async or ghmattimysql, started before fivedash. It's how the resource checks the framework and keeps the store's deliveries.
An up-to-date FXServer
The resource runs on FXServer's Node 22, which comes with recent artifacts.
The server's key
Owners and admins generate it in the panel, under Server → Game connection. It starts with fdk_ and is only shown once.

Step by step

The same four steps as the panel's connection screen. It takes a few minutes.

  1. Generate the key and download the resource

    In the panel, under Server → Game connection, click Generate key. fivedash.zip comes with it in config.lua and works with any framework.The key is only shown now and gives access to the server on FiveDash. Don't share config.lua.

  2. Extract the folder into resources

    Put the fivedash folder in resources. Already had the resource? Paste the new key into its config.lua.

    resources/fivedash/config.lua
    Key = "fdk_…",
  3. Start it after the framework

    In server.cfg, fivedash goes after the database and the framework, so it finds both when it starts.

    server.cfg
    ensure oxmysqlensure vrp        # your frameworkensure fivedash
  4. Restart and check

    Restart the server, or type refresh and ensure fivedash in the console. The connection shows up in the panel on its own.

The files

Three files only the server reads. After changing something, type restart fivedash in the console.

Updates never remove or change what's in these files: new options show up at the end on their own.

resources/fivedash/config.lua
-------------------------------------------------- FIVEDASH-------------------------------------------------- Read by the server only (never sent to players). After changing something: restart fivedash-- Updates never remove or change what's here: new options show up at the end by themselves.FiveDash = {	-- The dashboard key: FiveDash → Server → Game connection → Connect server.	-- Don't share this file: the key gives access to your server in FiveDash.	Key = "", 	-- The city's framework. "auto" detects it; or force one: "creative-enchanted", "qbox", "qbcore", "esx", "ox-core", "vrp".	Framework = "auto",	-- Installs new versions of the resource by itself (this file stays as it is).	AutoUpdate = true, 	-- Prints every sync and command in the console.	Debug = false,}

It updates itself

With AutoUpdate on, the new version downloads on its own, every file is checked before it goes in, and it takes effect on the next restart. config.lua is never touched.

If something goes wrong

fivedash tells you in the console what's going on. These are the messages that need something from you.

  • [FiveDash] No dashboard key: this server isn't connected to FiveDash.

    Key in config.lua is empty. Generate the key under Server → Game connection and paste it into fivedash/config.lua.

  • [FiveDash] The dashboard refused the connection: key refused by the dashboard.

    The key was replaced by another one in the panel. Generate a new one and replace Key in config.lua.

  • [FiveDash] The dashboard refused the connection: this key is already in use by another server that's running right now.

    Each server has its own key. If you just restarted fivedash, it gets back in by itself in a few seconds.

  • [FiveDash] No MySQL driver started (oxmysql, mysql-async or ghmattimysql): only resources can be checked.

    Start the database driver before fivedash in server.cfg.

  • [FiveDash] No known framework found. The dashboard connection works, but the whitelist stays on Discord and the store only delivers commands.

    Type fivedash detect to see what it found, or pick the framework in config.lua's Framework option.

  • [FiveDash] For FiveDash to unlock players on QBCore's whitelist, change WhitelistPermission = 'admin' to a whitelist-only permission…

    With admin, every unlocked player would become staff. In qb-core/config.lua (or qbx_core/config/server.lua), use WhitelistPermission = 'whitelisted' and give it to staff in server.cfg: add_ace group.admin whitelisted allow.

  • [FiveDash] esx_whitelist isn't started: the whitelist stays on Discord.

    On ESX, unlocks go into esx_whitelist's list. Start it before fivedash, in "identifier" or "both" mode.

  • [FiveDash] No connection to the dashboard (…). Retrying automatically.

    The server's internet dropped or the panel didn't answer. It retries on its own, and deliveries and logs wait in the queue.

Stuck on something else? Type fivedash status in the console and send the result to support@fivex.email.

Your server on FiveDash
in just a few minutes.

One resource on your server, the modules it needs, and 7 days to try everything before you subscribe.