MultiplayerServerWML - Revision history

Pentarctagon: /* Game setup (the phase from creation to start) */

2026-02-22T15:17:36Z

‎Game setup (the phase from creation to start)

2026-02-22T15:14:33Z

‎Queues

2026-02-22T15:13:08Z

‎Queues

2026-02-22T14:46:30Z

‎Queues

2026-02-22T14:46:00Z

2025-03-03T08:44:13Z

‎Error messages

2025-02-12T16:15:53Z

‎In-game communication

2025-02-12T16:00:21Z

‎In-game communication

2025-02-12T14:54:27Z

‎In-game communication: rearrange in-game communication section into related groups

2025-01-02T13:07:58Z

‎The login procedure

@@ Line 129: / Line 129: @@
 ** '''password''': The password to use to join the game.
 ** '''ignored''': The list of ignored players from the host.
-** '''auto_hosted''': True if this request is from a bot, false otherwise.
+** '''auto_hosted''': True if this request is from a bot or a server-side queue, false otherwise.
 followed by a message with the scenario options as under [game] (see above) plus the scenario data ([time], [era], [side], etc. see [[ScenarioWML]])

@@ Line 207: / Line 207: @@
 ** '''players_required''': How many players are required before a game is started. Only used by add/update.
-When there are enough players to start a game, the last player to join the queue is chosen as the host and their client is told to create the game with the provided settings. This skips the game creation screen and goes straight to the staging screen. The other players in the queue are then told to join that game:
+When there are enough players to start a game, the last player to join the queue is chosen as the host and their client is told to create the game with the provided settings. This skips the game creation screen and goes straight to the staging screen. The other players in the queue are then told to join that game using the normal [join] command:
 * '''[create_game]'''
 ** '''queue_id''': The ID of the queue to create the game for.

@@ Line 206: / Line 206: @@
 ** '''display_name''': The text to show in the list of queues in the lobby. Only used by add/update.
 ** '''players_required''': How many players are required before a game is started. Only used by add/update.
 == Administrative commands ==

@@ Line 204: / Line 204: @@
 ** '''queue_id''': The server's unique ID for the queue.
 ** '''action''': One of add/update/remove.
-** '''display_name''': The text to show in the list of queues in the lobby.
+** '''display_name''': The text to show in the list of queues in the lobby. Only used by add/update.
-** '''players_required''': How many players are required before a game is started.
+** '''players_required''': How many players are required before a game is started. Only used by add/update.
 == Administrative commands ==

@@ Line 198: / Line 198: @@
 *** '''2''':modification
 ** '''search_content''': The content to filter by. This is the ID of the content, not the name displayed on the UI, due to the translated name getting stored in the database.
 == Administrative commands ==

@@ Line 95: / Line 95: @@
 * '''[error]'''
 ** '''message''': The error message.
 == Chat (lobby and in-game) ==

@@ Line 154: / Line 154: @@
 * '''[request_choice]'''
 ** '''request_id''': unique ID of the choice request
-** '''[random_seed]''': Client requests a random number (used for attacks for example)
+** '''[random_seed]''': client requests a random number (used for attacks for example)
-** '''[change_controller_wml]''': Change controller request from scenario WML
+** '''[change_controller_wml]''': change controller request from scenario WML
 * '''[store_next_scenario]''': sent by the host - the scenario data (see [[ScenarioWML]]) to advance to the next scenario
 * '''[notify_next_scenario]''': sent by the server to tell players that the data for the next scenario is available

@@ Line 143: / Line 143: @@
 == In-game communication ==
 * '''[store_next_scenario]''': sent by the host - the scenario data (see [[ScenarioWML]]) to advance to the next scenario
 * '''[notify_next_scenario]''': sent by the server to tell players that the data for the next scenario is available
@@ Line 152: / Line 161: @@
 ** '''condition''': the termination reason
 * '''[change_controller]''': a player (un)droids one of his sides or assigns control to someone else (The host can assign control for any side.)
 ** '''side''': the side to change controller
@@ Line 157: / Line 171: @@
 ** '''controller''': the new controller: "human" or "human_ai"
 ** '''own_side''': "yes"
 * '''[muteall]''': the host mutes/unmutes all observers - toggles
 * '''[mute]''': the host mutes an observer - toggles
@@ Line 167: / Line 176: @@
 * '''[kick]''' or '''[ban]''': the host kicks/bans a player/observer
 ** '''username''': the username of the player/observer
 == Game history ==

@@ Line 35: / Line 35: @@
 *** '''is_moderator''': "yes" if the user is a moderator, "no" otherwise.
 *** '''profile_url_prefix''': The external URL prefix for player profiles (empty if the server doesn't have an attached database)
-** or '''[error]'''
+** or '''[error]''' (server is waiting for another '''[login]''' message now)
 *** '''message''': The error message.
 *** '''password_request''': If not empty the server asks the client to provide a password for its desired username.