Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
past-due committed Jan 13, 2025
1 parent 3f9e15f commit bd74426
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 1 deletion.
3 changes: 3 additions & 0 deletions doc/CmdInterface.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,5 +112,8 @@ If state of interface buffer is unknown and/or corrupted, interface can send a f
* `chat bcast <message [^\n]>`\
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.
9 changes: 8 additions & 1 deletion doc/hosting/AutohostConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand All @@ -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": {
Expand Down
6 changes: 6 additions & 0 deletions doc/hosting/DedicatedHost.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ You can provide more arguments to fine-tune your environment.
* `--autorating=<host>` overrides the autorating url. See `AutoratingServer.md` for details about the autorating server.


#### Advanced usage

* `--enablecmdinterface=<stdin|unixsocket:path>` 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.
Expand Down

0 comments on commit bd74426

Please sign in to comment.