Add version 1.2 of Celsius
[progcomp2012.git] / web / faq.html
1 <html>
2 <head>
3   <title>Frequently Asked Questions</title>
4 </head>
5
6 <body>
7
8 <h1> Frequently Asked Questions </h1>
9
10 <p> Frequently is a bit misleading, since most of these have only been asked once. Some of them are questions that I predict will be asked. </p>
11
12 <ol>
13         <li> 
14         <p> <b>Q: How can I test my AI? </b></p>
15         <p> A: The manager program doesn't just play the games and print results. It includes features that let you play against your own AI, or watch it play against others, log games to files and replay them. The best way to test your AI is to play against it. Another good way to test your AI is to have it play against one of the sample AIs. </p>
16         </li>
17
18         <li> 
19         <p> <b>Q: Where can I get the sample AI programs? </b></p>
20         <p> A: Download the newest versions from the <a href="http://git.ucc.asn.au/?p=progcomp2012.git;a=summary"/>git repository</a>. The sample AI programs should be located in the subdirectory "agents", with one directory for each agent, containing the full source. </p> 
21         </li>
22
23         <li>
24         <p><b> Q: Where is the manager program? </b></p>
25         <p> A: The manager program is available in the <a href=http://git.ucc.asn.au/?p=progcomp2012.git;a=summary"/a>git repository</a>. It is located in the subdirectory "judge/manager". The executable name is "stratego" (<i>not</i> "manager"). </p>
26         </li>
27
28         <li>
29         <p> <b>Q: How do I compile the manager program / The manager program will not compile, what do I do? </b></p>
30         <p> A: The manager program is compiled by running "make" in the directory "judge/manager". </p>
31         <p> If the manager program fails to compile, it is probably because you do not have the SDL and OpenGL libraries, and are compiling with graphics enabled. You can either obtain SDL and OpenGL developement libraries, or disable graphics and compile the program without them. </p>
32         <p> These processes are described in the <a href="doc/manager_manual.txt"/>manual page</a> of the manager program. The manual page can also be found as "web/doc/manager_manual.txt" or "judge/manager/manual.txt" (the latter is a symlink). </p>
33         <li> 
34         <p> <b>Q: What the hell is git, and how do I use it? </b></p>
35         <p> A: git is version control software. Every time any of the programs (including samples) or documentation files for the competition are altered, the changes will be "committed" to git. git allows programmers to revert any changes which break things horribly and go back to their last working version, among other things. </p>
36
37         <p> As a contestant, all you really need to do is obtain the manager program and sample AI programs from the <a href=http://git.ucc.asn.au/?p=progcomp2012.git;a=summary"/a>git repository</a>. This page should give you a list of all the changes to the competition. Next to the most recent, click on the "snapshot" link to download an archive of the most recent version of every file. </p>
38
39         <p> Of course, if the competition is updated, you will then have an out of date version. It is far better to "clone" the git repository, and periodically run "git pull" to download any changes. Since the purpose of this page is not to be a reference manual for git, learning how to do this is left as an excercise for the reader. </p>
40         </li>
41         <li> 
42         <p> <b>Q: Do I have to keep checking the git repository for updates? </b></p>
43         <p> A: No, the mailing list will be emailed every time there is a major change. </p>
44         </li>
45
46         <li>
47         <p> <b>Q: I don't know anything about AI programs, where should I start? </b></p>
48         <p> A: The sample AI programs provide a fairly basic strategy; perhaps start by copying a sample AI program and altering it slightly to see if you can improve it. </p>
49
50         <p> Generally AI programs for board games play by always choosing an optimal move. The sample AI programs adopt this approach by allocating scores to various moves, with the score indicating how "good" the move is. They then sort the moves by score, and choose the move with the highest score. </p>
51         <p> Of course, then the problem becomes "What scoring algorithm should I use?", which you will have to find out for yourself. </p>
52
53         <p> Chess AIs usually look at many future possible board states as a result of each move. In stratego, this approach is less likely to be effective since the strength/abilities of opponent pieces is not known, and must be determined. There is also a time limit to responses by AI programs. </p>
54
55
56
57         </li>
58
59         <li>
60         <p><b> Q: What is in "judge/simulator"? </b></p>
61         <p> A: "judge/simulator/simulate.py" will be used to run the competition. You can use it yourself if you want to run a mock competition between various sample AIs and your own AI. </p>
62         <p> The script generates html files containing the results, in the directory "web/results". It also stores log files of every game played in "web/log", which you can replay at your leisure using the manager program. </p>
63
64         </li>
65         <li>
66         <p> <b> Q: The language I want to write in does not have any sample AIs, or does not have as advanced sample AIs as other langauges. </b> </p>
67         <p> A: Try and rewrite a sample from another AI in your chosen language, or, if you really don't know any other langauges, email matches@ (and be <b>very</b> nice) and ask for him to write a sample in your chosen language. </p>
68
69         </li>
70
71         <li>
72         <p><b> Q: I don't know how to program, but am interested in the competition, what should I do? </b> </p>
73         <p> A: You will have to learn how to program; the best way to do this is by a combination of the internet and trial and error. Look at the sample AI programs for a reference. </p>
74         </li>
75         <li>
76         <p> <b> Q: Is windows supported? </b> </p>
77         <p> A: One day, when I am feeling particularly cheerful and need depressing, I will attempt to get things to work on windows. </p>
78
79         <p>(tl;dr NO) </p>
80         </li>
81
82 </ol>
83
84 <h1> General tips and Advice </h1>
85
86 <ol>
87         <li> Print your debug information to stderr to allow your AI to be debugged whilst playing a game </li>
88 </ol>
89
90
91 <p> Return to the <a href="index.html"/>main page</a>. </p>
92
93 </body>
94 </html>

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