Update protocol

stepmania/Docs/SMLanProtocol.txt

@@ -1,7 +1,7 @@
 
 PRELIMINARY - - - - - - - - 05/03/2004
 Protocol version 4  
-  But 0x04 will be its version for inter-prtocol purposes.
+  But 0x04 will be its version for inter-protocol purposes.
 
 This protocol is only intended to replace current protocol.  Because current protocol
 not expanable
@@ -39,14 +39,14 @@ Note: Primary player is 0x0, secondary player is 0x1
 CLIENT to SERVER protocol:
 
 000:	No Operation
- Desc:		This command will cause server to respond with a no op responce.
+ Desc:		This command will cause server to respond with a no op response.
  Payload:	None
- Responce:	Server 001
+ Response:	Server 001
  
-001:	No Operation Responce
+001:	No Operation Response
  Desc:		This command is used to respond to a no operation.
  Payload:	None
- Responce:	None
+ Response:	None
 
 002:	Hello
  Desc:		This is the first packet from a client to server, stating below 
@@ -55,7 +55,7 @@ CLIENT to SERVER protocol:
     Size	Description:
     1		Client protocol version
     NT		Name of build of StepMania
- Responce:	Server 002
+ Response:	Server 002
 
 
 
@@ -78,13 +78,13 @@ CLIENT to SERVER protocol:
     NT		Primary Player's options (Null if non-existant)
     NT		Secondary Player's Options (Null if non-existant)
     
- Responce: 	Server 003
+ Response: 	Server 003
 
 
 004:	Game Over Notice
  Desc:		This command is sent when end of game is encounterd
  Payload:	None.
- Responce:	None.
+ Response:	None.
 
 005:	Game Status update
  Desc:		Updates game info for each step
@@ -125,7 +125,7 @@ Protocol >= 3
 			It if the user is exactly 0.25 seconds off, the
 			number will be different by 500, if 0.5, it will be
 			different by 1000.
- Responce:	None.
+ Response:	None.
 
 006: Style Update    (PLEASE NOTE THIS HAS NOTHING TO DO WITH SERVER COMMAND 6)
  Desc:		This is sent when a style is chosen.  
@@ -135,7 +135,7 @@ Protocol >= 3
     NT		Player Name for #
    (Additional player's and #'s) (enabled players ONLY)
 
- Responce:	None
+ Response:	None
 
 007:	Chat message
  Desc:		The user typed a message for general chat.
@@ -146,8 +146,8 @@ Protocol >= 3
  Desc:		The user selected a song on a Net-enabled selection
  Size:
     1		Usage of message
-		0: (in responce to server 8) User has specified song
-		1: (in responce to server 8) User does NOT have specified song
+		0: (in response to server 8) User has specified song
+		1: (in response to server 8) User does NOT have specified song
 		2: User requested a start game on given song
     NT		Song Title    (As gotten by GetTranslitMainTitle)
     NT		Song Artist   (As Gotten by GetTranslitArtist)
@@ -188,20 +188,20 @@ Protocol >= 3
 
 SERVER to CLIENT protocol: (begins at 128)
 
-NOTE: Server responces always add 128, thus a server responce for no operation
+NOTE: Server responses always add 128, thus a server response for no operation
 	is 128, not 000
 
 000(128):No Operation 
- Desc:		This command will cause server to respond with a no op responce.
+ Desc:		This command will cause server to respond with a no op response.
  Payload:	None
- Responce:	Server 001
+ Response:	Server 001
 
-001(129):No Operation Responce
+001(129):No Operation Response
  Desc:		This command is used to respond to a no operation.
  Payload:	None
- Responce:	None
+ Response:	None
 
-002(130):Server Hello Responce
+002(130):Server Hello Response
  Desc:		This introduces the server.
  Payload:
     Size	Description
@@ -213,10 +213,10 @@ NOTE: Server responces always add 128, thus a server responce for no operation
 003(131):Allow Start
  Desc:		This will cause the client to start the game.
  Payload:	None
- Responce:	None
+ Response:	None
 
 004(132):Game over stats
- Desc:		this packet is send in responce to the game over packet
+ Desc:		this packet is send in response to the game over packet
 		it contains information regarding how well each player did.
  Payload:
     1		# of players sent in this packet (active players)
@@ -231,6 +231,8 @@ NOTE: Server responces always add 128, thus a server responce for no operation
 	<Other player's Grades>
     1		Difficulty (0=beginner, 1=light, etc.)
 	<Other player's difficulties>
+
+	#this next chunk of step types is actually reversed
     2           miss
 	<Other player's misses>
     2		boo		
@@ -239,6 +241,7 @@ NOTE: Server responces always add 128, thus a server responce for no operation
     2		great (All players)
     2		perfect (All players)
     2		marvelous (All players)
+    
     2		ok (All players)
     2		max_combo (All players)
     NT		Player's options
@@ -256,10 +259,10 @@ NOTE: Server responces always add 128, thus a server responce for no operation
     1		# of players to display
 
 	If Names, then:
-    1		Player in first place's ID
-    1		Player in second place's ID
+    1		Player in first place's index
+    1		Player in second place's index
     ...
-    1		Last player's ID
+    1		Last player's index
 	If Combos, then:
     2		First player's combo
     2		Second Player's combo
@@ -386,11 +389,11 @@ Client SMOnline packets:
 
 
 Server SMOnline packets:
-000:  Login Responce
+000:  Login Response
     1		Approval Status
 		0: Approved
 		1: Approval Failed
-    NT		Login responce (plain text)
+    NT		Login response (plain text)
 
 001:  Room Update (Changing rooms)
  Size:
@@ -420,11 +423,11 @@ Server SMOnline packets:
 
     Room Status appended for reverse compatibility
     1		Room1 Status
-	0: Normal Room
-	1: Unused
-	2: Room in game
-	3: First stage of song selection has been done
-	4: Second stage of song selection has been done
+		0: Normal Room
+		1: Unused
+		2: Room in game
+		3: First stage of song selection has been done
+		4: Second stage of song selection has been done
     1		Room2 Status
 	...
     1		RoomN Status