rcg

rcg.git
git clone git://git.lenczewski.org/rcg.git
Log | Files | Refs | README | LICENSE

README (1435B)


      1 rcg: robot card game
      2 ==============================================================================
      3 A simple card game, written for AI agents to play against themselves.
      4 
      5 rcg: Building
      6 ------------------------------------------------------------------------------
      7 To build the server and all agents, simply run:
      8 ```sh
      9 $ ./build.sh
     10 ```
     11 
     12 To clean all generated binaries, run:
     13 ```sh
     14 $ ./clean.sh
     15 ```
     16 
     17 After having ran `build.sh`, to run the server, run the following command:
     18 ```sh
     19 $ sudo ./bin/server -a <agent1> -A <agent1-uid> -b <agent2> -B <agent2-uid>
     20                     [-t <max-threads>] [-m <max-memory-mib>] [-s <timeout-secs>]
     21 		    [-v]
     22 ```
     23 
     24 Note: when running tournaments and benchmarking, unique users are required to
     25 allow linux to set accurate resource limits for threads and memory. To create
     26 these users, please run the following command:
     27 ```sh
     28 $ sudo ./install.sh   # creates a number of users for the tournament.py and benchmark.py scripts
     29 ```
     30 
     31 To clean up the created users:
     32 ```sh
     33 $ sudo ./uninstall.sh # optional, removes the previously created users
     34 ```
     35 
     36 To benchmark two agents against each other, use the `extras/benchmark.py`
     37 script, as follows:
     38 ```sh
     39 $ sudo ./scripts/benchmark.py <agent1> <agent2>
     40 ```
     41 
     42 To host a tournament, use the `extras/tournament.py` script as follows:
     43 ```sh
     44 $ sudo ./scripts/tournament.py <schedule.txt> <output.txt>
     45 ```
     46 
     47 For concrete documentation, please read the individual scripts.