go_codenames

Go-codenames

Go-codenames is a Go implementation of the board game Codenames. Please note that this repo only includes game logic and a basic API to interact with the game but does NOT include any form of GUI.

Usage

To play a game create a new Codenames instance:

builder := Builder{}
game, err := builder.Create(&bg.BoardGameOptions{
    Teams: []string{"TeamA", "TeamB"}, // must contain exactly 2 teams
    MoreOptions: CodenamesMoreOptions{
        Seed: 123, // seed used to generate deterministic randomness
    }
})

To flip a card do the following action:

err := game.Do(&bg.BoardGameAction{
    Team: "TeamA",
    ActionType: "FlipCard",
    MoreDetails: FlipCardActionDetails{
        Row: 0,    // rows 0 to 4 are valid
        Column: 0, // columns 0 to 4 are valid
    },
})

To end your turn do the following action:

err := game.Do(&bg.BoardGameAction{
    Team: "TeamA",
    ActionType: "EndTurn",
})

To get the current state of the game call the following:

snapshot, err := game.GetSnapshot("TeamA")