Documentation of pgn-viewer

About

pgn-viewer was born as the third or fourth attempt to get a nice PGN viewer for our chess club web site. PGN stands for Portable Game Notation which was born in the late 80s, early 90s of the last century. I provided some of the translations there ...

I first started using pgn4web and others as part of our Wordpress Installation, but I had difficulties here and there. At the end, I wanted to have a viewer that was at least as nice as the one from chess.com (later: from lichess.org).

Implementation

The implementation contains the following parts:

Chess.js: Small JavaScript library that provides the base functionality for playing chess (but without a board).
Chessground: Builds the missing building blocks for displaying a chess board, with some functions: Moving pieces, some animations, ... This board was developed for lichess.org.
Peggy: Parser Generator for JavaScript to read pgn notation.
pgn-viewer:
- pgn-parser: module to parse the games.
- pgn-reader: module to model the game.
- pgn-writer: module to write the games.
- pgn-viewer: module to show the game in a website.
It allows currently the following interfaces: pgnBoard, pgnPrint, pgnView, pgnEdit, pgnPuzzle.

How To & Support

To start with pgn-viewer, you have to do the following steps:

Download the current sources or the distro from below or build it on you own: `npm install; npm build`. The directory `lib` of the module `pgn-viewer` is what you need.
Fill the head of your HTML file with the relevant definitions, examples are included in the distro in the directory examples.
Define in the body 2 parts:
- A div section with a unique ID.
- A script section that defines which API of the viewer should be used. See the examples section how to do it.
Fill the configuration of the pgn-viewer with the relevant aspects: starting position, moves, theme, piece style, size, ... You may use the configuration builder to try out which options are possible.

pgn-viewer

Version 1.6.11

ML

About

Implementation

How To & Support

Downloads

References