QBCore Frameworkqbcore.netCommunity docs
On this page

5 min read

QBCore server.cfg

The current QBCore txAdmin recipe generates server.cfg for you. Use that generated file as the baseline and change only settings you understand. The runtime examples below follow the recipe reviewed on 27 September 2026, with public-listing metadata separated for the Cfx Portal migration. They are not a verbatim current recipe or a replacement for txAdmin's deployment variables.

Keep secrets out of Git

Never commit a real sv_licenseKey, database password, webhook, API token, or other production credential. The examples below use placeholders.

Public listing metadata in Cfx Portal

The 14 October 2026 Cfx announcement moves FiveM and RedM server-list metadata to the Cfx Portal. Existing server.cfg metadata remains displayed during the transition until 21 October 2026. From that date, use the Portal to edit the public server name, tagline, description, tags, language, banner and icon. Restarting FXServer after editing these old listing settings is not a substitute.

The affected legacy settings are sv_hostname, sv_projectName, sv_projectDesc, tags, locale, banner_detail, banner_connecting and load_server_icon. The runnable examples below deliberately omit these listing assignments, even if an older txAdmin recipe still generates them. Keep a backup of existing configuration and review local resource dependencies before removing old values.

  1. Open the correct server record in the Portal and review any backfilled metadata; fill blank fields.
  2. Select the community's actual language and up to five unique tags. Do not keep root-AQ as a placeholder for a public community.
  3. Upload the banner and profile image in the Portal. Recommended sizes are 2560×280 and 512×512; minimum sizes are 1825×200 and 256×256, respectively.
  4. Check the public listing separately from server startup. Missing Portal information can display “Missing server data (must be configured in Portal)”.

This does not move the private license key, endpoints, database connection, ACE permissions, resource start order or qb_locale into the Portal. The Portal language describes the listing; setr qb_locale "en" still selects QBCore's own translations.

Current template, annotated

Endpoints, slots and listing metadata

{{serverEndpoints}}
sv_maxclients {{maxClients}}
set steam_webApiKey "none"

txAdmin expands {{serverEndpoints}} and {{maxClients}}. In a manual configuration, define the TCP/UDP endpoints and slot count according to your host and Cfx.re setup.

Server identity and game build

sv_licenseKey "{{svLicense}}"
sv_enforceGameBuild 3095
set resources_useSystemChat true

The reviewed recipe pins game build 3095. Do not treat that number as permanently recommended: upstream can change it. Keep the value from the recipe/version you intentionally deploy and test resource compatibility before changing builds.

Configure public identity and language in the Portal. The license key and game-build selection above remain server configuration.

Database

set mysql_connection_string "{{dbConnectionString}}"

The recipe fills this from txAdmin's database step. For a manual deployment, use the connection format supported by your installed oxmysql version and keep credentials private.

Voice

The current recipe includes:

setr voice_useNativeAudio true
setr voice_defaultCycle "GRAVE"
setr voice_defaultVolume 0.3
setr voice_enableRadioAnim 1
setr voice_syncData 1
setr voice_useSendingRangeOnly false

These are voice-resource convars, not qb-core configuration. If you replace the voice stack, follow that resource's documentation instead of preserving obsolete convars blindly.

QBCore locale and target mode

setr qb_locale "en"
setr UseTarget false

qb_locale selects QBCore's locale. UseTarget is read by multiple QBCore resources to choose between target-based interactions and alternative interaction paths.

Resource start order

The current recipe starts FiveM defaults first:

ensure mapmanager
ensure chat
ensure spawnmanager
ensure sessionmanager
ensure basic-gamemode
ensure hardcap
ensure baseevents

Then QBCore and grouped resources:

ensure qb-core
ensure [qb]
ensure [standalone]
ensure [voice]
ensure [defaultmaps]

A bracketed folder is convenient, but it does not replace dependency reasoning. If resource B calls an export from resource A during startup, ensure A is available first or declare the dependency in the manifest.

