1 HOWTO.txt: A beginners guide to entering the UCC::ProgComp 2010.
3 If you get stuck at any point, consult, in this order:
4 - documentation for the ProgComp
8 === Setting up a development environment ===
10 The ProgComp will work best for those running Mac OS X or Linux, but
11 Windows is also supported.
13 All competitors will need Python, a modern, object-oriented scripting
14 languages. Python comes pre-installed on Mac OS X and modern Linuxes -
15 Windows users must download it from
16 http://www.python.org/download/releases/2.7/
18 Then software you'll then need depends on the language in which you wish
19 to program. The most up-to-date details, including some useful links,
20 can be found at http://progcomp.ucc.asn.au/FAQs under "What software do
23 Set up the relevant software now - we'll assume you have it working in
24 the rest of this document.
26 === Trying out the sample agents ===
28 Full sample code is supplied for all the supported languages.
30 Pull up a terminal/command line prompt. Change directory to the src/
31 subfolder (*nix path conventions will be used throughout) and type
32 "python simulate.py -v"
34 You should see some output as "Angel", "Lucifer", "Streetfighter" and
35 "Wash", the 4 sample agents, battle it out. If you an error is raised -
36 well, that's a bit awkward. It's probably due to your python
37 installation - check that, check the FAQs, then google the error
38 message, then if none of that works, contact us.
40 If you're using Python, take some time to poke around at
41 SampleAgents.py, then skip to the next section.
43 If you're using C/C++, Java or MATLAB, follow the instructions in the
44 src/link/<language> directory to get those agents running. Again, if
45 something goes wrong, check the documentation, the FAQ, Google, and then
46 if still stumped, contact us.
48 Take some time to poke around at the sample code and get a handle on
49 what's going on and how it works.
51 === Making your own ===
53 Here's where you have to do the thinking. Your agent must consist of a
54 single source file, and provide the same function definitions as the
57 Consult the documentation for each language to see how to write an agent
58 in your language of choice. Start in the "src" directory.
60 === Submitting your own agent ===
62 Procedures for submitting your own agent will be released by email and
63 on the website soon. Stay tuned.
65 Submitting your agent is not the end of the fun, either. All going
66 well*, there should be a running leaderboard, so you can watch your
67 agent compete, if you wish, or you can keep its runnings secret until
70 * This includes the organiser not dying of a caffeine overdose or
71 developing a psychiatric injury as a result of overloading and
72 co-ordinating. Your mileage may vary. UCC members may donate to the coke
73 account 'dja' if they wish to keep me supplied with coke and pizza