fb73fca055edc0f079080506bd18ee72cf446b92
[progcomp10.git] / doc / UNSUPPORTED.txt
1 UNSUPPORTED.txt: This file describes the wire protocol. You should only need this if you're debugging an external 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 Syntax for when your agent is spawned:
13 >HI uuid
14
15 Syntax for an attacking agent:
16 >ATTACK foeName
17 <ATTACKING itemToUse itemToPromise
18 Example:
19 >ATTACK agent00002
20 <ATTACKING Paper Scissors
21
22 Syntax for a defending agent:
23 >DEFEND foeName foePromisedItem
24 <DEFENDING itemUsed
25 Example:
26 >DEFEND agent00001 Scissors
27 <DEFENDING Rock
28
29 Syntax for collecting results:
30 >RESULTS foeName isInstigatedByYou winner yourItem theirItem promisedItem pointChange
31 <OK
32 Example:
33 >RESULTS agent00001 False Attacker Rock Paper Scissors -2
34 <OK
35
36 Syntax for cleaning up after your bot - either the round has ended, or you've been killed off
37 >BYE
38 {program exits without responding}

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