documentation to support uuid passing
[progcomp10.git] / doc / UNSUPPORTED.txt
1 UNSUPPORTED.txt: This file describes the wire protocol. You should only need this if you're debugging a non-Python agent, or if you're interested in writing an agent in an unsupported language.
2
3 If you are interested in using an unsupported language, consult the website for details on how to check with the organiser first.
4
5 === Wire protocol ===
6
7 The syntax for input and output is as follows. Every line of input given by the supervisor must be replied with the correct response.
8 Segmentation fault is never the correct response :-). Rumour has it that if you just use Python, this won't happen. 
9
10 The angle brackets (<>) indicate whether the line is output from the agent or input to it respectively, and are not part of the actual formatting
11
12 Canonical lengths of the following strings are in src/link/C/c_link.[ch]
13
14 Syntax for when your agent is spawned:
15 >HI uuid
16 {no response}
17
18 Syntax for an attacking agent:
19 >ATTACK foeName
20 <ATTACKING itemToUse itemToPromise
21 Example:
22 >ATTACK agent00002
23 <ATTACKING Paper Scissors
24
25 Syntax for a defending agent:
26 >DEFEND foeName foePromisedItem
27 <DEFENDING itemUsed
28 Example:
29 >DEFEND agent00001 Scissors
30 <DEFENDING Rock
31
32 Syntax for collecting results:
33 >RESULTS foeName isInstigatedByYou winner yourItem theirItem promisedItem pointChange
34 <OK
35 Example:
36 >RESULTS agent00001 False Attacker Rock Paper Scissors -2
37 <OK
38
39 Syntax for cleaning up after your bot - either the round has ended, or you've been killed off
40 >BYE
41 {program exits without responding}

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