Updated graphics to for displaying on the clubroom projector
[progcomp2012.git] / web / doc / manager_manual.txt
index a19cd5d..98a728b 100644 (file)
@@ -4,7 +4,7 @@ NAME
 
 
 SYNOPSIS
-       stratego {[-gpirb] [-o output_file ] [-t stall_time] [-T timeout_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] [-I image_directory] {red_player blue_player | -f input_file} | {-h | --help} }
 
 QUICK EXAMPLE - Play against a sample AI, using graphics, hiding the AI's pieces
        stratego -g -b @human ../../agents/vixen/vixen.py
@@ -101,13 +101,31 @@ OPTIONS
                All switches function as normal with -f.
                NOTE: It is recommended that -g is used with -f.
 
+       -I
+               stratego can output image files in the BMP format, when built with graphics.
+               If this option is supplied, a directory indicated will be used, and a .bmp image will be saved to the directory after each move.
+               The images will be numbered from 0.bmp (before the game starts) with increasing integers for each move.
+               Note that the image number corresponds to the move number, not the turn number. 
+               The move number is odd after RED has moved, and even after BLUE has moved.
+
+               NOTE: The -I switch will automatically enable graphics, even if the -g switch is not supplied.
+
+       -v
+               If you have ffmpeg on your system, you can use this to quickly create a video.
+               When this option is supplied, stratego first outputs image files to a temporary directory in BMP format.
+               After the game is finished, these files are used to create an mp4 movie with the specified name:
+                       
+               $ ffmpeg -r 10 -b 1024k -i tmp/%d.bmp filename
+               
+               The temporary images will then be deleted.
+
        -h, --help
                If the -h switch is used, this page will be printed and stratego will exit.
                
                
 
 GAME RULES
-               Each player controls up to 40 pieces on the Board. The pieces are represented by the following characters:
+               Each player controls 40 pieces on the Board. The pieces are represented by the following characters:
 
                Piece   Name            Rank    Number  Abilities
                1       Marshal         1       1       Dies if attacked by Spy
@@ -134,13 +152,16 @@ GAME RULES
                Pieces may only move one square horizontally or vertically unless otherwise stated.
                Pieces may not move through squares occupied by allied pieces, or Obstacle (+) pieces.
                Pieces may move into squares occupied by Enemy Pieces (#), in which case the piece with the lower rank (higher number) is destroyed.
+               If the moved piece (attacker) has the lower rank, the stationary piece (defender) does _not_ move into the attacker's square.
 
                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 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.
+               Since 20/12/2011 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.
+
+               Since 9/04/2012 An AI must place ALL 40 pieces listed above, or its setup will be declared illegal
                
                
 
@@ -281,6 +302,8 @@ PROTOCOL
                                - ATTACKER_RANK and DEFENDER_RANK are the ranks of the attacking and defending piece respectively
                        - The moved piece attacked an opponent piece, and both pieces were destroyed: "BOTHDIE $ATTACKER_RANK $DEFENDER_RANK"
                                - ATTACKER_RANK and DEFENDER_RANK are the ranks of the attacking and defending piece respectively
+                       - Game ended due to the attacker capturing a flag: "VICTORY_FLAG"
+                       - Game ended due to the destruction of a player's last mobile piece (either attacker or defender): " 
 
                ROW1 -> ROW10 - The state of the board will be printed
                              - Each line represents a row on the board, from the top downwards
@@ -374,7 +397,7 @@ PROTOCOL
                ---------------------------------------------------
                Synopsis:
                ---------------------------------------------------
-               >> QUIT [RESULT]
+               >> QUIT [$RESULT]
                ---------------------------------------------------
                Explanation:
                ---------------------------------------------------
@@ -389,7 +412,22 @@ PROTOCOL
                Human players are not subject to the timeout restriction.
                ---------------------------------------------------
                Please see the information on the -T switch, and the "End Game" section above.
+
+       5. Resignation
+               ---------------------------------------------------
+               Description:
+               ---------------------------------------------------     
+               Instead of making a move, an AI program may resign.
+               ---------------------------------------------------
+               Synopsis:
+               ---------------------------------------------------
+               << SURRENDER
+               >> QUIT SURRENDER
+               ---------------------------------------------------
+               Explanation:
+               ---------------------------------------------------
                
+               ---------------------------------------------------             
                        
 
 EXIT/OUTPUT
@@ -476,5 +514,5 @@ NOTES
           irc://irc.ucc.asn.au #progcomp
 
 THIS PAGE LAST UPDATED
-       3/03/12 by Sam Moore
+       09/04/12 by Sam Moore
        

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