Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documented the game modes #288

Merged
merged 1 commit into from
Jun 25, 2024
+2 −2
Merged

Documented the game modes #288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/start.md
View file
Open in desktop
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
Loading