Directory Game Server Protocol - Revision history

BaK: /* Validating the zone name */ the grammer must cannot exist

2007-01-12T14:36:39Z

Validating the zone name: the grammer must cannot exist

← Older revision		Revision as of 14:36, 12 January 2007
Line 35:		Line 35:
	=== Validating the zone name ===		=== Validating the zone name ===
	* Name must be at least one character long.		* Name must be at least one character long.
	* First and last characters must ~~cannot~~ be a space.		* First and last characters must not be a space.
	* No more than one space in a row.		* No more than one space in a row.
	* Only ASCII characters between ‘ ‘ [0x20] and ‘~’ [0x7E], inclusive.		* Only ASCII characters between ‘ ‘ [0x20] and ‘~’ [0x7E], inclusive.

Doc flabby: another correction 8+2 isnt 14 as i have found out :P

2007-01-10T00:11:32Z

another correction 8+2 isnt 14 as i have found out :P

← Older revision		Revision as of 00:11, 10 January 2007
Line 14:		Line 14:
	6 2 player count		6 2 player count
	8 2 saving scores? (boolean)		8 2 saving scores? (boolean)
	12 4 version (set this to 134)		10 4 version (set this to 134)
	14 32 zone name (null terminated)		14 32 zone name (null terminated)
	46 16 password (null terminated)		46 16 password (null terminated)

Doc flabby: 62 + 32 is 94 and not 92 as i have just found out

2007-01-10T00:08:43Z

62 + 32 is 94 and not 92 as i have just found out

← Older revision		Revision as of 00:08, 10 January 2007
Line 18:		Line 18:
	46 16 password (null terminated)		46 16 password (null terminated)
	62 32 reserved (suggested to set this to 0)		62 32 reserved (suggested to set this to 0)
	92 ? description (must be null terminated)		94 ? description (must be null terminated)
	</pre>		</pre>

Cyan~Fire: game server's what?

2006-10-07T15:21:03Z

game server's what?

