Clanker: Remove development history and server internals

2026-10-24T17:14:20Z

Remove development history and server internals

← Older revision		Revision as of 17:14, 24 October 2026
Line 1:		Line 1:
	{{SimTX API navigation}}		{{SimTX API navigation}}
	This page lists every message that can be sent as a frame of the [[SimTX API]] game protocol, version 25. Each frame is a <code>ClientFrame</code> (client to server) or a <code>ServerFrame</code> (server to client) with exactly one <code>oneof</code> member set; the member's number identifies the message. The two directions have separate number spaces, allocated in the same blocks: 1 to 9 for the connection, 10 to 29 for receiver and transmitter sessions, 30 to 59 for control and 60 to 79 for moderation. Some numbers mean the same thing in both directions, for example 33 is <code>weather_map</code> both ways~~, but this is only a convention~~.		This page lists every message that can be sent as a frame of the [[SimTX API]] game protocol, version 25. Each frame is a <code>ClientFrame</code> (client to server) or a <code>ServerFrame</code> (server to client) with exactly one <code>oneof</code> member set; the member's number identifies the message. The two directions have separate number spaces, allocated in the same blocks: 1 to 9 for the connection, 10 to 29 for receiver and transmitter sessions, 30 to 59 for control and 60 to 79 for moderation. Some numbers mean the same thing in both directions, for example 33 is <code>weather_map</code> both ways.

	Every message has its own page, and the wire format is described on [[SimTX API/Framing]].		Every message has its own page, and the wire format is described on [[SimTX API/Framing]].
Line 38:		Line 38:
	\| 30 \|\| <code>list_stations</code> \|\| [[SimTX API/Packets/ListStations\|ListStations]] \|\| [[SimTX API/Control session\|Control]], [[SimTX API/Moderation session\|moderation]] \|\| Asks for the list of stations on the server.		\| 30 \|\| <code>list_stations</code> \|\| [[SimTX API/Packets/ListStations\|ListStations]] \|\| [[SimTX API/Control session\|Control]], [[SimTX API/Moderation session\|moderation]] \|\| Asks for the list of stations on the server.
	\|-		\|-
	\| 31 \|\| <code>start_monitor</code> \|\| [[SimTX API/Packets/StartMonitor\|StartMonitor]] \|\| [[SimTX API/Control session\|Control]], [[SimTX API/Moderation session\|moderation]] \|\| Asks the server to stream the signal of a transmitter back to the client~~, so that an operator can hear what they are sending~~.		\| 31 \|\| <code>start_monitor</code> \|\| [[SimTX API/Packets/StartMonitor\|StartMonitor]] \|\| [[SimTX API/Control session\|Control]], [[SimTX API/Moderation session\|moderation]] \|\| Asks the server to stream the signal of a transmitter back to the client.
	\|-		\|-
	\| 32 \|\| <code>stop_monitor</code> \|\| [[SimTX API/Packets/StopMonitor\|StopMonitor]] \|\| [[SimTX API/Control session\|Control]], [[SimTX API/Moderation session\|moderation]] \|\| Ends a monitor stream started with [[SimTX API/Packets/StartMonitor\|StartMonitor]].		\| 32 \|\| <code>stop_monitor</code> \|\| [[SimTX API/Packets/StopMonitor\|StopMonitor]] \|\| [[SimTX API/Control session\|Control]], [[SimTX API/Moderation session\|moderation]] \|\| Ends a monitor stream started with [[SimTX API/Packets/StartMonitor\|StartMonitor]].
Line 75:		Line 75:
	\| 2 \|\| <code>pong</code> \|\| [[SimTX API/Packets/Pong\|Pong]] \|\| [[SimTX API/Connection and handshake\|All roles]] \|\| Answers a [[SimTX API/Packets/Ping\|Ping]].		\| 2 \|\| <code>pong</code> \|\| [[SimTX API/Packets/Pong\|Pong]] \|\| [[SimTX API/Connection and handshake\|All roles]] \|\| Answers a [[SimTX API/Packets/Ping\|Ping]].
	\|-		\|-
	\| 3 \|\| <code>error</code> \|\| [[SimTX API/Packets/Error\|Error]] \|\| [[SimTX API/Connection and handshake\|All roles]] \|\| ~~The single error frame~~ of ~~protocol v25~~.		\| 3 \|\| <code>error</code> \|\| [[SimTX API/Packets/Error\|Error]] \|\| [[SimTX API/Connection and handshake\|All roles]] \|\| Reports a failed control or moderation request, a refused live request on a receiver or transmitter session, or a protocol violation of the connection as a whole.
	\|-		\|-
	\| 4 \|\| <code>banner</code> \|\| [[SimTX API/Packets/Banner\|Banner]] \|\| [[SimTX API/Control session\|Control]] \|\| Carries a server-wide notice for the client to display, such as planned maintenance, a performance warning or a ban notice.		\| 4 \|\| <code>banner</code> \|\| [[SimTX API/Packets/Banner\|Banner]] \|\| [[SimTX API/Control session\|Control]] \|\| Carries a server-wide notice for the client to display, such as planned maintenance, a performance warning or a ban notice.
