Skip to content

Commit

Permalink
#528 Restore addition about pgnPuzzle
Browse files Browse the repository at this point in the history
  • Loading branch information
mliebelt committed Apr 17, 2024
1 parent bcaa53e commit b5842b8
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

* [chess.js](https://github.com/jhlywa/chess.js) Base library to model chess in JavaScript
* [Chessground](https://github.com/ornicar/chessground) The chessboard used by lichess.org
* [pgn-reader](https://www.npmjs.com/package/@mliebelt/pgn-reader) Backend for the viewer (part of this repository, but separately published)
* [pgn-reader](https://www.npmjs.com/package/@mliebelt/pgn-reader) Backend for the viewer (former part of this repository, now separate repo)
* [pgn-parser](https://github.com/mliebelt/pgn-parser) My own parser based on [peggy](https://github.com/peggyjs/peggy) (formerly pegjs)

See the section Acknowledgments for more supporting libraries.
Expand All @@ -22,7 +22,7 @@ that demonstrates all parameters in a running example.

## Getting Started

The easiest way to use it is to install it by using NPM: `npm install @mliebelt/pgn-viewer`. You will find there the diretory `lib` that contains everything. Copy that onto your webserver.
The easiest way to use it is to install it by using NPM: `npm install @mliebelt/pgn-viewer`. You will find there the directory `lib` that contains everything. Copy that onto your webserver.

### Example Screenshots

Expand Down Expand Up @@ -57,6 +57,7 @@ There are four different kind of usages:
* `PGNV.pgnEdit` is a superset of pgnView, that allows to additional add variations, change the order of main line and variations, and other kind of interactions like adding comments, PGN notation elements, ...
* `PGNV.pgnBoard` will just show a position without any interaction possible.
* `PGNV.pgnPrint` will just show a whole chess game, without any interaction possible.
* `PGNV.pgnPuzzle` lets you solve a puzzle. If you play the right move of the underlying pgn, the opponent's move is played automatically and it is your turn again. Only the already played moves are shown to the user. The mode is new and the plan is to develop it further (e.g. giving hints)

There is at the moment no way to save a game that was edited in `pgnEdit` mode. But you may at least copy the whole notation, and insert it again in the HTML code of your web page.

Expand Down Expand Up @@ -153,7 +154,7 @@ We use the following libraries in the implementation:
* [Chessground](https://github.com/ornicar/chessground) The chessboard used by lichess.org
* [Mousetrap](https://craig.is/killing/mice) Binds keys to actions in the UI
* [roddeh-i18n](http://i18njs.com) Internationalization (== i18n) library to translate chess into current 18 languages. Strings are inlined in the library.
* [timer.ts.old](https://github.com/fschaefer/Timer.js) Small timer for automatic moves
* [timer.ts](https://github.com/fschaefer/Timer.js) Small timer for automatic moves
* [FontAwesome](http://fontawesome.io/) Nice icon font used for some buttons
* [PGN Specification](https://github.com/mliebelt/pgn-spec-commented/blob/main/pgn-specification.md) PGN (Portable Game Notation) specification
* [NAG Specification](http://en.wikipedia.org/wiki/Numeric_Annotation_Glyphs) Definition of the NAGs (Numeric Annotation Glyphs)
Expand Down

0 comments on commit b5842b8

Please sign in to comment.