web-boardimage's Introduction

web-boardimage

An HTTP service that renders chess board images.

Installation

Requires Python 3.7+.

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

Usage

pipenv run server [--port 8080] [--bind 127.0.0.1]

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., `Ge6g8,Bh7`, possible color prefixes: `G`, `B`, `R`, `Y`
squares	string	(none)	Marked squares, e.g., `a3,c3`
coordinates	bool	false	Show a coordinate margin
colors	string	lichess-brown	Theme: `wikipedia`, `lichess-brown`, `lichess-blue`

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

`GET /board.png` render a PNG

License

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

web-boardimage's People

Contributors

Stargazers

Watchers

web-boardimage's Issues

gif support

check out https://github.com/clarkerubber/python-game-gif

GET /board.png does not preserve orientation

Example:

https://backscattering.de/web-boardimage/board.svg?fen=r1b5/pp2q1k1/6p1/5pN1/5p2/8/PPPQ4/2KR1B2&lastMove=e5f4&orientation=black

vs.

https://backscattering.de/web-boardimage/board.svg?fen=r1b5/pp2q1k1/6p1/5pN1/5p2/8/PPPQ4/2KR1B2&lastMove=e5f4&orientation=black/board.png

Support Lichess-style blunder/mistake/inaccuracy symbols

This would be an appreciated feature!

support for crazyhouse FEN

like r3k2r/pp4pp/4Bp2/1p1p4/6P1/p1q1BPKP/PnP5/RQ2nB1R/PPPBnn where PPPBnn are the pocket pieces, or rnbqkbnr/pppppppp/8/8/8/2P5/PP1PPPPP/RNBQKBNR/ without pocket pieces (also failing atm)

how to run & use this script ?

i think i managed to install the packages on my Xubuntu 20.04 according to your readme, but then execution fails :

$ pipenv install
Installing dependencies from Pipfile.lock (9e16cc)…
  🐍   ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 0/0 — 00:00:00
To activate this project's virtualenv, run the following:
 $ pipenv shell

i did not do 'pinenv shell' but i did your command but i get this error :

$ pipenv run server [--port 8080] [--bind 127.0.0.1]
Error: the command server could not be found within PATH or Pipfile's [scripts].

i was not able to tackle this error : i can not find a way to install the command 'server' .. what am i missing ? Should a browser window open ? I see the URL https://backscattering.de/web-boardimage/board.svg?[...] and it works, but how should this be done at localhost ? For me, your readme lacks details ..

Recommend Projects

niklasf / web-boardimage Goto Github PK