diff --git a/docs/ascii.md b/docs/ascii.md new file mode 100644 index 00000000..128c9ad9 --- /dev/null +++ b/docs/ascii.md @@ -0,0 +1,21 @@ +# /ascii + +Returns an ASCII representation of the board. + +--- + +### Usage + +#### Example + +```js +ws.send('/start "{\\"variant\\":\\"classical\\",\\"mode\\":\\"analysis\\"}"'); +ws.send('/play "{\\"color\\":\\"w\\",\\"pgn\\":\\"e4\\"}"'); +ws.send('/ascii'); +``` + +```text +{ + "/ascii": " r n b q k b n r \n p p p p p p p p \n . . . . . . . . \n . . . . . . . . \n . . . . P . . . \n . . . . . . . . \n P P P P . P P P \n R N B Q K B N R \n" +} +``` diff --git a/mkdocs.yml b/mkdocs.yml index cd3b3502..154d7092 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,6 +14,7 @@ nav: - /search: search.md - game: - Basic: + - /ascii: ascii.md - /eval_names: eval-names.md - /online_games: online-games.md - /undo: undo.md