Grimwar/Dedicated servers

Getting started · Maps · VSig · VMod · Addons · Workshop · Servers · SDK

Community dedicated servers use an isolated writable data directory for configuration, addons, state, cache, replays, and secrets. Game installation files remain read-only and replaceable.

Create the server data directory

Assign a different absolute data directory to each server process:

GrimwarServer --data-dir /srv/grimwar/community-1 --server-preflight-only

The preflight checks the server runtime and creates missing operator files, then exits. A normal first launch creates the same layout. Existing operator files are not overwritten.

Use --instance-id <id> instead when the default per-user server location is appropriate. GRIMWAR_DATA_DIR and GRIMWAR_INSTANCE_ID provide the corresponding environment settings. Do not point two running servers at one data directory.

Run cmdlhelp in server console for the command-line contract and cfg_paths for the resolved install, data, config, secret, addon, replay, state, and cache paths.

Operator files

The generated layout includes:

Path	Purpose
config/server.cfg	Base non-secret server settings.
config/server.d/	Split non-secret configuration files.
config/rulesets/	Operator-defined rulesets.
config/modes/	Per-mode overrides.
config/maps/	Per-map overrides.
config/autoexec.cfg	Final non-secret overrides.
config/rotation.json	Startup map and rotation selection.
config/server-addons.json	Workshop items, manual bindings, and collections.
config/mods/	VMod Admin groups, users, and operator-owned mod configuration.
secrets/server.secrets.cfg	Sensitive settings such as the RCON password.
secrets/server.secrets.d/	Split sensitive configuration files.

The server applies server.cfg and server.d, the selected ruleset, mode and map overrides, autoexec.cfg, command-line overrides, secret files, then deployment overrides. Run authenticated cfg_reload to reapply the stack.

Keep passwords and tokens out of server.cfg. Sensitive commands found in an ordinary config layer are ignored.

Basic configuration

Uncomment only the settings you need in config/server.cfg. For example:

sv_ruleset casual
bot_quota 0
mp_timelimit 0
mp_roundtime 0
mp_winlimit 0
mp_maxrounds 0

Community and listen servers default to the bundled casual ruleset. A custom ruleset goes in config/rulesets/<name>.cfg and may inherit another ruleset:

// config/rulesets/community_plus.cfg
exec rulesets/casual.cfg
mp_allowspectators 0

Select it with sv_ruleset community_plus. During a live or overtime round, a change applies at the next round boundary unless now is supplied.

Configure RCON

Put RCON settings in secrets/server.secrets.cfg:

rcon_enable 1
rcon_password "use-a-long-unique-password"
rcon_port 27015
rcon_maxclients 3
rcon_timeout 30
rcon_failures 3
rcon_ban_time 300
rcon_log 1

Restrict access to the secret directory at the operating-system level. Expose the RCON TCP port only to administrator addresses or a private network. Do not reuse the server password or a Steam credential as the RCON password.

Configure map rotation

The default whitelist mode uses entries in file order:

{
  "listMode": "whitelist",
  "entries": [
    "as_compound",
    "community_castle"
  ]
}

Use internal map IDs from the package manifests. The server skips unavailable entries after addon synchronization and selects the first loadable entry. Startup fails when no entry can be loaded.

Set listMode to blacklist to rotate every registered map except the named entries:

{
  "listMode": "blacklist",
  "entries": [
    "as_compound",
    "community_ruins"
  ]
}

Blacklist expansion occurs after Workshop synchronization, so installed addon maps participate. Excluding every registered map is a startup error. Use changelevel <map> [mode] from authenticated console or RCON for an immediate manual change.

Install Workshop maps

Configure direct items and collections in config/server-addons.json. Store all Steam IDs as JSON strings:

{
  "schemaVersion": 1,
  "workshop": {
    "depotId": "",
    "items": [
      "1234567890"
    ],
    "manualItems": [],
    "collections": [
      "3456789012"
    ]
  }
}

items contains Workshop published-file IDs acquired by Steam. collections contains collection IDs; the server expands and installs their child items. Clients subscribe only to the addon required by the current map, not the whole collection.

Leave depotId empty unless Vellocet support directs you to override it. Grimwar supplies the fixed dedicated-server depot value.

Manually staged Workshop package

An operator can place an exact Workshop Release package below <data>/addons and bind it to the published item:

{
  "schemaVersion": 1,
  "workshop": {
    "depotId": "",
    "items": [],
    "manualItems": [
      {
        "publishedFileId": "1234567890",
        "addonId": "community_castle"
      }
    ],
    "collections": []
  }
}

Put an identity in exactly one acquisition list. The staged package must match the exact build currently uploaded to the Workshop item. Replace it after every Workshop update. Clients still download the Steam item; they never receive files from the server's staged folder.

Install VMods

1. Run vmod_runtime_paths and use the printed addon directory.
2. Copy the complete VMod addon folder below <data>/addons.
3. Restart, or run vmod_runtime_reload while no scripted mode is active.
4. Confirm the package with vmod_runtime_list.

VMod-only packages are server-only and are not currently acquired through Workshop. Admin users and groups live below <data>/config/mods. See VMod scripting and administration.

Startup and diagnostics

Before opening the server publicly:

1. Run preflight with the production data directory and deployment port mapping.
2. Start the server and confirm it reaches its ready/listening state.
3. Run status -v and verify role, build, protocol, transport, map, mode, ruleset, data path, and player limit.
4. Run cfg_paths and confirm the expected data and secret roots.
5. Check that every rotation map is registered after Workshop synchronization.
6. Join with a separate Steam account and test authentication, map delivery, round transition, and map change.
7. Test RCON from an allowed administrator address.

Useful log prefixes are [ServerWorkshop] for server acquisition and activation, [WorkshopDL] for exact client/server addon matching, [SteamWorkshop] for Steam installation, [ContentDL] for provider selection, and [Net] for pre-login requirements. Set net_log 2 when per-addon network identities are needed.

Back up the data directory before game or addon updates. It contains operator configuration, VMod state, source selections, bans, and other mutable server data. The game install directory is not a substitute for that backup.