Lots of stuff happened
[progcomp2013.git] / qchess / data / help.txt
1 NAME
2         qchess.py - Play quantum chess
3
4 SYNOPSIS
5         qchess.py [OPTIONS] [white] [black]
6
7 DESCRIPTION
8         An implementation of Quantum Chess as originally described and implemented here:
9         http://research.cs.queensu.ca/Parallel/QuantumChess/QuantumChess.html
10
11         Reimplemented for UCC::Progcomp 2013
12         http://progcomp.ucc.asn.au
13
14         IMPORTANT:
15          - This version does not implement castling or en passen rules.
16          - If a piece currently in a pawn state moves into the opposing back row, that state always becomes a queen.
17             - (The other state of the piece is unaffected).
18
19
20 ARGUMENTS
21
22         If no arguments are given, a window should appear asking you to pick each player.
23         Then the game will commence using default values.
24
25         white, black
26                 Each of the two players in order. They need not be provided if graphics is enabled (default).
27                 
28                 Any arguments that do not begin with a hyphen (-) are treated as the player arguments in the order they appear.
29
30                 Player arguments that begin with '@' are treated as special players:
31
32                 @human
33                         A human player; if graphics are enabled, this players turns are made through the GUI
34
35                 @network[:address]
36                         A player over a network connection. 
37
38                         For example, if black@host1 wants to play white@host2:
39
40                         black@host1:~$ ./qchess.py @network @human
41                         white@host2:~$ ./qchess.py @human @network:host1
42
43                         IMPORTANT: Only ONE of the games should give the other's address.
44
45 OPTIONS
46
47         --help
48                 Print this page
49         
50         --graphics
51                 Disable/Enable the GUI
52
53                 If graphics are enabled (default), then the user will be prompted to choose any of the two players not supplied as arguments.
54                 
55
56         --file[=filename]
57                 Replay a game saved in file, or read from stdin if no filename given
58
59         --log[=filename]
60                 Log moves to a file or stdout if no filename given
61
62         --delay[=time]
63                 The game pauses between moves so that it can be followed by a human observer.
64                 This option can be used to change the delay. If no time is given, the delay is disabled.
65
66                 If graphics are enabled (default), the delay is 0.5s by default.
67                 If graphics are disabled, there is no delay unless this option is used.
68
69         --timeout[=time]
70                 Set the maximum time in seconds to wait before declaring an AI program unresponsive.
71                 If no time is given, the timeout is disabled.
72
73                 By default the timeout is disabled.
74
75         --classical
76                 If this option is used, the game will treat pieces "classically", ie: as in standard chess.
77                 Note that the game does not enforce rules related to check and checkmate.
78
79         --quantum
80                 The game uses the quantum chess representation of pieces (default).
81
82         
83 AUTHOR
84         Written for the UCC Programming Competition 2013 by Sam Moore.
85         UCC::Progcomp home page: http://progcomp.ucc.asn.au
86
87 REPORTING BUGS
88         Report bugs to matches@ucc.asn.au
89         Join IRC channel #progcomp on irc://irc.ucc.asn.au
90
91 COPYRIGHT
92         Copyright 2013 The University Computer Club, Inc.
93
94         Contact committee@ucc.asn.au
95

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