Create PIL images from chess Fen strings
Project description
About
FenToBoardImage takes a Fen string representing a Chess position, and renders a PIL image of the resulting position.
You can customize:
- the size and color of the board
- piece sprites
- black or white perspective
Installation
Install the package using pip
$ pip install fenToBoardImage
Then import the fenToImage and loadPiecesFolder functions and use them as follows:
from fenToBoardImage import fenToImage, loadPiecesFolder
boardImage = fenToImage(
fen="rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1",
squarelength=100,
pieceSet=loadPiecesFolder("./pieces"),
darkColor="#D18B47",
lightColor="#FFCE9E"
)
In order to load a piece set, the pieces must follow this file structure, and must be a .png:
-piece_set_name
-white
- Knight.png
- Rook.png
- Pawn.png
- Bishop.png
- Queen.png
- King.png
-black
- Knight.png
- Rook.png
- Pawn.png
- Bishop.png
- Queen.png
- King.png
Usage
The fenToBoardImage has these parameters:
fen: str
Fen string representing a position
squarelength: int
the length of one square on the board
resulting board will be 8 * squarelength long
pieceSet: loadPiecesFolder
the piece set, loaded using the loadPiecesFolder function
darkColor: str
dark square color on the board
lightColor: str
light square color on the board
flipped: boolean
default = False
Whether to flip to board, and render it from black's perspective
The loadPiecesFolder has one parameter:
path: str
Loads piece set located at the path provided.
Dependencies
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for fenToBoardImage-0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76d3383a43ccb2d6066164e93742cd957987d2981e0b30014b6fb87bef6b9ef4 |
|
MD5 | 82b15b23c85de7a7977e24b71fe89e73 |
|
BLAKE2b-256 | 2a61388a847c62354fe65ea6bf77ba857dbaca833f62a418788e1448227a82ed |