Skip to main content

Settings

SettingDescriptionDefault Value
hostaddressThe address the server will bind to.

Use :: to listen on all local IPv4 & IPv6 adapters.
Use 0.0.0.0 to listen on all local IPv4 adapters.
127.0.0.1
hostnameThe hostname players will see in the server list.HappinessMP Server
listedWhether the server should be displayed on the server list.true
portPort the server will listen on.

Allowed Range: 1024 - 65535
9999
relayportUDP port the relay will listen on. The relay carries the game sync traffic, so this port has to be open as well (see Ports).

Allowed Range: 1024 - 65535
9998
maxplayersMaximum number of players the server will support.

Current max: 100
32
episodeSelect game episode to be used by server.

0 = IV
1 = TLAD
2 = TBOGT
0
secretSecret used for encrypting client side resource files.changeme
statstokenToken that unlocks the stats endpoint. While this is empty, the endpoint does not exist at all.(empty)
loglevelSelect log level for console and log file.

0 = Trace
1 = Debug
2 = Info
3 = Warn
4 = Error
5 = Critical
6 = Off
2
chatWhether the standard chat provided by the client should be activated, usable with chat functions.true
resourceList of resources to be loaded. Repeat the element once per resource.
addonList of addons to be loaded. Repeat the element once per addon.

Notes

settings.xml is created with all defaults on the first start if it does not exist yet.

settings.xml
<settings>
<hostname>My Server</hostname>
<port>9999</port>

<resource>core/chat</resource>
<resource>gamemodes/freeroam</resource>

<addon>vehicles/police</addon>
</settings>

resource and addon take the full name of the folder below resources/ respectively addons/, including category folders.

info

Boolean settings accept true, 1 and yes. Everything else counts as false.

A value outside the allowed range is clamped to the nearest valid one, and an element the server does not know is ignored with a warning in the log. So a typo in a setting name never stops the server, it just does nothing.