From 32585b55bf21d97c53657e4e9c836fb3702c9ff9 Mon Sep 17 00:00:00 2001 From: programarivm Date: Thu, 11 Jan 2024 13:19:56 +0100 Subject: [PATCH] Added docs/stockfish-eval.md --- docs/stockfish-eval.md | 27 +++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 28 insertions(+) create mode 100644 docs/stockfish-eval.md diff --git a/docs/stockfish-eval.md b/docs/stockfish-eval.md new file mode 100644 index 00000000..8c090323 --- /dev/null +++ b/docs/stockfish-eval.md @@ -0,0 +1,27 @@ +# /stockfish_eval + +Returns Stockfish's evaluation for the given position. + +| Name | Description | Required | +| ---- | ----------- | -------- | +| `fen` | A FEN string. | Yes | + +## Usage + +### Example + +Evaluate C65 — Ruy Lopez: Berlin Defense. + +```js +ws.send('/stockfish_eval "r1bqkb1r/pppp1ppp/2n2n2/1B2p3/4P3/5N2/PPPP1PPP/RNBQK2R w KQkq - 4 4"'); +``` + +```text +{ + "/stockfish_eval": { + "nag": "$10", + "meaning": "Equal position", + "symbol": "=" + } +} +``` diff --git a/mkdocs.yml b/mkdocs.yml index ebcb6b3a..6fe3d28c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,4 +17,5 @@ pages: - /restart: restart.md - /inbox: inbox.md - /stockfish: stockfish.md + - /stockfish_eval: stockfish-eval.md theme: readthedocs