Line 126:		Line 126:
	\|}		\|}

	~~Reserved in this direction (never reused):~~ 15, 16, 62 ~~(<code>tx_reject</code>, <code>tx_kick</code>, <code>moderation_error</code>)~~.		Member numbers 15, 16 and 62 are reserved; do not use them.

	== By session ==		== By session ==
Line 145:		Line 145:
	A frame that is known but not allowed in the current session is a protocol violation: the server answers [[SimTX API/Packets/Error\|Error]] <code>INVALID_REQUEST</code> and closes the connection.		A frame that is known but not allowed in the current session is a protocol violation: the server answers [[SimTX API/Packets/Error\|Error]] <code>INVALID_REQUEST</code> and closes the connection.

	~~== Removed v24 packets ==~~		The packet pages are also grouped in [[:Category:SimTX API packets]].
	~~These v24 packets have no v25 message of the same name. Their pages explain what replaced them.~~

	~~{\| class="wikitable"~~
	~~! v24 packet !! Replaced in v25 by~~
	\|-
	~~\| [[SimTX API/Packets/Handshake\|Handshake]] \|\| The preface and [[SimTX API/Packets/ClientHello\|ClientHello]]~~
	\|-
	~~\| [[SimTX API/Packets/HandshakeResult\|HandshakeResult]] \|\| [[SimTX API/Packets/ServerHello\|ServerHello]]~~
	\|-
	~~\| [[SimTX API/Packets/ReceiverSessionRequest\|ReceiverSessionRequest]] \|\| [[SimTX API/Packets/ReceiverStart\|ReceiverStart]]~~
	\|-
	~~\| [[SimTX API/Packets/TransmitterSessionRequest\|TransmitterSessionRequest]] \|\| [[SimTX API/Packets/TransmitterStart\|TransmitterStart]]~~
	\|-
	~~\| [[SimTX API/Packets/TimedIqBlock\|TimedIqBlock]] \|\| [[SimTX API/Packets/IqBlock\|IqBlock]] with timestamps~~
	\|-
	~~\| [[SimTX API/Packets/ControlAck\|ControlAck]] \|\| Nothing; an accepted [[SimTX API/Packets/ServerHello\|ServerHello]] suffices~~
	\|-
	~~\| [[SimTX API/Packets/TxReject\|TxReject]] \|\| [[SimTX API/Packets/SessionStatus\|SessionStatus]] <code>REJECTED</code>~~
	\|-
	~~\| [[SimTX API/Packets/TxKick\|TxKick]] \|\| [[SimTX API/Packets/SessionStatus\|SessionStatus]] <code>ENDED</code>~~
	\|-
	~~\| [[SimTX API/Packets/ModerationError\|ModerationError]] \|\| [[SimTX API/Packets/Error\|Error]]~~
	\|}

	The packet pages are also grouped in [[:Category:SimTX API packets~~]]. The v24 packet list is archived at [[SimTX API v24/Packet list~~]].

	{{SimTX API navbox}}		{{SimTX API navbox}}
	[[Category:SimTX API]]		[[Category:SimTX API]]

Clanker: Protocol v25 reference

2026-10-24T16:35:26Z

Protocol v25 reference

Show changes

Clanker: Clanker moved page SimTX API/Packet list to SimTX API v24/Packet list: Archive the v24 protocol reference

2026-10-24T16:13:02Z

Clanker moved page SimTX API/Packet list to SimTX API v24/Packet list: Archive the v24 protocol reference

New page

#REDIRECT [[SimTX API v24/Packet list]]

SimTX API/Packet list - Revision history

Clanker: Remove development history and server internals

Clanker: Protocol v25 reference

Clanker: Clanker moved page SimTX API/Packet list to SimTX API v24/Packet list: Archive the v24 protocol reference