NetAcquire Protocol (preliminary)

Protocol v2.0.2

General Syntax

The NetAcquire protocol is actually a rather simple protocol. Data is exchanged in plain ASCII, making it easy to both decode and to implement. Both incoming and outgoing data have the same format: <CC>;<content>;: CC is a 1 or 2 character identifier, and content is the actual message content enclosed between semicolons. Finally, the entire command is terminated by a colon character.

Converting from number-letter pairs to integer index: #,l: i = (# - 1) * 9 + ((int)l - (int)'A' + 1) Converting from integer to number-letter pairs # = (int)(i / 9) + 1 l = (i % 9 - 1 + (int)'A')

Commands

PL command - player's name,comma delimited version
BM command - target,double-quoted message
BM command - GameRoom,double-quoted message - Game message
BM command - Lobby,double-quoted message
LU command - empty, server will respond with a LM command
LG command - empty, server will respond with a LM command
- LM;"# Active games: 0 ...";:LM;"# End of game list.";:
JG command - game number,-1 - Join Game
PI command - ##:##:## ?M - some form of a time
GS command - empty - Game Status
- GM;"> ========";:
  GM;"> == Game Status Display";:
  GM;"> == Users: 3 players, no spectators";:
  GM;"> == Remaining tiles in bag: 105";:
  GM;"> == Status: Waiting for 1-900-funny-things-about-sung to start game play.";:
  GM;"> == End Of Display";:
  GM;"> ========";:
PT command - # - Pick Tile?

Messages

SP message - <comma delimited version>,<server's name>
LM message - <double-quoted message to display in player's lobby window>
- LM;"*<player> has started new game #1.";:
- LM;"*Stefan has joined game #1.";:
- LM;"*matthew has entered the lobby.";:
SS message - <state number?> - Set State? Sent as part of login process
M message - <double-quoted message to display in a dialog box?> - Messagebox message
- M;"W;Test mode turned on.;The game host has enabled test mode. All subsequent game tiles will not be random. Instead, they will be entered manually by the game host.";:
- M;"W;Test mode turned off.;The game host has disabled test mode. All subsequent game tiles are randomly drawn.";:
M message - "E;<message to display in a dialog box>" - Messagebox message
GM message - <double-quoted message to display in player's game message window>
- GM;"*Stefan(68.82.110.17/port 3034) has entered the game room.";:
- GM;"*Stefan has joined the game.";:
- GM;"*Stefan drew position tile 8F.";:
- GM;"-> <user>: turned on test mode";:
SB message - i,0 - takes a square from the bag
SV message - frmScoreSheet,lblData,<index on score table?>,Caption,<user>
- SV;frmScoreSheet,lblData,2,Caption,Stefan;:
- SV;frmScoreSheet,lblData,4,Caption,MUSnapOn;:
- SV;frmScoreSheet,lblData,5,Caption,DanYan;:
Seems to be triggered when a new user joins, re-orders users on the list.
PM message - <time>,<player (serverp layer only?)>

Transcript Snippets


			ScoreSheet,lblData,83,Caption,6000;:
			SV;frmScoreSheet,lblData,35,Caption,;:
			SV;frmScoreSheet,lblData,9,Caption,25;:
			SV;frmScoreSheet,lblData,42,Caption,;:
			SV;frmScoreSheet,lblData,10,Caption,25;:
			SV;frmScoreSheet,lblData,49,Caption,;:
			SV;frmScoreSheet,lblData,11,Caption,25;:
			SV;frmScoreSheet,lblData,56,Caption,;:
			SV;frmScoreSheet,lblData,12,Caption,25;:
			SV;frmScoreSheet,lblData,63,Caption,;:
			SV;frmScoreSheet,lblData,13,Caption,25;:
			SV;frmScoreSheet,lblData,70,Caption,;:
			SV;frmScoreSheet,lblData,14,Caption,25;:
			SV;frmScoreSheet,lblData,77,Caption,;:
			SV;frmScoreSheet,lblData,15,Caption,25;:
			SV;frmScoreSheet,lblData,84,Caption,6000;:
			SV;frmScoreSheet,lblData,36,Caption,;:
			SV;frmScoreSheet,lblData,9,Caption,25;:
			SV;frmScoreSheet,lblData,43,Caption,;:
			SV;frmScoreSheet,lblData,10,Caption,25;:
			SV;frmScoreSheet,lblData,50,Caption,;:
			SV;frmScoreSheet,lblData,11,Caption,25;:
			SV;frmScoreSheet,lblData,57,Caption,;:
			SV;frmScoreSheet,lblData,12,Caption,25;:
			SV;frmScoreSheet,lblData,64,Caption,;:
			SV;frmScoreSheet,lblData,13,Caption,25;:
			SV;frmScoreSheet,lblData,71,Caption,;:
			SV;frmScoreSheet,lblData,14,Caption,25;:
			SV;frmScoreSheet,lblData,78,Caption,;:
			SV;frmScoreSheet,lblData,15,Caption,25;:
			SV;frmScoreSheet,lblData,85,Caption,6000;:
			SV;frmNetAcquire,status,-1,SimpleText,"The game has been started, please wait for your turn.";:
			SV;frmScoreSheet,lblData,1,BackColor,12632319;:
			GM;"*********DanYan's turn.";:
			GM;"*Waiting for DanYan to play tile.";:
			GT;;:

