server.cfg generator

Vul een formulier in en krijg een nette server.cfg met commentaar, klaar om in je FiveM server te zetten, inclusief OneSync, endpoints, tags, locale, resources en ACE permissies.

De uitleg onder de tool is voorlopig in het Engels.

Config & codeConfig, DownloadLees de docs

Framework

Server identiteit

sv_hostnameWordt in de serverlijst getoond. ^1 tot ^9 zijn kleurcodes.ProjectnaamLocaleProjectbeschrijvingTagsKomma gescheiden. Gebruikt voor zoeken in de serverlijst.

Slots, netwerk en game

sv_maxclients: 48

OneSync

Bind IP0.0.0.0 luistert op elke interface.PoortTCP en UDP moeten beide open staan.sv_enforceGameBuildZet DLC voertuigen, maps en kleding tot en met die update aan.

Keys en branding

sv_licenseKeyVan portal.cfx.re. Houd hem privé.steam_webApiKeyAlleen nodig voor Steam identifiers.Server icon bestand96x96 PNG naast server.cfg.Discordbanner_detail URL1920x200 afbeelding op de detailpagina van de server.banner_connecting URLWordt tijdens het verbinden getoond.sv_tebexSecretTebex game server secret, als je packages verkoopt.

Extra sets variabelen

Beveiliging

Draait onder txAdminVoegt txAdmin notities toe en laat rcon weg.sv_endpointprivacyVerberg de IPs van spelers voor andere spelers.sv_scriptHookAllowedSta ScriptHook mods toe. Laat dit uit op publieke servers.Privéserversv_master1 "": niet in de serverlijst zetten.sv_pureLevelsv_entityLockdown

Database

Zet aan om mysql_connection_string voor oxmysql toe te voegen.

Voice (pma-voice)

Zet aan om de pma-voice convars toe te voegen en zorg dat het gestart wordt.

Resources

Eén per regelGewone namen worden ensure regels. [folder] start elke resource in die map. Regels die met # beginnen blijven commentaar.

Permissies (ACE)

Admins

Vind identifiers in txAdmin (Players, dan een speler) of met GetPlayerIdentifiers(source). Plak alleen de waarde, de license: prefix is optioneel.

Eigen regels

add_principal child parent laat de child alles overnemen wat de parent heeft.

Zet sv_licenseKey. Haal een key op portal.cfx.re.

Geen admin identifier gezet. Je hebt dan geen admin permissies.

server.cfg

# ==========================================================
#  server.cfg
#  Generated with fivemad.com/tools/server-cfg-generator
#  Docs: https://docs.fivem.net/docs/server-manual/setting-up-a-server/
# ==========================================================
#
#  txAdmin: start the server from txAdmin, not with +exec.
#  txAdmin reads the port from the endpoint lines below, so keep them.
#  Restarts, schedules and bans are handled in the txAdmin panel.

## Networking
endpoint_add_tcp "0.0.0.0:30120"
endpoint_add_udp "0.0.0.0:30120"

## Server identity
sv_hostname "^5My Server ^7| Serious RP | Discord: example"
sets sv_projectName "My Server"
sets sv_projectDesc "Serious roleplay with custom jobs and an active staff team"
sets locale "en-US"
sets tags "default"

## Slots and game
sv_maxclients 48
set onesync on
set sv_enforceGameBuild 3258      # Bottom Dollar Bounties

## Security
sv_scriptHookAllowed 0
sv_pureLevel 1                 # blocks modified game files, allows audio and graphics mods
sv_endpointprivacy true

## Keys
set steam_webApiKey "none"   # https://steamcommunity.com/dev/apikey
sv_licenseKey "changeme"   # https://portal.cfx.re

## Resources (load order matters)
# Default cfx resources
ensure mapmanager
ensure chat
ensure spawnmanager
ensure sessionmanager
ensure basic-gamemode
ensure hardcap
ensure baseevents

## Permissions
add_ace group.admin command allow            # all commands
add_ace group.admin command.quit deny        # but not quit
# add_principal identifier.license:xxxxxxxx group.admin   # add yourself here

How to use it

Pick your framework. It fills a working ensure order and the matching permission lines.
Fill in the hostname, license key, slots and game build. Warnings on the right point out common mistakes.
Add yourself as admin with your license or Discord identifier.
Download server.cfg into your server-data folder (next to the resources folder).

Everything stays in your browser, including the license key and database password. The form is saved locally so you can come back to it.

Starting the server

With txAdmin, point the deployer or Settings, then FXServer, at this file. Without txAdmin, start FXServer from the server-data folder:

# Windows
C:\FXServer\server\FXServer.exe +exec server.cfg

# Linux
bash ~/FXServer/server/run.sh +exec server.cfg

Load order

Resources start in the order they are listed. Libraries such as oxmysql and ox_lib must come before the framework core, and the core (qb-core, qbx_core, es_extended) before any script that uses it. ensure [folder] starts everything inside a bracketed folder and you do not control the order inside it, so ensure dependencies explicitly before the folder.

OneSync and slots

set onesync on is what almost every modern resource expects. Without OneSync the cap is 32 players.
Up to 48 slots works with any key. Going higher needs an Element Club subscription on the Cfx.re account that owns the key.
sv_enforceGameBuild must be set before players join. Changing it makes clients download the matching game build on their next connect.

ACE permissions in short

# give a group a permission
add_ace group.admin command allow
# put a player (or group) inside a group
add_principal identifier.license:abc123 group.admin
# let one group inherit another
add_principal group.admin group.mod

Check a permission in Lua with IsPlayerAceAllowed(source, 'command.kick'). After editing ACE lines you can apply them live by pasting them into the server console.

Gotchas

Do not commit server.cfg to a public repo: it holds your license key and database password. Move secrets to a separate file and exec secrets.cfg.
Special characters in the database password must be URL-encoded in mysql_connection_string. The generator does that for you.
setr convars are replicated to clients, sets convars are shown publicly in the server list, plain set stays on the server.