{"id":17084404,"url":"https://github.com/niklasf/web-boardimage","last_synced_at":"2025-04-07T18:13:04.130Z","repository":{"id":12737132,"uuid":"72642657","full_name":"niklasf/web-boardimage","owner":"niklasf","description":"An HTTP service that renders chess board images","archived":false,"fork":false,"pushed_at":"2024-12-23T23:02:13.000Z","size":206,"stargazers_count":76,"open_issues_count":1,"forks_count":19,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-31T17:18:11.803Z","etag":null,"topics":["chess","lichess","png","svg","webservice"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/niklasf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"niklasf"}},"created_at":"2016-11-02T13:30:46.000Z","updated_at":"2025-03-03T13:07:42.000Z","dependencies_parsed_at":"2024-05-04T15:23:12.510Z","dependency_job_id":"b0bc405c-ae9f-462f-9509-4bd8945cb043","html_url":"https://github.com/niklasf/web-boardimage","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niklasf%2Fweb-boardimage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niklasf%2Fweb-boardimage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niklasf%2Fweb-boardimage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/niklasf%2Fweb-boardimage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/niklasf","download_url":"https://codeload.github.com/niklasf/web-boardimage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247704571,"owners_count":20982298,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chess","lichess","png","svg","webservice"],"created_at":"2024-10-14T13:07:03.404Z","updated_at":"2025-04-07T18:13:04.097Z","avatar_url":"https://github.com/niklasf.png","language":"Python","funding_links":["https://github.com/sponsors/niklasf"],"categories":[],"sub_categories":[],"readme":"web-boardimage\n==============\n\nAn HTTP service that renders chess board images.\n\nInstallation\n------------\n\nRequires Python and poetry:\n\n```\nsudo apt-get install python3-dev libffi-dev libxml2-dev libxslt1-dev libcairo2\npoetry install\n```\n\nUsage\n-----\n\n```\npoetry run python server.py [--port 8080] [--bind 127.0.0.1]\n```\n\nHTTP API\n--------\n\n### `GET /board.svg` render an SVG\n\nname | type | default | description\n--- | --- | --- | ---\n**fen** | string | required | FEN of the position with at least the board part\n**orientation** | string | white | `white` or `black`\n**size** | int | 360 | The width and height of the image\n**lastMove** | string | *(none)* | The last move to highlight, e.g., `f4g6`\n**check** | string | *(none)* | A square to highlight for check, e.g., `h8`\n**arrows** | string | *(none)* | Draw arrows and circles, e.g., `Ge6g8,Bh7`, possible color prefixes: `G`, `B`, `R`, `Y`\n**squares** | string | *(none)* | Marked squares, e.g., `a3,c3`\n**coordinates** | bool | *false* | Show a coordinate margin\n**colors** | string | lichess-brown | Theme: `wikipedia`, `lichess-brown`, `lichess-blue`\n\n```\nhttps://backscattering.de/web-boardimage/board.svg?fen=5r1k/1b4pp/3pB1N1/p2Pq2Q/PpP5/6PK/8/8\u0026lastMove=f4g6\u0026check=h8\u0026arrows=Ge6g8,Bh7\u0026squares=a3,c3\n```\n\n![example board image](https://backscattering.de/web-boardimage/board.svg?fen=5r1k/1b4pp/3pB1N1/p2Pq2Q/PpP5/6PK/8/8\u0026lastMove=f4g6\u0026check=h8\u0026arrows=Ge6g8,Bh7\u0026squares=a3,c3)\n\n### `GET /board.png` render a PNG\n\nLicense\n-------\n\nweb-boardimage is licensed under the AGPLv3+. See LICENSE.txt for the full\nlicense text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fniklasf%2Fweb-boardimage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fniklasf%2Fweb-boardimage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fniklasf%2Fweb-boardimage/lists"}