Skip to content

Latest commit

 

History

History
98 lines (72 loc) · 3.97 KB

README.md

File metadata and controls

98 lines (72 loc) · 3.97 KB
Raw

Catan.jl

An engine for adding AI players to a party of the extremely popular board game Settlers of Catan. The AI players can be used to supplement a party of <4 human players. New AI players can be defined by simply implementing the API via a struct that inherits from RobotPlayer.

How to run the game

To launch a new or existing game: $julia Catan.jl [CONFIG FILE] [MAP FILE] [SAVE FILE]

For example, from the repository root directory, run

$julia --project src/Catan.jl data/config.txt data/sample.csv save.txt

  • data/config.txt sets the label (e.g. a color) and player class (e.g. HumanPlayer or DefaultRobotPlayer) for each player.
  • data/sample.csv sets the board layout
  • save.txt is a file to write the game history for saving and reloading previous games. If the file already exists, it will be read and the game state will be initialized by executing the progress denoted in this file.

Developer Notes

Board representation

        (7)      (6) 
       61-62-63-64-65-66-67
       |  Q  |  R  |  S  | (5)
    51-52-53-54-55-56-57-58-59
(8) |  M  |  N  |  O  |  P  |
 41-42-43-44-45-46-47-48-49-4!-4@
 |  H  |  I  |  J  |  K  |  L  |(4)
 31-32-33-34-35-36-37-38-39-3!-3@
 (9)|  D  |  E  |  F  |  G  |
    21-22-23-24-25-26-27-28-29
       |  A  |  B  |  C  |(3)
       11-12-13-14-15-16-17
        (1)      (2)

Note: the numbers (x) are the ports

Map file

The map file (data/sample.csv in the above example) is a 3-column csv file with values Tile,Dice,Resource where:

  • Tile is a single capital letter A-S denoting the hexagon tile corresponding to the above board sketch. Warning These are purely internal IDs and do not correspond to the letters on the physical Catan tokens.
  • Dice is a single integer 2-12 denoting the dice token placed on the hexagon (use 7 for the desert)
  • Resource is a single letter denoting the resource: w[ood],s[tone],g[rain],b[rick],p[asture]

Debugging

For convenience, setting PRINT_BOARD = true in src/constants.jl will print a color representation of the final map state:

image

Defining a new player

Initialize the player type

Define a new player called NewRobotPlayer requires the definition in ./src/players/structs.jl inheriting from RobotPlayer:

mutable struct NewRobotPlayer <: RobotPlayer
    player::Player

    # Here, Insert any other fields to store intermediary data or parameters between turns
end

and it needs to have two constructors:

NewRobotPlayer(team::Symbol) = NewRobotPlayer(Player(team))
NewRobotPlayer(player::Player) = NewRobotPlayer(
    player, 
    # Here, initialize any default values for other fields
)

Note: Julia automatically creates the NewRobotPlayer(player::Player) if you don't define any other fields.

Define the player behavior

Add a file in the directory ./src/players and implement any of the methods in the header of ./src/players/robot_player.jl for which you want customized behavior.

For example, to give your NewRobotPlayer a custom algorithm to accept trades, implement the following function definition:

function choose_accept_trade(board::Board, player::NewRobotPlayer, from_player::Player, from_goods::Vector{Symbol}, to_goods::Vector{Symbol})::Bool
    # Define a custom algorithm for how the NewRobotPlayer will decide to accept a proposed trade or not.
end

Adding the new player to a game

Simply add a line to your config file that invokes your new player by the name of its mutable struct. So a game with 1 human, 1 default robot player and 2 of your custom players could have the format:

red,HumanPlayer
cyan,DefaultRobotPlayer
green,NewRobotPlayer
blue,NewRobotPlayer