Worked out networking
[progcomp2012.git] / web / doc / manager_manual.txt
1 NAME
2         stratego - Interface to manage games of stratego between AI programs and/or human players
3         
4 WARNING
5         This program is still a work in progress. Consider it a Beta version.
6
7 SYNOPSIS
8         stratego {[-gpirb] [-o output_file ] [-t stall_time] [-T timeout_time] [-m max_turns] {red_player blue_player | -f input_file} | {-h | --help} }
9
10 DESCRIPTION
11         stratego manages a game of Stratego. It stores the state of the board, and uses a simple protocol to interface with AI programs.
12         By itself, stratego does not "play" the game. An external AI program must be used. stratego is intended to be used for the testing of 
13         various AI strategies, written in any programming language. It will be used for the UCC Programming Competition 2012.
14
15         Unless the -h (--help) or -f switch is given, both red_player and blue_player must be supplied.
16
17         red_player
18                 Should be either a path to an executable file which will control the Red player, or "human".
19                 If set to "human", stratego will request the user to make moves for the Red player using stdin.
20                 NOTES
21                         1. There is no plan to support AI programs named "human". Deal with it.
22                         2. The graphical interface for human players is... basic. Deal with it.
23         blue_player
24                 As red_player, except for controlling the Blue player.
25
26 A WARNING ABOUT BUFFERING
27         The AI programs must unbuffer their stdin and stdout streams, otherwise it will be seen to be non-responsive.
28         If you C and you know a way to force the process started by exec() to have unbuffered stdin/stdout, please email the author.
29
30         In C or C++, unbuffering is accomplished with the following lines, which should appear near the start of main()
31                 setbuf(stdin, NULL);
32                 setbuf(stdout, NULL);
33         In python, unbuffering is accomplished by passing the -u switch to the interpreter, ie: The first line of a script reads:
34                 #!/usr/bin/python -u
35         
36         
37 OPTIONS
38         -g
39                 NOTE: This switch only functions if stratego is built with graphics enabled. See BUILDING for more information.
40
41                 By default, graphics are disabled. If the -g switch is present, stratego will draw the game as it is played using SDL/OpenGL
42                 
43         -p
44                 By default, even if graphics are disabled, the board state is not printed. If -p is present, the board will be printed to stdout.
45                 If the system supports colour, the characters will be in colour.
46                 Yes, If -p and -g are both present you will see both behaviours (overkill)!
47         -i
48                 By default, stratego will exit if a move which is deemed "illegal" is made. If the -i switch is present, illegal moves will be ignored.
49                 That is, the move will not be made (effectively the player making the illegal move loses a turn).
50
51                 NOTE: If -i is not given and a human player accidentally(?) makes an illegal move, they will be asked to make a different move. The game will continue.
52                 This is intended to prevent fits of rage due to the horrible graphical interface causing humans to make illegal moves.
53         -r
54                 By default, the identities of all pieces are shown. If the -r switch is present, and graphics are enabled, red pieces will be disguised.
55                 If graphics are disabled, the -r switch has no effect.
56
57                 Pieces which have previously taken part in combat (and survived) will be revealed.
58         -b
59                 As -r, except blue pieces will be disguised.
60                 NOTE: Both -r and -b may be used together.
61         -o
62                 By default, stratego does not log moves. If the -o switch is present, the result of each move is printed to a file. 
63                 If output_file is "stdout" then stdout will be used instead of a text file.
64         -t
65                 By default, stratego executes moves as fast as they are recieved. If the -t switch is present, a delay of stall_time will be introduced
66                 between each move.
67                 
68                 If stall_time is negative or "inf", stratego will wait for the user to press enter before moving to the next move.
69                 
70                 It is tentatively planned to allow the user to enter various commands to alter the game or proceed to specified turns.
71                 However this is slightly complicated. So it might never be done.
72
73         -T
74                 By default, stratego allows AI programs 2 seconds to respond before declaring their move ILLEGAL due to a timeout.
75                 If the -T switch is present, AI programs will be allowed timeout_time to respond before their move is declared ILLEGAL.
76
77                 If timeout_time is negative or "inf", stratego will never declare moves illegal due to timeouts.
78         
79                 Human players are never subject to timeouts.
80                 
81         -m
82                 By default, the game is declared a Draw after 5000 turns have ellapsed.
83                 Use this option to change the maximum number of turns.
84                 To play for an infinite number of turns, supply "inf" as max_number. This is not recommended for obvious reasons.
85
86         -f
87                 By default, stratego requires red_player and blue_player to enact a game.
88                 If this option is supplied, a file previously produced by using the -o switch is read, and the game reenacted.
89                 All switches function as normal with -f.
90                 NOTE: It is recommended that -g is used with -f.
91
92         -h, --help
93                 If the -h switch is used, this page will be printed and stratego will exit.
94                 
95                 
96
97 GAME RULES
98                 Each player controls up to 40 pieces on the Board. The pieces are represented by the following characters:
99
100                 Piece   Name            Rank    Number  Abilities
101                 1       Marshal         1       1       Dies if attacked by Spy
102                 2       General         2       1       
103                 3       Colonel         3       2       
104                 4       Major           4       3       
105                 5       Captain         5       4       
106                 6       Lieutenant      6       4
107                 7       Sergeant        7       4
108                 8       Miner           8       5       Destroys Bombs
109                 9       Scout           9       8       May move more through multiple empty squares
110                 s       Spy             10      1       If the Spy attacks the Marshal, the Marshal dies
111                 B       Bomb            NA      6       Immobile. If any piece (except a Miner) attacks an enemy Bomb, that piece is destroyed.
112                 F       Flag            NA      1       Immobile. If any piece attacks the enemy Flag, the controlling player wins.
113
114                 Additional pieces, not controlled by the player:
115                 Piece   Name                    Number  Notes
116                 +       Obstacle                8       Immobile. Do not belong to either player. Can't be passed through.
117                 #       Enemy Piece             0 - 40  Indicates that the position on the board is occupied by an enemy piece.
118                 .       Empty                   NA      Indicates that the position on the board is empty.
119                 
120                 Players take turns to move their pieces. RED begins the game.
121
122                 Pieces may only move one square horizontally or vertically unless otherwise stated.
123                 Pieces may not move through squares occupied by allied pieces, or Obstacle (+) pieces.
124                 Pieces may move into squares occupied by Enemy Pieces (#), in which case the piece with the lower rank (higher number) is destroyed.
125
126                 Each player's pieces are hidden from the other player. When two pieces encounter each other, the ranks will be revealed.
127
128                 The objective is to either destroy all enemy pieces except the Bombs and Flag, or to capture the Flag.
129
130                 Since 20/12 Bombs reflect the traditional rules; they are only destroyed by Miners.
131                 In previous versions contact of an attacker other than a Miner with a Bomb destroyed the Bomb as well as the attacking piece.
132                 
133                 
134
135 PROTOCOL
136         In order to interface with stratego, an AI program must satisfy the following protocol. 
137         Each query is followed by a newline, and responses are expected to be followed with a newline.
138         The queries are recieved through stdin, and responses should be written to stdout.
139         
140         1. SETUP
141                 QUERY: YOUR_COLOUR OPPONENT_ID BOARD_WIDTH BOARD_HEIGHT
142
143                 RESPONSE: 4 lines, each of length BOARD_WIDTH, of characters. Each character represents a piece. The characters are shown above.
144
145                 RED's pieces are placed at the top of the board, and BLUE's pieces are placed at the bottom.
146
147                 An AI program does not have to place all 40 pieces, but must at least place the flag ('F').
148
149         2. TURN
150                 QUERY:  START | CONFIRMATION
151                         BOARD_STATE
152
153                         On the first turn, "START" is printed to the Red player.
154                         On subsequent turns, the CONFIRMATION of the opponent's last turn is printed (see below).
155
156                         BOARD_STATE consists of a BOARD_HEIGHT lines of length BOARD_WIDTH characters, each of which represents a single piece
157                         as described in the GAME_RULES section. Each line ends with the newline character.
158                         
159
160                 RESPONSE: X Y DIRECTION [MULTIPLIER=1] 
161                         X and Y are the coords (starting from 0) of the piece to move
162                         DIRECTION is either UP, DOWN, LEFT or RIGHT
163                         MULTIPLIER is optional and only valid for units of type Scout. Scouts may move through any number of unblocked squares
164                         in one direction.
165
166
167                 CONFIRMATION: X Y DIRECTION [MULTIPLIER=1] OUTCOME | QUIT [RESULT]
168
169                         OUTCOME may be either OK, ILLEGAL, KILLS or DIES
170                                 OK - Move was successful
171                                 ILLEGAL - Move was not allowed. If stratego was not started with the -i switch, the game will end.
172                                 KILLS ATTACKER_RANK DEFENDER_RANK - The piece moved into an occupied square and killed the defender.
173                                 DIES ATTACKER_RANK DEFENDER_RANK - The piece moved into an occupied square and was killed by the defender.
174
175                         QUIT will only be sent when the game is about to end.
176         3. END GAME
177                 If the CONFIRMATION line is of the form:
178                         QUIT [RESULT]
179                 Then the game is about to end.
180         
181                 If present, RESULT will be a direct copy of the message to stdout described in the EXIT/OUTPUT section below.
182                 
183         
184         4. TIMEOUTS
185                 If a program fails to respond to a query, the game will end and that AI will be sent the ILLEGAL result.
186                 Human players are not subject to the timeout restriction.
187
188                 Please see the information on the -T switch.
189                 
190                         
191
192 EXIT/OUTPUT
193         If the game ends due to a player either winning, or making an illegal move, stratego will print one of the following result messages to stdout.
194
195         NAME COLOUR OUTCOME TURN_NUMBER OUTCOME RED_PIECE_VALUE BLUE_PIECE_VALUE
196
197         Where:
198                 NAME is the name of the player on whose turn the game ended,
199                 COLOUR is the colour of that player,
200                 OUTCOME is one of the following:
201                         VICTORY - The indicated player won
202                         DEFEAT - The indicated player lost
203                         SURRENDER - The indicated player surrendered
204                         DRAW - The game ended in a draw because neither player moved
205                         DRAW_DEFAULT - The game ended in a draw because the maximum number of moves was exceeded
206                         ILLEGAL - The indicated player loses due to an Illegal move/response
207                         DEFAULT - The indicated player wins by default due to the other player making an Illegal move/response
208                         BOTH_ILLEGAL - Both players made an Illegal move/response. Usually occurs due to simultaneous setup errors, or bad executable paths.
209                         INTERNAL_ERROR - The game ended, even though it shouldn't have.
210                         
211                 TURN_NUMBER is the number of turns that elapsed before the game ended
212
213                 RED_PIECE_VALUE and BLUE_PIECE_VALUE are the summed piece values of the pieces of RED and BLUE respectively.
214                 Bombs and Flags are worth zero, and the ranked pieces (Spys -> Marshal) are worth (11 - rank).
215                 So the Spy is worth 1 point, ... the Marshal is worth 10.
216
217                 (The initial piece values can be determined by running with -m 0)
218                 
219
220         stratego will then return exit code 0.
221
222         If an error occurs within stratego itself, an error message will be printed to stderr and return exit code 1.
223         If possible, stratego will print the message "QUIT" to both AI programs, and they should exit as soon as possible.
224
225 BUILDING
226         To build from source, simply run make in the source directory.
227         You will need the C pthread library (which should come with gcc)
228
229         stratego can be built with or without graphics enabled. By default, graphics are disabled.
230
231         To enable graphics:
232         1. Ensure that the first line of the source file "graphics.h" reads:
233                 #define BUILD_GRAPHICS
234         2. In "Makefile", uncomment the line "LIBRARIES = -lSDL -lGL -lpthread" 
235                 and comment out the line "LIBRARIES = -lpthread"
236
237         To disable graphics:
238         1. Comment out the first line of "graphics.h" i.e ensure that it reads:
239                 //#define BUILD_GRAPHICS
240         2. In "Makefile", uncomment the line "LIBRARIES = -lpthread" 
241                 and comment out the line "LIBRARIES = -lSDL -lGL -lpthread"
242
243         If you intend to build with graphics enabled, you will need the SDL and OpenGL developement libraries installed first.
244         If you intend to use graphics, please ensure the "images" directory is located in the executable's run directory.
245
246         
247         
248
249 BUGS    
250         Occasionally the result is not printed at the end of the game. 
251         So far this has only been observed to occur when RED wins the game by Flag capture.
252
253         stratego is still a work in progress. Report another bug to the AUTHOR (see below).
254
255
256 AUTHORS
257         Sam Moore (for the UCC Programming Competition 2012) <matches@ucc.asn.au>
258
259 NOTES
260         0. This program is still a work in progress and subject to changes.
261         
262         1. UCC Programming Competition 2012 Description
263            http://matches.ucc.asn.au/stratego/
264
265         2. UCC Programming Competition 2012 Git repository
266            git://git.ucc.asn.au/progcomp2012.git
267
268  
269         3. IRC Channel
270            irc://irc.ucc.asn.au #progcomp
271
272 THIS PAGE LAST UPDATED
273         3/01/12 by Sam Moore
274         

UCC git Repository :: git.ucc.asn.au