← Older revision		Revision as of 15:21, 7 October 2006
Line 1:		Line 1:
	== Introduction ==		== Introduction ==
	[[Zone\|Game ~~Server's~~]] such as [[subgame2]] and [[ASSS]] register their prescence on [[Directory server\|Directory Servers]]. This page describes the portion of the '''directory server protocol''' that game servers use.		[[Zone\|Game Servers]] such as [[subgame2]] and [[ASSS]] register their prescence on [[Directory server\|Directory Servers]]. This page describes the portion of the '''directory server protocol''' that game servers use.

	This system uses UDP packets, most commonly over port 4991. Maximum length of the packet is only limited to the directory server software itself, so it varies from each application. The specific lengths of most fields are static, with the zone description field being the only value that varies its length.		This system uses UDP packets, most commonly over port 4991. Maximum length of the packet is only limited to the directory server software itself, so it varies from each application. The specific lengths of most fields are static, with the zone description field being the only value that varies its length.

Smong: added note about # and , in zone names

2006-10-07T09:34:10Z

added note about # and , in zone names

← Older revision		Revision as of 09:34, 7 October 2006
Line 38:		Line 38:
	* No more than one space in a row.		* No more than one space in a row.
	* Only ASCII characters between ‘ ‘ [0x20] and ‘~’ [0x7E], inclusive.		* Only ASCII characters between ‘ ‘ [0x20] and ‘~’ [0x7E], inclusive.

			== Notes on zone.dat ==
			Due to the format of zone.dat used to store your favourite zones, zone names should not begin with '#' [0x23] or contain any ',' [0x2C].

	== See also ==		== See also ==

Mine GO BOOM: Changed around a lot of wording throughout the document to be more easiler read.

2006-09-28T19:54:49Z

Changed around a lot of wording throughout the document to be more easiler read.

← Older revision		Revision as of 19:54, 28 September 2006
Line 2:		Line 2:
	[[Zone\|Game Server's]] such as [[subgame2]] and [[ASSS]] register their prescence on [[Directory server\|Directory Servers]]. This page describes the portion of the '''directory server protocol''' that game servers use.		[[Zone\|Game Server's]] such as [[subgame2]] and [[ASSS]] register their prescence on [[Directory server\|Directory Servers]]. This page describes the portion of the '''directory server protocol''' that game servers use.

	This system ~~relies on the~~ UDP ~~protocol~~, port 4991. ~~Max~~ length of the packet is only limited to the directory server software itself (so it varies from each application). ~~However, the~~ specific lengths of fields are ~~pretty much final~~, the zone description ~~should be~~ the only ~~length~~ that varies.		This system uses UDP packets, most commonly over port 4991. Maximum length of the packet is only limited to the directory server software itself, so it varies from each application. The specific lengths of most fields are static, with the zone description field being the only value that varies its length.

	== Protocol ==		== Protocol ==
Line 21:		Line 21:
	</pre>		</pre>

	~~== 32 byte reserved field (speculation) ==~~		== Notes on Priit's dirserv ==
	~~[[User:CypherJF\|CypherJF]] has confirmed garbage in this field does not affect the directory server writen by [[PriitK]].~~		Descriptions are recorded to the stats file with a max length of 490 bytes. The reserved field can be filled with any random data, as the directory server ignores this field completely.

	However as of [[Catid\|Catids]] Distributed Directory Server build 4, these 32 bytes must be zeroed. Catid has also stated that this field should be zeroed in a converstation with [[User:CypherJF\|CypherJF]].

	~~It is possible this field was intended for future protocol expansion by VIE.~~

	== Notes on ~~PriitK~~'s dirserv ==
	Descriptions are recorded to the stats file with a max length of 490 bytes.

	== Notes on Catid's dirserv ==		== Notes on Catid's dirserv ==
	~~The following are restrictions were found in Catid's directory server by CypherJF.~~

	=== Validating the packet ===		=== Validating the packet ===
	* The length of the packet must be greater than 95/0×5F bytes. Basically this means the description can be blank but must be null terminated.		* The length of the packet must be greater than 95/0×5F bytes. Basically this means the description can be blank but must be null terminated.
	* The first 4 bytes (the IP field) must be zeroed.		* The first 4 bytes (the IP field) must be zeroed.
			* The reserved field must be zeroed.
	* The name, password and description must be null terminated.		* The name, password and description must be null terminated.
	* The "save scores" field must be either 0 or 1.		* The "save scores" field must be either 0 or 1.

	=== Validating the zone name ===		=== Validating the zone name ===
	* ~~len(name) > 0~~.		* Name must be at least one character long.
	* ~~No leading spaces~~.		* First and last characters must cannot be a space.
	* No more than 1 space in a row.		* No more than one space in a row.
	* ~~Any character~~ between ‘ ‘ and ‘~’.		* Only ASCII characters between ‘ ‘ [0x20] and ‘~’ [0x7E], inclusive.
	* No trailing spaces.

	== See also ==		== See also ==
	* [http://cypherjf.sscentral.com/articles/game-server-to-directory-server/ CypherJF's original document]		* [http://cypherjf.sscentral.com/articles/game-server-to-directory-server/ CypherJF's original document]
	* [http://web.archive.org/web/*/http://www4.ncsu.edu/~rniyenga/subspace/old/dprotocol.html Hammuravi's page]		* [http://web.archive.org/web/*/http://www4.ncsu.edu/~rniyenga/subspace/old/dprotocol.html Hammuravi's page]
	* ASSS ~~Project~~: src/directory.c		* [http://asss.yi.org/asss/ ASSS Source]: src/directory.c
	* [[Directory Client Protocol]]		* [[Directory Client Protocol]]

	[[Category: Protocol]]		[[Category: Protocol]]

Smong: major overhaul (someone want to add the bit about subgame using the ping packets every 4min or something? i forgot the specifics)

2006-09-28T18:09:53Z

major overhaul (someone want to add the bit about subgame using the ping packets every 4min or something? i forgot the specifics)

← Older revision		Revision as of 18:09, 28 September 2006
Line 1:		Line 1:
	~~ABSTRACT:~~ This ~~document will explain~~ the ~~details needed to send zone data to~~ the directory server.		== Introduction ==
			[[Zone\|Game Server's]] such as [[subgame2]] and [[ASSS]] register their prescence on [[Directory server\|Directory Servers]]. This page describes the portion of the '''directory server protocol''' that game servers use.

	~~Some background information, this~~ system relies on the UDP protocol, port 4991. Max length of the packet is only limited to the directory server software itself (so it varies from each application). However, the specific lengths of fields are pretty much final, the zone description should be the only length that varies~~. The following is based off examination of the open-source Directory Server by Catid; and discussions with him about this topic~~.		This system relies on the UDP protocol, port 4991. Max length of the packet is only limited to the directory server software itself (so it varies from each application). However, the specific lengths of fields are pretty much final, the zone description should be the only length that varies.

	~~Offset Length Description~~		== Protocol ==
	~~===============~~====~~================~~		<pre>
	~~0×00 [ 0] 4 IP address. (Must be NULL: 00 00 00 00)~~		g2d
	~~0×04 [ 4] 2 Server Port~~
	~~0×06 [ 6] 2 Population~~
	~~0×08 [ 8] 2 Scoring? (0×00 - no; 0×01 - yes)~~
	~~0×0A [ 10] 4 Version (134)~~
	~~0×0E [ 14] 32 Zone Name (31 characters, null-terminated.) Must also be a valid name.~~
	~~0×2E [ 46] 16 Zone Password (15 characters, null-terminated.)~~
	~~0×3E [ 62] 32 Unknown NULL field. (*** see discussion)~~
	~~0×5E [ 94] VARIES Zone Description (varied length, null-terminated.)~~

	* Offsets are given in HEX [ DEC].		register game server
			offset size comment
			0 4 ip (leave this set to 0?)
			4 2 port
			6 2 player count
			8 2 saving scores? (boolean)
			12 4 version (set this to 134)
			14 32 zone name (null terminated)
			46 16 password (null terminated)
			62 32 reserved (suggested to set this to 0)
			92 ? description (must be null terminated)
			</pre>

	- 32 byte ~~NULL~~ field ~~Discussion -~~		== 32 byte reserved field (speculation) ==
	~~I was surprised to see~~ this ~~in the validation function of Catid’s directory server. After some discussion with him, he assures me there is a 32 length NULL~~ field~~. As of Catids Distributed Directory Server build 4, these 32 bytes MUST BE NULL. It is enforced. However, after some testing done by 2dragons - having non-null bytes in this section~~ does not affect the directory server writen by PriitK~~. Later thoughts were that VIE may have planned on adding more fields into the directory server protocol; but never got around to it~~.		[[User:CypherJF\|CypherJF]] has confirmed garbage in this field does not affect the directory server writen by [[PriitK]].

	~~- Further Discussion -~~		However as of [[Catid\|Catids]] Distributed Directory Server build 4, these 32 bytes must be zeroed. Catid has also stated that this field should be zeroed in a converstation with [[User:CypherJF\|CypherJF]].
	~~PriitK’s directory server records descriptions to the stats file with a max length~~ of ~~490~~ bytes.

	~~- Validation -~~		It is possible this field was intended for future protocol expansion by VIE.
	~~The following are conditions that I took apart from Catid’s validating function as well~~.

	~~The~~ length of ~~the packet must be greater than 0×5F~~		== Notes on PriitK's dirserv ==
	~~The first 4~~ bytes ~~must be null, or zero~~.		Descriptions are recorded to the stats file with a max length of 490 bytes.
	~~The last byte of the packet must be NULL (0×00)~~
	~~The byte[0×2D] must be 0×00~~
	~~The byte[0×3D] must be 0×00~~
	~~The byte[0×08] must be either 0×00, or 0×01~~
	~~The byte[0×3E] to byte[0×5D]~~

	~~* Validating Name *~~		== Notes on Catid's dirserv ==
	~~There~~ are ~~also conditions on what determines a validName, etc. This part may or may not be correct. I just threw it~~ in ~~here quickly~~.		The following are restrictions were found in Catid's directory server by CypherJF.

	~~Catids Directory Server says:~~		=== Validating the packet ===
	~~validName would~~ be:		* The length of the packet must be greater than 95/0×5F bytes. Basically this means the description can be blank but must be null terminated.
	len(name) > 0		* The first 4 bytes (the IP field) must be zeroed.
	no leading spaces		* The name, password and description must be null terminated.
	no more than 1 space in a row		* The "save scores" field must be either 0 or 1.
	Any character between ‘ ‘ and ‘~’
	No trailing spaces		=== Validating the zone name ===
			* len(name) > 0.
			* No leading spaces.
			* No more than 1 space in a row.
			* Any character between ‘ ‘ and ‘~’.
			* No trailing spaces.

			== See also ==
			* [http://cypherjf.sscentral.com/articles/game-server-to-directory-server/ CypherJF's original document]
			* [http://web.archive.org/web/*/http://www4.ncsu.edu/~rniyenga/subspace/old/dprotocol.html Hammuravi's page]
			* ASSS Project: src/directory.c
			* [[Directory Client Protocol]]

			[[Category: Protocol]]

BaK: content from cypher's page

2006-09-28T11:00:26Z

content from cypher's page

New page

ABSTRACT: This document will explain the details needed to send zone data to the directory server.

Some background information, this system relies on the UDP protocol, port 4991. Max length of the packet is only limited to the directory server software itself (so it varies from each application). However, the specific lengths of fields are pretty much final, the zone description should be the only length that varies. The following is based off examination of the open-source Directory Server by Catid; and discussions with him about this topic.

Offset Length Description
===================================
0×00 [ 0] 4 IP address. (Must be NULL: 00 00 00 00)
0×04 [ 4] 2 Server Port
0×06 [ 6] 2 Population
0×08 [ 8] 2 Scoring? (0×00 - no; 0×01 - yes)
0×0A [ 10] 4 Version (134)
0×0E [ 14] 32 Zone Name (31 characters, null-terminated.) Must also be a valid name.
0×2E [ 46] 16 Zone Password (15 characters, null-terminated.)
0×3E [ 62] 32 Unknown NULL field. (*** see discussion)
0×5E [ 94] VARIES Zone Description (varied length, null-terminated.)

* Offsets are given in HEX [ DEC].

- 32 byte NULL field Discussion -
I was surprised to see this in the validation function of Catid’s directory server. After some discussion with him, he assures me there is a 32 length NULL field. As of Catids Distributed Directory Server build 4, these 32 bytes MUST BE NULL. It is enforced. However, after some testing done by 2dragons - having non-null bytes in this section does not affect the directory server writen by PriitK. Later thoughts were that VIE may have planned on adding more fields into the directory server protocol; but never got around to it.

- Further Discussion -
PriitK’s directory server records descriptions to the stats file with a max length of 490 bytes.

- Validation -
The following are conditions that I took apart from Catid’s validating function as well.

The length of the packet must be greater than 0×5F
The first 4 bytes must be null, or zero.
The last byte of the packet must be NULL (0×00)
The byte[0×2D] must be 0×00
The byte[0×3D] must be 0×00
The byte[0×08] must be either 0×00, or 0×01
The byte[0×3E] to byte[0×5D]

*** Validating Name ***
There are also conditions on what determines a validName, etc. This part may or may not be correct. I just threw it in here quickly.

Catids Directory Server says:
validName would be:
len(name) > 0
no leading spaces
no more than 1 space in a row
Any character between ‘ ‘ and ‘~’
No trailing spaces