Command Line Interface

Basic Usage Examples

• Run 1,000 games with Random Players

  catanatron-play --num 1000 --players R,R,R,R 

• Run 10 1v1 games between VictoryPointPlayer and ValueFunctionPlayer

  catanatron-play --num 10 --players VP,F 

• Pit 3-player Catan with basically no discard limit

  catanatron-play --num 1 --players W,F,AB:2 --config-discard-limit 999

• Play 1v1 against ValueFunctionPlayer until 15 points with discard limit set to 9 (would not recommend 😅; its much better to play using the GUI)

  {% code overflow="wrap" %}

  catanatron-play --num 1 --players F,H --quiet --config-discard-limit 9 --config-vps-to-win 15 

  {% endcode %}### Using Different Players

Many of the Bots are ready to be used from the CLI using the --players flag. Specify players by using <id>:<param1>:<param2>:... syntax. For example,

• G:10 is GreedyPlayoutsPlayer with rollouts = 10

• AB:3:True is AlphaBetaPlayer with 3 ply look-ahead and prunning turned on

• ...

For more information, use:

catanatron-play --help-players

catanatron-play --help-players output

Saving Game Results

You can save the output of games using the --output and --output-format flags. For example:

JSON Format

catanatron-play --num 5 --players F,F,R,R --output data/ --output-format json

Inspecting the data directory you should see all 5 games.

data/
├── 2aba0ec4-51e7-47b6-b5a9-113874b2addf.json
├── 353a541b-59d2-4eb8-85ea-d6eb0d162e7f.json
├── 3c5f37ce-a73c-4180-91fd-28bf9f6dacd2.json
├── e31b00a3-845c-4bfd-92bd-c4a42cbafa27.json
└── ee547837-d5e2-4d9b-8420-583b2fdd793d.json

1 directory, 5 files

Other Formats

You can also generate data in CSV and Parquet for Machine Learning and similar applications. See more at Data and Machine Learning.