NewNetworkProtocol - Revision history

Orudge: Reformat and update

2011-07-31T12:51:40Z

Reformat and update

← Older revision		Revision as of 12:51, 31 July 2011
Line 1:		Line 1:
	'''''Specifications of the new asynchronous Network Protocol'''''

	Instead having a DirectX based network system, we use a dedicated Server.		Instead having a DirectX based network system, we use a dedicated Server.

Line 25:		Line 23:
	'''Gamestate Packets:'''		'''Gamestate Packets:'''

			{\| \|-
	\|\|'''Type'''\|'''Name'''\|'''Description'''\|'''Following Data'''		!'''Type'''!!'''Name'''!!'''Description'''!!'''Following Data'''

			\|-
	0x01\|Action Data\|The raw action data of ttd follows\| <u8 len> <u8 data*len>		\|0x01\|\|Action Data\|\|The raw action data of ttd follows\|\| <u8 len> <u8 data*len>

			\|-
	0x02\|Action Data End Marker\|Send after all actions of this frame got send\|-\|\|		\|0x02\|\|Action Data End Marker\|\|Send after all actions of this frame got send\|\|-
			\|}

	'''Service Packets:'''		'''Service Packets:'''

			{\| \|-
	\|\|'''Type'''\|'''Name'''\|'''Description'''\|'''Following Data'''		!'''Type'''!!'''Name'''!!'''Description'''!!'''Following Data'''

			\|-
	0x30\|Heartbeat\|Send by the server to a client\| -		\|0x30\|\|Heartbeat\|\|Send by the server to a client\|\| -

			\|-
	0x31\|Heartbeat with rnd request\|with additional requesting a random number\|-		\|0x31\|\|Heartbeat with rnd request\|\|with additional requesting a random number\|\|-

	'''Syncing'''		'''Syncing'''

			\|-
	0x40\|Random gen value\|Answer to packet 0x31\|<u32 random>		\|0x40\|\|Random gen value\|\|Answer to packet 0x31\|\|<u32 random>

			\|-
	0x44\|Get sync package\|Request by the server to get the Gameplay data\|-		\|0x44\|\|Get sync package\|\|Request by the server to get the Gameplay data\|\|-

			\|-
	0x45\|Sync Package\|Gameplay (Savegame) data\|<u32 len> <u8*len of gamedata>		\|0x45\|\|Sync Package\|\|Gameplay (Savegame) data\|\|<u32 len> <u8*len of gamedata>

			\|-
	0x46\|Sync heartbeat\|Only send when a client gets resyced\|-		\|0x46\|\|Sync heartbeat\|\|Only send when a client gets resyced\|\|-

	'''Server Management'''		'''Server Management'''

			\|-
	0x80\|Quit Server\|Quits the server application\|<u8*16 server password>		\|0x80\|\|Quit Server\|\|Quits the server application\|\|<u8*16 server password>

			\|-
	0x81\|KickBan\|Kicks the player x from the server and deny reconnection\|<u8 playerslot> <u8*16 server password>		\|0x81\|\|KickBan\|\|Kicks the player x from the server and deny reconnection\|\|<u8 playerslot> <u8*16 server password>

			\|-
	0x82\|Kick\|Kicks the player x from the server\|<u8 playerslot> <u8*16 server password>		\|0x82\|\|Kick\|\|Kicks the player x from the server\|\|<u8 playerslot> <u8*16 server password>

	'''Client connect'''		'''Client connect'''

			\|-
	0xF0\|Server Password\|Sends the server password to join\|<u8*16 server password for joining>		\|0xF0\|\|Server Password\|\|Sends the server password to join\|\|<u8*16 server password for joining>

			\|-
	0xF1\|Free Slot Messages\|Server shows current slots\|<u32 len of following data> <u8 free slot mask> <u8 password mask> <zero terminated strings follow for all player slots>		\|0xF1\|\|Free Slot Messages\|\|Server shows current slots\|\|<u32 len of following data> <u8 free slot mask> <u8 password mask> <zero terminated strings follow for all player slots>

			\|-
	0xF2\|Set Player Slot\|Client requests a player\|<u8 player slot to use> <16x u8 password> <u8 len of string> <string: Name> <00>		\|0xF2\|\|Set Player Slot\|\|Client requests a player\|\|<u8 player slot to use> <16x u8 password> <u8 len of string> <string: Name> <00>

	Password is filled with zero to match 16 Bytes, all zero means no password.		Password is filled with zero to match 16 Bytes, all zero means no password.

			\|-
	0xF3\|Player Accepted\|If the slot is free and the password is right		\|0xF3\|\|Player Accepted\|\|If the slot is free and the password is right

			\|-
	0xF4\|Player Not Accepted\|If there is an error, slot not free\|<u16 error id>		\|0xF4\|\|Player Not Accepted\|\|If there is an error, slot not free\|\|<u16 error id>

			\|-
	0xF5\|Newgrfmap\|A map of used grfs\|<u32 len of following data> Pairs of <u8*16 md5sum> <string: newgrf filename> <0x00> <string: grf name> <0x00>		\|0xF5\|\|Newgrfmap\|\|A map of used grfs\|\|<u32 len of following data> Pairs of <u8*16 md5sum> <string: newgrf filename> <0x00> <string: grf name> <0x00>

			\|-
	0xFF\|Connect Error\|Sends an error to the client\|<u16 error id>\|\|		\|0xFF\|\|Connect Error\|\|Sends an error to the client\|\|<u16 error id>
			\|}

	==Client connecting to server==		==Client connecting to server==
