[RULE CHANGE] *Victory by "attrition"* + Bug fixes

[progcomp2012.git] / web / doc / manager_manual.txt

diff --git a/web/doc/manager_manual.txt b/web/doc/manager_manual.txt
index 9024c74..bd9f0e1 100644 (file)
--- a/web/doc/manager_manual.txt
+++ b/web/doc/manager_manual.txt
@@ -5,7 +5,7 @@ WARNING
        This program is still a work in progress. Consider it a Beta version.
 
 SYNOPSIS
-       stratego {[-gpirb] [-o output_file ] [-t stall_time] [-m max_turns] {red_player blue_player | -f input_file} | {-h | --help} }
+       stratego {[-gpirb] [-o output_file ] [-t stall_time] [-T timeout_time] [-m max_turns] {red_player blue_player | -f input_file} | {-h | --help} }
 
 DESCRIPTION
        stratego manages a game of Stratego. It stores the state of the board, and uses a simple protocol to interface with AI programs.
@@ -69,6 +69,15 @@ OPTIONS
                
                It is tentatively planned to allow the user to enter various commands to alter the game or proceed to specified turns.
                However this is slightly complicated. So it might never be done.
+
+       -T
+               By default, stratego allows AI programs 2 seconds to respond before declaring their move ILLEGAL due to a timeout.
+               If the -T switch is present, AI programs will be allowed timeout_time to respond before their move is declared ILLEGAL.
+
+               If timeout_time is negative or "inf", stratego will never declare moves illegal due to timeouts.
+       
+               Human players are never subject to timeouts.
+               
        -m
                By default, the game is declared a Draw after 5000 turns have ellapsed.
                Use this option to change the maximum number of turns.
@@ -116,11 +125,12 @@ GAME RULES
 
                Each player's pieces are hidden from the other player. When two pieces encounter each other, the ranks will be revealed.
 
-               The objective is to destroy all Enemy Pieces (#) or capture the Enemy Flag (also #).
+               The objective is to either destroy all enemy pieces except the Bombs and Flag, or to capture the Flag.
 
                Since 20/12 Bombs reflect the traditional rules; they are only destroyed by Miners.
                In previous versions contact of an attacker other than a Miner with a Bomb destroyed the Bomb as well as the attacking piece.
                
+               
 
 PROTOCOL
        In order to interface with stratego, an AI program must satisfy the following protocol. 
@@ -181,8 +191,10 @@ PROTOCOL
                
        
        4. TIMEOUTS
-               If a program fails to respond to a query within 2 (two) seconds, the game will end and that AI will be sent the ILLEGAL result.
+               If a program fails to respond to a query, the game will end and that AI will be sent the ILLEGAL result.
                Human players are not subject to the timeout restriction.
+
+               Please see the information on the -T switch.
                
                        
 
@@ -221,16 +233,19 @@ EXIT/OUTPUT
 
 BUILDING
        To build from source, simply run make in the source directory.
+       You will need the C pthread library (which should come with gcc)
 
        stratego can be built with or without graphics enabled. By default, graphics are disabled.
 
-       To enable graphics, ensure that the first line of the source file "graphics.h" reads:
-
-       #define BUILD_GRAPHICS
-
-       To disable graphics, comment out the first line of "graphics.h" i.e ensure that it reads:
+       To enable graphics:
+       1. Ensure that the first line of the source file "graphics.h" reads:
+               #define BUILD_GRAPHICS
+       2. In "Makefile", uncomment the line "CPP = g++ -Wall -pedantic -lSDL -lGL  -g" and comment out the line "CPP = g++ -Wall -pedantic -g"
 
-       //#define BUILD_GRAPHICS
+       To disable graphics:
+       1. Comment out the first line of "graphics.h" i.e ensure that it reads:
+               //#define BUILD_GRAPHICS
+       2. In "Makefile", uncomment the line "CPP = g++ -Wall -pedantic -g" and comment out the line "CPP = g++ -Wall -pedantic -lSDL -lGL  -g"
 
        If you intend to build with graphics enabled, you will need the SDL and OpenGL developement libraries installed first.
        If you intend to use graphics, please ensure the "images" directory is located in the executable's run directory.