Package Exports

pgn-viewer
pgn-viewer/dist/index.js

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 (pgn-viewer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Pgn Viewer

This library is an advanced tool for working with chess games and their visualization in web applications. It is based on lichess-pgn-viewer, a library by Thibault Duplessis and other contributors, developed for the lichess.org website.

Features

Visualization of chess boards with interactive capabilities.
Navigation through game moves in PGN format.
Support for FEN to display specific game states.
Customization of the chess board's appearance and behavior.
Analysis and rendering of PGN files.

Installation

To install the library, use npm or yarn:

npm i pgn-viewer
yarn add pgn-viewer

Usage Example

import { PgnViewer } from 'pgn-viewer';

const pgnViewer = new PgnViewer({
  pgn: 'Your PGN text here',
  // other options...
});

Licensing

This library is open-source software licensed under the GPL-3.0-or-later license. This means it is based on lichess-pgn-viewer, which is also distributed under the GPL-3.0-or-later license. All derivative work must comply with the terms of this license.

Acknowledgements

Special thanks to Thibault Duplessis and the lichess.org team for their contribution to the chess community. The library utilizes chessground, chessops, and other dependencies to provide its functionality.

Support

If you have any questions or suggestions, please open an issue in the GitHub repository.

Contact

For further information, email saynschuman@gmail.com