Line 164:		Line 184:

	0x0000 = means no error		0x0000 = means no error
			[[Category:TTDPatch Development]]

Hgnmu128: Style edits

2011-06-13T23:19:45Z

Style edits

Show changes

Orudge: 4 revisions

2011-06-12T19:09:18Z

4 revisions

← Older revision	Revision as of 19:09, 12 June 2011
(No difference)

eis_os at 18:30, 30 June 2007

2007-06-30T18:30:45Z

@@ Line 10: / Line 10: @@
 Both Server and Client have a framecounter, every action will take place at a certain framenumber.
-A client sends actions to the server, which then decides at what frame the action on a client should take place. (The client doesn't cache the data, so the server has to send the data back.) The server is aswell responsible to initate a client sync and aswell check the random gen number of the clients from time to time, if they are in sync, if not the server initiate a sync.
+A client sends actions to the server, which then decides at what frame the action on a client should take place. (The client doesn't cache the data, so the server has to send the data back.) The server is as well responsible to initiate a client sync and as well check the random gen number of the clients from time to time, if they are in sync, if not the server initiate a sync.
-A client will only advance to the next frame if the server sends a hearbeat packet.
+A client will only advance to the next frame if the server sends a heartbeat packet.
 The heartbeat packet is created every 27ms, at a configurable duration the heartbeat packet with randomgen request is send, a client then has to answer with a random gen number package and the server checks each active client if the random number matches with the other client.
@@ Line 20: / Line 20: @@
 -=Packets=-
-A network packet has a variable lenght and is always in little endian format.
+A network packet has a variable length and is always in little endian format.
 Each package start with:
@@ Line 66: / Line 66: @@
 xF1|Free Slot Messages|Server shows current slots|&lt;u32 len of following data&gt;&lt;u8 free slot mask&gt;&lt;u8 password mask&gt;&lt;zero terminated strings follow for all player slots&gt;
-xF2|Set Player Slot|Client requests a player|&lt;u8 player slot to use&gt;&lt;16x u8 password&gt;
+xF2|Set Player Slot|Client requests a player|&lt;u8 player slot to use&gt;&lt;16x u8 password&gt;&lt;u8 len of string&gt;&lt;string: Name&gt;&lt;00&gt;
 Password is filled with zero to match 16 Bytes, all zero means no password.
@@ Line 77: / Line 77: @@
 xFF|Connect Error|Sends an error to the client|&lt;u16 error id&gt;||

eis_os at 17:39, 30 June 2007

2007-06-30T17:39:26Z

@@ Line 22: / Line 22: @@
 A network packet has a variable lenght and is always in little endian format.
-Each package start with a &lt;u32 framenumber&gt; follwed by a &lt;u8 type&gt;.
+Each package start with:
 ||'''Type'''|'''Name'''|'''Description'''|'''Following Data'''
@@ Line 30: / Line 34: @@
 x02|Action Data End Marker|Send after all actions of this frame got send|-||
-Service Packets:
+'''Service Packets:'''
 ||'''Type'''|'''Name'''|'''Description'''|'''Following Data'''
@@ Line 36: / Line 40: @@
 x30|Heartbeat|Send by the server to a client| -
-x31|Heartbeat with rnd request|with additional requesting a random number|-||
+x31|Heartbeat with rnd request|with additional requesting a random number|-

eis_os at 13:28, 30 June 2007

2007-06-30T13:28:09Z

New page

'''''Specification of the new asynchronous Network Protocol'''''

=New Async Network protocol=

Instead having a DirectX based network system, we use a dedicated Server.

The Server component is only responsible to broadcast messages between the Clients so all TTDPatch Clients work in sync. Unlike traditional TTD, network joining will work while the first player is already in a game, the other players will get synced.

Both Server and Client have a framecounter, every action will take place at a certain framenumber.

A client sends actions to the server, which then decides at what frame the action on a client should take place. (The client doesn't cache the data, so the server has to send the data back.) The server is aswell responsible to initate a client sync and aswell check the random gen number of the clients from time to time, if they are in sync, if not the server initiate a sync.

A client will only advance to the next frame if the server sends a hearbeat packet.

The heartbeat packet is created every 27ms, at a configurable duration the heartbeat packet with randomgen request is send, a client then has to answer with a random gen number package and the server checks each active client if the random number matches with the other client.

Note: The action data for a frame has to arrive directly before the heartbeat package for that frame number.

-=Packets=-

A network packet has a variable lenght and is always in little endian format.

Each package start with a <u32 framenumber> follwed by a <u8 type>.

||'''Type'''|'''Name'''|'''Description'''|'''Following Data'''

0x01|Action Data|The raw action data of ttd follows| <u8 len> <u8 data*len>

0x02|Action Data End Marker|Send after all actions of this frame got send|-||

Service Packets:

||'''Type'''|'''Name'''|'''Description'''|'''Following Data'''

0x30|Heartbeat|Send by the server to a client| -

0x31|Heartbeat with rnd request|with additional requesting a random number|-||