new_game
Start a game against a pyplAI opponent and get the initial board state. Configure the game, opponent algorithm, player side, opening moves, and search seed.
Instructions
Start a game against a pyplAI algorithm. If the opponent moves first, it has already moved in the returned state.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| game | Yes | Game to play. See list_games. | |
| seed | No | Seed for the opponent's search, to make its play reproducible. | |
| opening | No | Moves to play from the start, for both players, before the game is handed over. Use it to set up a position. | |
| play_as | No | Your player number. Player 1 moves first. | |
| opponent | No | Opponent algorithm. auto picks the strongest fair one for the game. | auto |
| minimax_depth | No | Search depth (moves ahead) for the minimax opponent. | |
| opponent_seconds | No | Thinking time per move for Monte Carlo opponents. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| game | Yes | ||
| board | Yes | The board as you see it. | |
| notes | Yes | Facts about the position you are allowed to know. | |
| status | Yes | ||
| game_id | Yes | ||
| history | Yes | Everything that has happened, as you saw it. | |
| you_are | Yes | Your player number. Player 1 moves first. | |
| opponent | Yes | ||
| legal_moves | Yes | Moves you can play now. Empty when the game is over. |