Zum Inhalt springen
Server setup

Set up a RedM server

A RedM server is FXServer with set gamename rdr3 and the enforced RDR2 build. The artifacts, the server.cfg lines, the stock resources and txAdmin.

Diese Doku ist vorerst auf Englisch.

Last updated

A RedM server is the same FXServer you would run for FiveM. You download the same artifacts, install it the same way, and start it the same way. What makes it a RedM server is two lines in server.cfg: the game name and the RDR2 build.

The two lines

server.cfg
set gamename rdr3
sv_enforceGameBuild 1491
Line What it does
set gamename rdr3 Runs the server for RDR2. Without it the server runs for GTA V, as a FiveM server.
sv_enforceGameBuild 1491 The RDR2 game build players run on. 1491 is the September 2022 update, and it is the one RedM build docs.fivem.net lists for this convar. The generator writes it as set sv_enforceGameBuild 1491, which sets the same convar.

The full block from the official recipe

These are the lines of citizenfx’s default-redm txAdmin recipe that make it a RedM server, with the stock resources it starts:

server.cfg
# the lines that make it a RedM server (from the official default-redm recipe)
set gamename rdr3
sv_enforceGameBuild 1491

# the stock resources that recipe starts
ensure mapmanager
ensure chat
ensure spawnmanager
ensure redm-map-one
ensure hardcap

redm-map-one takes the place of the FiveM map resource. The rest of a server.cfg (endpoints, sv_licenseKey, sv_maxclients, sv_hostname, ACE lines, convars) is written exactly as for FiveM; the FiveM page server.cfg explained line by line covers every one of them.

Tip

The server.cfg Generator writes a complete RedM server.cfg with these lines, the stock resources, and presets taken from the VORP and RSG txAdmin recipes. Its guide is here.

Artifacts

RedM uses the same FXServer builds as FiveM. Pick a recommended one, and avoid the builds marked broken, on the Server artifacts page. Installing them is covered for Windows and Linux in the FiveM docs, and nothing in those steps changes for RedM.

License key

The sv_licenseKey comes from portal.cfx.re, the same portal and the same kind of key as for FiveM.

txAdmin

txAdmin ships with FXServer. When it asks for a recipe, pick a RedM one:

Recipe What you get
citizenfx default-redm The stock resources above and nothing else. Good for a standalone server or to learn on.
VORP The VORP framework with its resources and database. txAdmin’s own recipe list carries it.
RSG The RSG framework, from Rexshack-RedM’s own recipe.

Frameworks explains how VORP and RSG differ.

Before you start it

  • Every resource you add needs game 'rdr3' and the rdr3_warning line in its manifest, or it does not start. See The fxmanifest.
  • A FiveM resource does not start on a RedM server as it is. See Porting a FiveM resource.
  • Pool sizes (increase_pool_size) are a different set on RedM, with their own limits. The generator lists the RedM ones; raise a pool only when the console says it is full.

Checking it is up

The Server Status Checker and the Uptime Badge read RedM servers from the same Cfx.re list as FiveM ones, so they work for your RedM server unchanged.