How to Install QBCore Framework on Your FiveM Server

Install QBCore on your FiveM server using the txAdmin recipe — includes database setup, server.cfg configuration, and key settings.

QBCore is an open-source FiveM roleplay framework that provides jobs, gangs, housing, inventory, phone, HUD, and more. It includes built-in multicharacter support and a gang system — features that require addons on ESX.

Prerequisites

A MySQL/MariaDB database — create one in the Databases tab on the XGamingServer Panel. MariaDB is recommended over MySQL by both QBCore and oxmysql documentation
A FiveM license key from keymaster.fivem.net

Install QBCore

The recommended method is the txAdmin recipe — it downloads ~70 resources, imports the database schema, and configures server.cfg automatically.

Open txAdmin Server Deployer

Access txAdmin through your panel. At the deployment step, select Popular Template, then choose "QBCore Framework".

Configure the database connection

When prompted, enter the MySQL connection string using the credentials from your Databases tab:

mysql://dbuser:dbpassword@127.0.0.1:3306/dbname?charset=utf8mb4

If your password contains special characters, use the semicolon format instead: user=root;password=12345;host=127.0.0.1;port=3306;database=dbname

Complete the recipe

The recipe automatically:

Downloads cfx-server-data (default resources)
Installs oxmysql (MySQL connector)
Installs pma-voice + qb-radio (voice chat)
Installs ~50 qb- resources* (core, HUD, inventory, phone, jobs, gangs, housing, etc.)
Installs standalone dependencies (PolyZone, progressbar, menuv, connectqueue)
Imports qbcore.sql into your database
Deploys a preconfigured server.cfg

Start the server

Once the recipe completes, start the server from Console. QBCore is fully installed.

Key server.cfg Entries

The recipe generates these — you can adjust after install:

sv_enforceGameBuild 3095
set mysql_connection_string "mysql://user:password@localhost:3306/dbname?charset=utf8mb4"

# Voice
setr voice_useNativeAudio true
setr voice_useSendingRangeOnly true
setr voice_defaultCycle "GRAVE"
setr voice_defaultVolume 0.3

# QBCore
setr qb_locale "en"
setr UseTarget false

# Start order
ensure qb-core
ensure [qb]
ensure [standalone]
ensure [voice]
ensure [defaultmaps]

# Permissions
add_ace resource.qb-core command allow
add_ace qbcore.god command allow

Key Configuration (config.lua)

After installing, customize QBCore in resources/[qb]/qb-core/config.lua:

Setting	Default	Description
`QBConfig.Money.MoneyTypes`	`{ cash = 500, bank = 5000, crypto = 0 }`	Starting money for new characters
`QBConfig.Money.PayCheckTimeOut`	`10`	Paycheck interval in minutes
`QBConfig.Player.HungerRate`	—	Hunger decrease rate
`QBConfig.Player.ThirstRate`	—	Thirst decrease rate
`QBConfig.DefaultSpawn`	—	Coordinates for default spawn point

Max players is read from sv_maxclients in server.cfg (default 48).

Common Issues

Problem	Fix
Database connection failed	Check connection string. Special characters in password need URL-encoding or use semicolon format
Resources not starting	Ensure `qb-core` starts before `[qb]` in server.cfg
"Table not found" errors	`qbcore.sql` wasn't imported. Re-run the recipe or import manually via phpMyAdmin
OneSync errors	The recipe sets `set onesync on` — verify it's in your server.cfg

How to Install QBCore Framework on Your FiveM Server

On this page