1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
# Warzone 2100 command interface
In version 4.2.0, an `--enablecmdinterface` CLI option was introduced that enables
partial administrative control of Warzone 2100 instance via `stdin` / `stderr`.
> `stdout` is already used by numerous other aspects of WZ's logging and other subsystems, so (for now) `stderr` is used for Command Interface output
All messages are sent in plain-text UTF-8 and end with 0x0a (`\n`).
## `stderr` state / response messages
`WZCMD: ` is for stdin command interface (and responses to commands)\
`WZCHATCMD: ` is for in-lobby chat commands and messages\
`WZEVENT: ` is for instance-related events like player join or game start
* `WZCMD: stdinReadReady`\
`stdinReadReady` message signals support for stdin pipe commands
(see section [`stdin`](#stdin-commands))
* `WZCMD error: <error message>`\
`error` messages describe errors relevant to the command interface\
(example: fail to read command from `stdin` will produce `WZCMD error: getline failed!`)
* `WZCMD info: <info message>`\
`info` messages carry non-critical data, but can help check that
`stdin` commands are executed correctly.
* `WZCHATCMD: <index> <ip> <hash> <b64pubkey> <b64name> <b64msg>`\
Passes a lobby slash command message - to log use of slash commands or implement additional operations.\
Fields after `WZCHATCMD: `:
- `%i` **index** of player
- `%s` IP address of player in plain text (v4/v6)
- `%s` public hash string of the player (max 64 bytes)
- `%s` base64-encoded public key of the player
- `%s` base64-encoded name of the player
- `%s` base64-encoded chat message content
* `WZEVENT: join approval needed: <joinid> <ip> <hash> <b64pubkey> <b64name> [spec|play]`\
Passes a join request that requires approval (if `--async-join-approve` is enabled)\
**Important: If the cmdinterface client does not respond to this request with a `join <approve/reject>` command in a timely manner, the joiner will be kicked (or drop).**\
Fields:
- `%s` a unique **joinid** to refer to the joining connection (should be passed to `join <approve/reject>`)
- `%s` IP address of player in plain text (v4/v6)
- `%s` public hash string of the player (max 64 bytes)
- `%s` base64-encoded public key of the player
- `%s` base64-encoded name of the player
- `%s` either `spec` or `play` to distinguish whether the request is for joining spectators or players
* `WZEVENT: bancheck: <ip>`\
Passes IP of connected player to initiate outside-check.
* `WZEVENT: lobbyid: <gid>`\
Game id, announced as assigned from lobby.
* `WZEVENT: startMultiplayerGame`\
Marks the start of loading of a multiplayer game.
* `WZEVENT: lag-kick: <index?position> <ip>`\
Notifies about player being kicked from the game due to connection issues.
* `WZEVENT: lobbyerror (<code>): <b64 motd>`\
`WZEVENT: lobbysocketerror: [b64 motd]`\
`WZEVENT: lobbyerror (<code>): Cannot resolve lobby server: <socket error>`\
Signals about lobby error. (motd is base64-encoded)
# `stdin` commands
`stdin` interface is super basic but at the same time a powerful tool for automation.
All messages **must end with `0x0a` (`\n`) in order to be processed!**
If state of interface buffer is unknown and/or corrupted, interface can send a few `0x0a` in order to clean reader buffer.
* `exit`\
Shuts down **stdin reader interface**
* `admin add-hash <hash>`\
Adds hash to the list of room admins
* `admin add-public-key <pkey>`\
Adds public key to the list of room admins
* `admin remove <pkey|hash>`\
Removes admin from room admins list by public key or hash
* `join <approve|approvespec|reject> <joinid> <code> <rejectmsg [^\n]>`\
Approve or reject an attempt to join the game.\
Pass in the `<joinid>` received in a `WZEVENT: join approval needed` event.
- `<approve|approvespec|reject>`
- `approvespec` approves the join but forces the client to spectators, and prevents them from switching back to players
- `<code>` is `LOBBY_ERROR_TYPES` enum (use 7 to avoid double-screening client with "you are kicked")
- `<rejectmsg [^\n]>` is an (optional) custom rejection message that will be displayed on the client
* `ban ip <ip>`\
Find and kick (with adding to ip banlist) player with specified ip
(result of `WZEVENT: bancheck:` from outside)
* `redirect identity <pkey> <connectionstring>`\
Kick + redirect any player(s) matching the specified identity to a different game instance hosted on the same host
- `<connectionstring>` takes the form: `<tcp|gns>:<port>:<specjoin>:<gamepassword>` where:
- `port` specifies a new port to connect to (which must be > `1024`)
- `specjoin` is either `0` (join as player) or `1` (join as spectator)
- `gamepassword` is an (optional) password to use when joining a password-protected game
> NOTE: Currently, you can do this once per user-initiated join to a server. (Repeated redirects will just kick the player.)
* `permissions set connect:allow <pkey|hash>`\
Allows player with the specified identity to connect (bypassing any ip bans)
* `permissions set connect:block <pkey|hash>`\
Blocks the specified identity from connecting. Kicks any already-connected player with this identity.
* `permissions unset connect <pkey|hash>`\
Removes any previously-set connect permission (allow / block) for the specified identity
* `set chat <allow|quickchat> <all|newjoin|host|pkey|hash>`\
Allows or mutes chat.
- Parameter 1: If "allow" is specified, allows all chat (both free chat and quick chat). If "quickchat" is specified, mutes / disallows free chat (but still allows quick chat).
- Parameter 2: If "all" is specified instead of an identity, applies to all. If "newjoin" is specified instead of an identity, applies to future joins.
* `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.
|
