Package Exports

@flynnhillier/chessboard-image-gen
@flynnhillier/chessboard-image-gen/dist/index.js
@flynnhillier/chessboard-image-gen/dist/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@flynnhillier/chessboard-image-gen) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Chessboard image generator

Generate PNG images of chessboard positions, based on specified chess notation.

Chess notation currently supported:

Configure outputted image with a selection of configuration options:

Size of image
Colour of board
Orientation of board

Installation

Using your preffered package manager:

pnpm:
pnpm install @flynnhillier/chessboard-image-gen

npm:
npm i @flynnhillier/chessboard-image-gen

Usage

Load FEN

import { ChessBoardImage } from "@flynnhillier/chessboard-image-gen";

//Wrap in an asyncrinous function so we can call within our top level.
async function main() {
  const ci = new ChessBoardImage();
  await ci.fromFEN(
    "rnbqkbnr/2pppQpp/8/1p6/2B1PP2/p7/PPPP2PP/RNB1K1NR b KQkq - 0 6",
    "myChessBoardImage"
  );
}

main();

Inspiration

This repo is based off of @andyruwruw's package chess-image-generator . I have rewritten aspects of it, as the package no longer seems to be maintained and I had issues installing the package in a typescript ecosystem.

Example output

example