Skip to content

Commit

Permalink
Added docs/online-games.md
Browse files Browse the repository at this point in the history
  • Loading branch information
programarivm committed Jan 11, 2024
1 parent 37987c4 commit 9b03798
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 0 deletions.
55 changes: 55 additions & 0 deletions docs/online-games.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# /online_games

Returns the online games waiting to be accepted.

## Usage

### Example

```js
ws.send('/online_games');
```

```text
{
"/online_games": [
{
"iss": "chesslablab.net",
"iat": 1704983331,
"exp": 1704986931,
"variant": "classical",
"submode": "online",
"color": "b",
"min": 5,
"increment": 1,
"fen": "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq -",
"hash": "84a4e20138e54e1869b9b79e7d3111f1"
},
{
"iss": "chesslablab.net",
"iat": 1704983347,
"exp": 1704986947,
"variant": "960",
"submode": "online",
"color": "w",
"min": 10,
"increment": 5,
"fen": "bqrnnbkr/pppppppp/8/8/8/8/PPPPPPPP/BQRNNBKR w KQkq -",
"startPos": "BQRNNBKR",
"hash": "c6b79ac68055766c2a33364f69c72e4c"
},
{
"iss": "chesslablab.net",
"iat": 1704983367,
"exp": 1704986967,
"variant": "capablanca",
"submode": "online",
"color": "b",
"min": 30,
"increment": 10,
"fen": "rnabqkbcnr/pppppppppp/10/10/10/10/PPPPPPPPPP/RNABQKBCNR w KQkq -",
"hash": "076bafad0559def2db7866609680074c"
}
]
}
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,5 @@ pages:
- /inbox: inbox.md
- /stockfish: stockfish.md
- /stockfish_eval: stockfish-eval.md
- /online_games: online-games.md
theme: readthedocs

0 comments on commit 9b03798

Please sign in to comment.