An HTTP service that renders chess board images
Python CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
LICENSE.txt
README.md
default.css
lichess-blue.css
lichess-brown.css
requirements.txt
server.py

README.md

web-boardimage

An HTTP service that renders chess board images.

Usage

python3 server.py [--port 8080] [--bind 127.0.0.1] [--css default.css]

Installation

Requires Python 3.4+.

sudo apt-get install python3-dev libffi-dev libxml2-dev libxslt1-dev libcairo2

pip install -r requirements.txt

HTTP API

GET /board.svg render an SVG

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
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. e6g8,h7
https://backscattering.de/web-boardimage/board.svg?fen=5r1k/1b4pp/3pB1N1/p2Pq2Q/PpP5/6PK/8/8&lastMove=f4g6&check=h8&arrows=e6g8,h7

example board image

GET /board.png render a PNG

License

web-boardimage is licensed under the AGPLv3+. See LICENSE.txt for the full license text.