More documentation; an agents directory for people to write there agents in, and...

[progcomp10.git] / src / USINGPYTHON.txt

diff --git a/src/USINGPYTHON.txt b/src/USINGPYTHON.txt
new file mode 100644 (file)
index 0000000..b11a686
--- /dev/null
+++ b/src/USINGPYTHON.txt
@@ -0,0 +1,42 @@
+USINGPYTHON.txt: A 10 step guide to writing an agent in Python.
+
+1. Pick a name for your agent. Make sure the name is a valid python identifier. Be original. 
+
+2. Open SampleAgents.py.  Pick a sample agent to copy-paste (so you don't have to type out the function definitions).
+
+3. Copy the sample agent code into a new file in the "agents" directory. Make sure the file has the same name as the agent.
+
+4. Modify the code to do your bidding.
+
+4a. If you wish to implement your own leaning agent based on BaseAgent, rather than use the limited functionality of LearningAgent, insert the following code snippet inside your class:
+
+       def Results (self, foeName, wasAttacker, winner, attItem, defItem, bluffItem, pointDelta):
+               BaseAgent.Results (self, foeName, wasAttacker, winner, attItem, defItem, bluffItem, pointDelta)
+               # your own code goes here
+
+
+5. Create an arena in which your agent can battle:
+
+   5.1. open arenas/MyArena.py
+
+   5.2. add "from agents.<youragentname> import <youragentname>"
+
+   5.3. modify the "Agents =" line to include your agent, and take out any agents you don't want to battle.
+
+6. Watch your agent in action: ./simulate -v -a MyArena
+
+7. Oh no, my agent dies very quickly: what's going on?
+
+   7.1 insert print statements in your python module. (Hint: prefix them with self.id so you can identify different agents)
+
+   7.2 Run "./simulate -v -n 1 -a MyArena" to start with only 1 of each agent.
+
+   7.3 Change the agents against which you're battling in MyArena.py so that you have a predictable opponent.
+
+   7.1 Edit conf.py, and set DEBUG=True. Don't forget to reset it when you're done.
+
+8. Once your agent works to your satisfaction, try it both on short and long durations (100 and 1000 rounds: see MAX_ITERATIONS in conf.py)
+
+9. If the rolling scoreboard has been opened on progcomp.ucc.asn.au/, submit it there! Otherwise, sit tight.
+
+10. Watch its progress on the scoreboard and adjust your strategy accordingly.
\ No newline at end of file