API

AbstractAction

A supertype for all action definitions.

AbstractGame

A supertype for all game definitions. Concrete game structs should sub-type this and contain the necessary parameters to define the game rules.

AbstractGameState

A supertype for all game state definitions. Concrete state structs should sub-type this and contain all information needed to represent a specific moment in a game (e.g., player positions, scores, board layout).

init(game::AbstractGame)::AbstractGameState

Initializes a game by setting up the starting state.

This function should be implemented by concrete game types to return the specific starting state (a concrete subtype of AbstractGameState) for that game.

step(game::AbstractGame, state::AbstractGameState, action::AbstractAction)::Tuple{Real, AbstractGameState}

Takes a single step in the game given an action.

Returns

A tuple containing:

1. The reward received for the step (a subtype of Real).
2. The new state of the game (a concrete subtype of AbstractGameState).