See Resource load order.

ACE permissions

Current upstream permissions:

add_ace group.admin command allow
{{addPrincipalsMaster}}

add_ace resource.qb-core command allow

add_ace qbcore.god command allow

add_principal qbcore.god group.admin
add_principal qbcore.god qbcore.admin
add_principal qbcore.admin qbcore.mod

What each line does

LinePurpose
add_ace group.admin command allowAllows the FiveM admin group to use commands.
{{addPrincipalsMaster}}txAdmin inserts the generated owner/admin principal.
add_ace resource.qb-core command allowLets qb-core manage command ACEs.
add_ace qbcore.god command allowGives the qbcore.god group command access.
add_principal qbcore.god group.adminMakes QBCore gods inherit the main admin group.
add_principal qbcore.god qbcore.adminGods inherit QBCore admin.
add_principal qbcore.admin qbcore.modAdmins inherit QBCore mod.

For persistent staff access, add a trusted identifier principal, for example:

add_principal identifier.license:YOUR_LICENSE qbcore.admin

See Become Admin for the full model.

Minimal manual example

This is a readable manual skeleton, not the txAdmin file itself:

endpoint_add_tcp "0.0.0.0:30120"
endpoint_add_udp "0.0.0.0:30120"

sv_maxclients 48
sv_licenseKey "REPLACE_PRIVATELY"

set mysql_connection_string "mysql://USER:[email protected]/DATABASE?charset=utf8mb4"

setr qb_locale "en"
setr UseTarget false

ensure mapmanager
ensure chat
ensure spawnmanager
ensure sessionmanager
ensure basic-gamemode
ensure hardcap
ensure baseevents

ensure qb-core
ensure [qb]
ensure [standalone]
ensure [voice]
ensure [defaultmaps]

add_ace group.admin command allow
add_ace resource.qb-core command allow
add_ace qbcore.god command allow
add_principal qbcore.god group.admin
add_principal qbcore.god qbcore.admin
add_principal qbcore.admin qbcore.mod

Add voice convars, enforced game build and other options deliberately rather than copying values from an unrelated old server template.

Common mistakes

Putting secrets in a public repository

Rotate exposed credentials immediately. Moving them to another line after publication does not make the old Git history private.

Starting consumers before providers

An attempt to call a nil value or missing export at startup often means either the provider did not start or your deployed API no longer matches the caller.

Copying an old QBCore template

Game-build numbers, voice settings, resource lists and config keys change. Compare against the current recipe before copying from a forum post or old fork.

Duplicating resources

Do not both ensure qb-core and separately ensure another copy of the same resource under a different folder. Resolve duplicate resource names before debugging gameplay.

Verification checklist

  1. txAdmin reports no failed recipe task.
  2. The database connection succeeds without exposing credentials in logs.
  3. qb-core starts before resources that require it.
  4. No resource reports a missing dependency/export at clean boot.
  5. Your QBCore locale and target mode match the resources you deployed.
  6. Admin principals work after reconnect/restart.
  7. A test character persists across reconnect and server restart.
  8. The correct Portal record has complete metadata and the public listing has been checked.

After editing a manual configuration, the free server.cfg Builder & Checker can review a documented subset of directives. It cannot verify installed resources, valid credentials, txAdmin deployment variables or your Cfx Portal record. Keep the official txAdmin recipe as your baseline and complete the startup checks above. RPScripts and qbcore.net are operated by the same owner.

Sources

Recipe baseline verified 2026-09-27. Portal metadata migration reviewed 2026-10-14.

Found an issue in this guide?

Send the page URL, the affected example, and a source or reproduction to the site maintainer. For a server or resource problem, use the support guide.

On this page

Leonida RP server website built with RPWebsite
RPWebsite

Advertisement · RPWebsite

Want a website for your server?

Launch a site with live player status, rules, and a join button in minutes.

Build your website