doc/HOWTO.txt

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