An HTTP service that renders chess board images.
Requires Python 3.7+.
sudo apt-get install python3-dev libffi-dev libxml2-dev libxslt1-dev libcairo2
git submodule update --init --recursive
pip install -r requirements.txt
python server.py [--port 8080] [--bind 127.0.0.1]
| name | type | default | description |
|---|---|---|---|
| fen | string | required | FEN of the position with at least the board part |
| orientation | string | white | white or black |
| size | int | 360 | The width and height of the image |
| height | int | size | The height of the image, overrides size |
| width | int | size | The width of the image, overrides size |
| lastMove | string | (none) | The last move to highlight, e.g., f4g6 |
| check | string | (none) | A square to highlight for check, e.g., h8 |
| arrows | string | (none) | Draw arrows and circles, e.g., Ge6g8,Bh7, possible color prefixes: G, B, R, Y |
| squares | string | (none) | Marked squares, e.g., a3,c3 |
| coordinates | string | (none) | Coordinates: standard, shogi, janggi |
| colors | string | lichess-brown | Theme: wikipedia, lichess-brown, lichess-blue |
| css | string | standard_standard | Piece set CSS |
| background_image | string | (none) | Optional board background image (PNG, JPG, or SVG). If a filename ending in .svg, the SVG is embedded and scaled; if PNG/JPG, the image is embedded as a base64 data URI. Example: wood1.png or pattern.svg. |
| rotate_opponent | bool | false | If true, opponent pieces are rotated 180° (like OTB). |
https://backscattering.de/web-boardimage/board.svg?fen=5r1k/1b4pp/3pB1N1/p2Pq2Q/PpP5/6PK/8/8&lastMove=f4g6&check=h8&arrows=Ge6g8,Bh7&squares=a3,c3
web-boardimage is licensed under the AGPLv3+. See LICENSE.txt for the full license text.