server.cfg Generator

The server.cfg Generator writes a complete server.cfg for a RedM server from a form. Pick a framework preset, fill in your name, key and admins, and copy or download the file. The preview on the right updates on every change.

What it is for

A RedM server.cfg is a FiveM server.cfg with a few lines that matter a lot: set gamename rdr3, the RedM build to enforce, and RedM’s own stock resources (redm-map-one instead of the GTA ones). Getting one of those wrong gives you a server that starts GTA V resources or none at all. This tool starts from the lines the official recipes use and lets you change the rest.

Quick start

1. Pick a Framework: Standalone, VORP or RSG. This replaces the resource list and sets the tags.
2. Fill in Server identity (hostname, project name, description, tags).
3. Paste your key into sv_licenseKey under Keys and branding.
4. Add yourself under Permissions (ACE), Admins: pick the identifier type and paste the value.
5. Copy the server.cfg on the right, or press Download.
6. Put it in your server-data folder next to resources and start the server (or point txAdmin at it).

Clear the two amber warnings at the top of the preview before you go live. With the defaults they read “Set sv_licenseKey” and “No admin identifier set”.

The default file

This is what the form writes before you change anything (Standalone preset, txAdmin on):

# ==========================================================
#  server.cfg (RedM)
#  Generated with fivemad.com/redm/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 RedM Server ^7| Western RP"
sets sv_projectName "My RedM Server"
sets sv_projectDesc "Western roleplay on RedM"
sets locale "en-US"
sets tags "default"

## Slots and game
set gamename rdr3
sv_maxclients 48
set onesync on
set sv_enforceGameBuild 1491      # September 2022 update

## Security
sv_endpointprivacy true

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

## Standalone settings (from its txAdmin recipe)
set resources_useSystemChat true

## Resources (load order matters)
# Default cfx resources (default-redm recipe)
ensure mapmanager
ensure chat
ensure spawnmanager
ensure redm-map-one
ensure hardcap

## 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

set gamename rdr3 is always written. It is what makes the server a RedM one.

Framework presets

Each preset is copied from that framework’s own txAdmin recipe: its resource order, the convars it sets and the ACE lines it adds.

Picking VORP or RSG also turns on Database and Voice (pma-voice), because both frameworks need them. RSG additionally switches voice to 3D audio, turns the built in UI on and Sending range only off, which is what its recipe sets. An admin row that still has a preset’s admin group is moved to the new preset’s group.

Panels and options

Server identity

Slots, network and game

Keys and branding

sv_licenseKey (from portal.cfx.re), steam_webApiKey (written as none when empty), Server icon file (a 96x96 PNG next to server.cfg, written as load_server_icon), Discord, banner_detail URL, banner_connecting URL, sv_tebexSecret, and Extra sets variables for any other sets key "value" line you want. Empty fields are left out of the file.

Security

Database

Off by default. Enabled writes one set mysql_connection_string line for oxmysql from Host, Port, User, Password and Database (default database name redm). The password is URL encoded for you, so special characters are safe.

Voice (pma-voice)

Off by default. Enabled writes the pma-voice convars: Audio mode (native 3D, 2D by distance, 3D audio, or the pma-voice default), Sending range only, Built-in UI, Radio animation, Range key (F11) and Radio key (LMENU). If pma-voice is not already in your resource list (or in a folder the preset says holds it), an ensure pma-voice line is added at the end of the resources.

Pool sizes

Empty by default. Add pool adds an increase_pool_size row. The pool list and the maximum next to each one are the RedM column of the table on docs.fivem.net, and a number over the maximum is capped, because the server ignores a value past it.

Raise a pool only when the server console tells you it is full.

Resources

One entry per line, in load order:

• A plain name becomes ensure name.
• [folder] becomes ensure [folder], which starts every resource in that folder.
• A line starting with # stays a comment.
• A line that already starts with ensure, start, stop, restart, exec, set, setr or sets is written as it is.

If the list contains ox_lib (or [ox]), the file also gets setr ox:locale "en" and the four ox_lib ACE lines it needs.

Permissions (ACE)

Admins takes an identifier type (license, license2, fivem, discord, steam, xbl, live, ip), the value, a group and a note. Paste just the value: a leading license: (or whichever type you picked) is stripped, so it is never written twice. Custom rules adds your own add_ace and add_principal lines; Hide custom rules folds that part away.

Tips

• The form is saved in your browser, separately from the FiveM server.cfg generator, so you can come back to it. Reset puts every field back to the defaults above.
• Change the framework first and the rest after: picking a preset replaces the resource list and the tags.
• Find a player’s identifiers in txAdmin (Players, then a player), or print GetPlayerIdentifiers(source) from a server script.

Common mistakes

• A resource does not start. Every resource on a RedM server needs game 'rdr3' and the rdr3_warning line in its fxmanifest.lua. Use the Resource Conflict Checker to find the ones that are missing it.
• Framework errors about the database. VORP and RSG need MariaDB or MySQL. The preset turns Database on, but the default password is empty, which the warning panel points out.
• ensure [standalone] starts nothing. The folder name has to match the folder on disk exactly, brackets included.
• Two loading screens. The VORP preset starts loadingscreen. If you build your own with the Loading Screen Generator, take that line out.

Limitations

• Only one RedM game build is offered, because docs.fivem.net lists only one.
• The presets follow the recipes as they were when the tool was written. If a framework renames or adds resources later, edit the list by hand.
• It writes the config only. It does not install resources, create the database or check that the resources in the list exist.

Related tools

• Resource Conflict Checker
• Loading Screen Generator
• Item Generator