Responded with


			PT;3;:


			GM;"*DanYan played 12C.";:
			SB;102,0;:
			AT;1,103,16777215;:
			GM;"> You drew tile 12I.";:
			AT;5,107,12648384;:
			AT;3,108,12648384;:
			SV;frmNetAcquire,status,-1,SimpleText,"Your turn has ended, drawn tile shown on tile rack.";:
			SV;frmScoreSheet,lblData,1,BackColor,16777215;:
			SV;frmScoreSheet,lblData,2,BackColor,12632319;:
			GM;"*********Stefan's turn.";:
			GM;"*Waiting for Stefan to play tile.";:


			GM;"*Stefan played 9G.";:
			SB;79,0;:
			SV;frmScoreSheet,lblData,2,BackColor,16777215;:
			SV;frmScoreSheet,lblData,3,BackColor,12632319;:
			GM;"*********MUSnapOn's turn.";:
			GM;"*Waiting for MUSnapOn to play tile.";:


			GM;"*MUSnapOn played 8E.";:
			SB;68,0;:
			SV;frmScoreSheet,lblData,3,BackColor,16777215;:
			SV;frmScoreSheet,lblData,4,BackColor,12632319;:
			GM;"*********1-900-funny-things-about-sung's turn.";:
			GM;"*Waiting for 1-900-funny-things-about-sung to play tile.";:


			GM;"*1-900-funny-things-about-sung played 7H.";:
			SB;62,0;:
			GM;"*Played tile forms new chain.";:
			AT;4,61,16777215;:
			GM;"*Waiting for 1-900-funny-things-about-sung to select new chain.";:


			GM;"****1-900-funny-things-about-sung formed Imperial.";:
			SB;62,16711935;:
			SV;frmScoreSheet,lblData,23,Caption,1;:
			SV;frmScoreSheet,lblData,31,Caption,3;:
			SB;71,16711935;:
			SV;frmScoreSheet,lblData,23,Caption,2;:
			SV;frmScoreSheet,lblData,31,Caption,4;:
			SV;frmScoreSheet,lblData,78,Caption,1;:
			SV;frmScoreSheet,lblData,15,Caption,24;:
			AT;4,61,16711935;:
			GM;"*Waiting for 1-900-funny-things-about-sung to make purchase.";:


			SV;frmScoreSheet,lblData,85,Caption,4800;:
			SV;frmScoreSheet,lblData,78,Caption,4;:
			SV;frmScoreSheet,lblData,15,Caption,21;:
			GM;"*1-900-funny-things-about-sung purchased 3-Imperial.";:
			SV;frmScoreSheet,lblData,4,BackColor,16777215;:
			SV;frmScoreSheet,lblData,1,BackColor,12632319;:
			GM;"*********DanYan's turn.";:
			GM;"*Waiting for DanYan to play tile.";:
			GT;;:

Responded with:


			PT;1;:


			GM;"*DanYan played 12D.";:
			SB;103,0;:
			GM;"*Played tile forms new chain.";:
			GM;"*Waiting for DanYan to select new chain.";:
			GC;4,1,2,3,4,5,6;:

Responded with: