FiveM server.cfg explained line by line (including OneSync)

server.cfg is the main configuration file of a FiveM server: it sets the port, the name in the server list, the license key, game build, OneSync, which resources start and admin permissions. We'll go through it line by line and, for each setting, explain what it does and which value to choose.

Where to find server.cfg#

• Server with txAdmin: server.cfg is in the folder you chose when deploying the recipe (txAdmin suggests txData/<NAME>_<CODE>.base). The easiest way to edit it is CFG Editor in the left menu of txAdmin; save with Ctrl+S. You'll find the path in txAdmin under Settings › FXServer (the Server Data Folder field; the CFG File Path field appears when you show the advanced options).
• Server without txAdmin: server.cfg is in the server's main folder. Edit it in the customer area in the Files tab (guide).

Changes to server.cfg only take effect after a server restart.

How server.cfg is read#

• The file is read top to bottom, line by line. Each line is one server console command.
• Text after # is a comment and the server ignores it. You “turn off” a line by putting # at its start.
• Put values with spaces in quotes: sv_hostname "Muj server".
• If the same setting appears twice in the file, the last one wins.
• The exec file.cfg command loads another configuration file (for example exec permissions.cfg). Handy for keeping things organized.

Variables (convars) are set with three commands:

Sample server.cfg#

This sample is based on the default FiveM configuration and the txAdmin recipes. Each block is explained below.

# --- Network ---
endpoint_add_tcp "0.0.0.0:30120"
endpoint_add_udp "0.0.0.0:30120"
sv_maxclients 48
sv_endpointPrivacy true

# --- Server list ---
sv_hostname "Muj RP server"
sets sv_projectName "Muj RP server"
sets sv_projectDesc "Czech roleplay server with custom scripts"
sets tags "roleplay, czech, esx"
sets locale "cs-CZ"
load_server_icon logo.png
#sv_master1 ""

# --- Keys ---
sv_licenseKey "<LICENSE_KEY>"
set steam_webApiKey "none"

# --- Game and security ---
sv_enforceGameBuild 3258
sv_scriptHookAllowed 0
sv_enableNetworkedSounds false
sv_enableNetworkedScriptEntityStates false
sv_filterRequestControl 2

# --- OneSync (only without txAdmin, see below) ---
set onesync on

# --- Database ---
set mysql_connection_string "mysql://<USER>:<PASSWORD>@<DATABASE_IP>:3306/<DATABASE_NAME>"

# --- Resources ---
ensure mapmanager
ensure chat
ensure spawnmanager
ensure sessionmanager
ensure basic-gamemode
ensure hardcap
ensure oxmysql
ensure [standalone]

# --- Permissions ---
add_ace group.admin command allow
add_ace group.admin command.quit deny
add_principal identifier.fivem:<FIVEM_ID> group.admin

Replace the values in angle brackets with your own details (delete the brackets): <LICENSE_KEY> is the key from the Cfx.re Portal, the database details are in the Database tab, and <FIVEM_ID> is the numeric ID of your Cfx.re account (the permissions section explains how to find it).

Network and slots#

30120 is the default FiveM port. On our servers, your server's port is the one you see in the Network tab, and it must be on both endpoint_add_* lines. Watch out after deploying with a txAdmin recipe: if txAdmin doesn't know the server's port, it writes the default 30120 into server.cfg. Check it and change it if needed.

Name and server list#

sets sv_projectName and sets sv_projectDesc are required. If they're missing, the server prints an error at startup and may not appear in the list.

Colors in the name are written with the codes ^0 to ^9 (for example ^1 for red). Don't overdo it; the server list may shorten an overly “decorated” name.

Keys#

Game and security#

Selected game builds (each also includes all older DLCs):

The full, up-to-date list is in the FiveM documentation (link at the bottom). A higher build means a bigger download for players the first time they connect.

OneSync#

OneSync is FiveM's synchronization system: the server knows the position and state of all players and entities (cars, peds, objects) and decides itself what to send to whom. Thanks to this, it can handle more players, and scripts can work with entities directly on the server. Modern frameworks (ESX Legacy, QBCore, Qbox) require OneSync.

Slot limits:

• OneSync is free up to 48 slots. More slots require a FiveM Element Club Argentum subscription or higher on the Cfx.re Portal (opens in a new window).
• sv_maxclients of 32 and up requires OneSync on or legacy; more than 64 requires on.
• The subscription alone doesn't raise the slot count. After buying it, you have to increase sv_maxclients and restart the server.

Where to turn OneSync on:

• With txAdmin: only in txAdmin, Settings › FXServer › advanced options › OneSync (OneSync On recommended). txAdmin comments out any set onesync lines in server.cfg itself, with the note onesync MUST only be set in the txAdmin settings page.
• Without txAdmin: with the line set onesync on in server.cfg.

The FiveM for GTAV Enhanced platform no longer uses peer-to-peer (P2P) synchronization; the game always runs through the server.

Resources and ensure order#

Resources start in the order they appear in the file. So:

1. Standard FiveM resources at the top (mapmanager, chat, spawnmanager …).
2. Then the libraries the others depend on: oxmysql, ox_lib.
3. Then the framework core (es_extended, qb-core, qbx_core).
4. Finally the framework scripts and your own scripts.

If a script comes before its dependency, it won't start. Details in FiveM resources.

ACE permissions#

FiveM has a built-in permission system (ACL). It's made up of two commands:

add_ace group.admin command allow
add_ace group.admin command.quit deny
add_principal identifier.fivem:<FIVEM_ID> group.admin

• add_ace group.admin command allow – the group.admin group may use all commands (command is the general permission for commands).
• add_ace group.admin command.quit deny – except the quit command, which shuts down the server.
• add_principal identifier.fivem:<FIVEM_ID> group.admin – the player with this identifier belongs to the group.admin group and inherits its permissions.

In general: add_ace <WHO> <WHAT> allow|deny grants a permission and add_principal <WHO> <GROUP> puts a player in a group. The opposite commands are remove_ace and remove_principal. To find out whether someone has a permission, use the test_ace <WHO> <WHAT> command in the console.

Player identifiers:

You'll find a specific player's identifiers in txAdmin: Players, click the player and open the IDs tab. txAdmin adds the admin itself (the {{addPrincipalsMaster}} line in the recipe). Frameworks have their own admin groups, see ESX, QBCore or Qbox?.

Verification#

1. Save server.cfg and restart the server.
2. In the console (customer area or Live Console in txAdmin), check that no errors appeared at startup and that the resources started (Started resource …).
3. Open http://<IP_ADDRESS>:<PORT>/info.json in your browser (address from the Network tab). You'll see JSON with the server's public settings, including the values set with sets (sv_projectName, locale, tags).
4. Check the server with the CFX Resolver tool: it shows the name, slots, OneSync and the enforced build.

Troubleshooting#

Look up messages you can't find here in Common FiveM server errors.

The server isn't in the server list or shows as “private”#

• The sv_master1 "" line must not be active. Comment it out with #.
• Check that you have both sets sv_projectName and sets sv_projectDesc.
• It can take up to 8 minutes after startup for the server to appear in the list.
• Check that you can connect to the server directly: press F8 in the game and type connect <IP_ADDRESS>:<PORT>.

Connection rejected by server: Client/Server game build revision mismatch#

The player and the server have different build revisions, typically shortly after a game update. Update the server artifacts (guide). Players can switch the Update Channel in the FiveM client (gear icon › Game).

Players take a long time to connect or get stuck downloading#

After you change sv_enforceGameBuild, every player downloads the DLC data. This happens only once. If they get stuck repeatedly, check that the build exists (table above) and that there's no typo.

A ## [txAdmin CFG validator]: … line appeared in server.cfg#

txAdmin commented out a line that isn't allowed in server.cfg and wrote the reason after the colon. Most often it's onesync MUST only be set in the txAdmin settings page. (OneSync belongs in the txAdmin settings) or you MUST NOT start/stop/ensure txadmin resources. (txAdmin starts on its own; delete ensure monitor).

You can't set more than 48 slots#

Without an Element Club Argentum subscription, the limit is 48. On a server without txAdmin, the slot count may also be controlled by a variable in the Settings tab › Variables.

A change reverted after a restart#

You edited a line that a variable from the Settings tab overwrites at startup, or a different file than the one the server loads. With txAdmin, check CFG File Path in Settings › FXServer.

Further reading#

• FiveM: Server Commands (opens in a new window)
• FiveM: OneSync (opens in a new window)
• FiveM: Convars (set, setr, sets) (opens in a new window)
• FiveM: Server Issues (opens in a new window)