Skip to content

Commit

Permalink
Merge pull request #288 from chesslablab/issue/287-Document-the-game-…
Browse files Browse the repository at this point in the history
…modes-available

Documented the game modes
  • Loading branch information
programarivm authored Jun 25, 2024
2 parents 9268feb + fd7a153 commit 01ef951
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Starts a new game.
| Name | Description | Required |
| ---- | ----------- | -------- |
| `variant` | `960`<br/>`capablanca`<br/>`capablanca-fischer`<br/>`classical` | Yes |
| `mode` | `fen`<br/>`san`<br/>`play`<br/>`stockfish` | Yes |
| `add` | `fen`<br/>`movetext`<br/>`startPos`<br/>`settings`<br/>`color` | Depends on the mode selected. |
| `mode` | `fen`<br/>`san`<br/>`play`<br/>`stockfish` | Yes. `fen` stands for Forsyth-Edwards Notation and is the standard way for starting games from specific chess positions. The `san` mode stands for Standard Algebraic Notation and is often used to load chess games annotated by humans always from the starting position. The `play` mode allows to play chess online with other players while the `stockfish` mode is used to play chess against the computer. |
| `add` | `fen`<br/>`movetext`<br/>`startPos`<br/>`settings`<br/>`color` | Additional parameters may be required depending on the mode selected as shown in the examples below. |

## Usage

Expand Down

0 comments on commit 01ef951

Please sign in to comment.