Runtime Configuration Reference

Southclaws edited this page Jun 1, 2018 · 7 revisions

A Runtime Configuration is basically a JSON or YAML version of the server.cfg file you are already familiar with. These configuration objects are found in the runtime field of a pawn.json file.

The setting key names are the exact same as the server.cfg settings.

Additional Settings

There are additional fields that do not go into the server.cfg file, these are for controlling sampctl itself.

version

The SA:MP server version to use.

mode

The Runtime Mode of the server.

extra

An object containing strings for any additional settings for plugins for example:

{
  "extra": {
    "discord_token": "abc123"
  }
}

All Possible Settings

key value type
version string
endpoint string
mode string
extra . object of strings
gamemodes array of strings
rcon_password string
announce bool
maxplayers int
port int
lanmode bool
query bool
rcon bool
logqueries bool
stream_rate int
stream_distance float
sleep string
maxnpc int
onfoot_rate int
incar_rate int
weapon_rate int
chatlogging bool
timestamp bool
bind string
password string
hostname string
language string
mapname string
weburl string
gamemodetext string
filterscripts array of strings
plugins array of strings
nosign string
logtimeformat string
messageholelimit int
messageslimit int
ackslimit int
playertimeout int
minconnectiontime int
lagcompmode int
connseedtime int
db_logging bool
db_log_queries bool
conncookies bool
cookielogging bool

Environment Variables

You can also use environment variables to configure, just prefix them with SAMP_ and uppercase the rest.

For example: rcon_password's environment variable is SAMP_RCON_PASSWORD.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.