A GUI for Mac and Windows for spectating and logging games of Settlers of Catan.

Other projects can read log files and do useful things, i.e.

teach a machine learning model: AI research, see http://github.com/rosshamish/goodcatan

semi-automated tournaments: draws, matchups, stats, tiebreakers computed from game logs

Demo

Installation

If you don't have brew, go to http://brew.sh and install it.

If you don't have python3, do $ brew install python3

$ pip3 install catan-spectator

Usage

Basic usage:

$ catan-spectator

For a particular board layout:

$ catan-spectator --board 'o s w w o s s h b h w s w h h b o d b 5 2 8 10 9 8 5 3 4 6 3 6 10 12 11 9 11 None 4'

Terrain are referred to by their first letter in lowercase, except wheat, which is an h. Numbers are referred to by their corresponding digit, and "None" represents no number. Exactly nineteen terrain characters are expected, and exactly nineteen numbers are expected.

Terrain Name Short Code Wood w Brick b Wheat h Sheep s Ore o Desert d

For a full list of options:

$ catan-spectator --help

Hotkeys

Key Action 2 roll 2 3 roll 3 4 roll 4 5 roll 5 6 roll 6 7 roll 7 8 roll 8 9 roll 9 0 roll 10 - roll 11 = roll 12 r buy road s buy settlement c buy city d buy dev card k play knight left arrow undo right arrow redo space bar end turn

File Format

catan-spectator writes game logs in the .catan format described by package catanlog .

They look like this:

green rolls 6 blue buys settlement, builds at (1 NW) orange buys city, builds at (1 SE) red plays monopoly on ore

Attribution

Codebase originally forked from fruitnuke/catan, a catan board generator

License

GPLv3