From 4d806eae437297988cabf5a0f4e3d575030e3ae8 Mon Sep 17 00:00:00 2001 From: past-due <30942300+past-due@users.noreply.github.com> Date: Sun, 12 Jan 2025 19:03:50 -0500 Subject: [PATCH] Documentation updates --- doc/CmdInterface.md | 3 +++ doc/hosting/AutohostConfig.md | 9 ++++++++- doc/hosting/DedicatedHost.md | 6 ++++++ 3 files changed, 17 insertions(+), 1 deletion(-) diff --git a/doc/CmdInterface.md b/doc/CmdInterface.md index 8552f6c41cc..510bf17a162 100644 --- a/doc/CmdInterface.md +++ b/doc/CmdInterface.md @@ -112,5 +112,8 @@ If state of interface buffer is unknown and/or corrupted, interface can send a f * `chat bcast `\ Send system level message to the room from stdin. +* `set host ready <0|1>`\ + Sets the host ready state to either not-ready (0) or ready (1). + * `shutdown now`\ Trigger graceful shutdown of the game regardless of state. diff --git a/doc/hosting/AutohostConfig.md b/doc/hosting/AutohostConfig.md index 3e67d8fbd4e..2b13a2c7cd5 100644 --- a/doc/hosting/AutohostConfig.md +++ b/doc/hosting/AutohostConfig.md @@ -20,6 +20,12 @@ The `challenge` object defines the game parameters for a multiplayer game. * `techLevel` sets the starting technology level. `1` for level 1 (wheel), `2` for level 2 (water mill), `3` for level 3 (chip), `4` for level 4 (computer). * `spectatorHost` when `true` or `1`, the host will spectate the game. When `false` or `0`, the host will play the game. * `openSpectatorSlots` defines how much spectator slots are opened (one more is opened for the host when spectating). +* `blindMode` configures blind lobby / game mode. Available values are: + * `"none"`: blind modes disabled (the default) + * `"blind_lobby"`: Players' true identities are hidden from everyone except the host - **until the game _starts_** + * `"blind_lobby_simple_lobby"`: Same as `blind_lobby`, but with the addition of "simple lobby" mode (players will be placed in a waiting room where they can't see the list of players until the game starts) + * `"blind_game"`: Players' true identities are hidden from everyone except the host - **until the game _ends_** + * `"blind_game_simple_lobby"`: Same as `blind_game`, but with the addition of "simple lobby" mode (players will be placed in a waiting room where they can't see the list of players until the game starts) * `allowPositionChange` is deprecated, use the `locked` object instead. ## the `locked` object @@ -48,7 +54,7 @@ Each player slot can be customized, starting from 0. The first slot will be defi ## Sample file -``` +```json { "locked": { "power": false, @@ -71,6 +77,7 @@ Each player slot can be customized, starting from 0. The first slot will be defi "techLevel": 1, "spectatorHost": true, "openSpectatorSlots": 2, + "blindMode": "none", "allowPositionChange": true }, "player_0": { diff --git a/doc/hosting/DedicatedHost.md b/doc/hosting/DedicatedHost.md index ee268f0cc9e..ca4803540a3 100644 --- a/doc/hosting/DedicatedHost.md +++ b/doc/hosting/DedicatedHost.md @@ -34,6 +34,12 @@ You can provide more arguments to fine-tune your environment. * `--autorating=` overrides the autorating url. See `AutoratingServer.md` for details about the autorating server. +#### Advanced usage + +* `--enablecmdinterface=` enables the command interface. See [/doc/CmdInterface.md](/doc/CmdInterface.md) +* `--autohost-not-ready` starts the host (autohost) as not ready, even if it's a spectator host. Should usually be combined with usage of the cmdinterface to trigger host ready via the `set host ready 1` command (or the game will never start!) + + ### Checking your firewall If your server starts but nobody can join, check that your firewall is accepting incoming TCP connections on the given port.