https://github.com/rlepigre/pzls

A javascript library for embedding handcrafted (variant) Sudoku puzzles in a web page.
https://github.com/rlepigre/pzls

javascript-library puzzle-game sudoku

Last synced: 13 days ago
JSON representation

A javascript library for embedding handcrafted (variant) Sudoku puzzles in a web page.

• Host: GitHub
• URL: https://github.com/rlepigre/pzls
• Owner: rlepigre
• License: mit
• Created: 2021-02-13T10:19:10.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-10-23T15:51:03.000Z (over 3 years ago)
• Last Synced: 2024-11-20T16:46:05.413Z (2 months ago)
• Topics: javascript-library, puzzle-game, sudoku
• Language: JavaScript
• Homepage: https://lepigre.fr/pzls/
• Size: 67.4 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
A javascript library for creating/solving handcrafted sudoku puzzles 

====================================================================

The `pzls` library (pronounced "puzzles") is a javascript library that can be

used to embed handcrafted (variant) sudoku puzzles into any web page.

Puzzles are specified using a simple Javascript object (could be specified by

a JSON file), and the grid is then generated using the library, including the

appropriate checking function (for a "check" button), which checks everything

(including the variant sudoku stuff like thermos).

The input format for puzzled is (roughly) documented in file `lib/pzls.js`.

The interface is in part inspired by the software used by Simon Anthony and

Mark Goodliffe of the [Cracking the Cryptic](https://www.youtube.com/channel/UCC-UOdK8-mIjxBQm_ot1T-Q)

Youtube channel.

Supported sudoku variants

-------------------------

The library currently supports the following variants:

- Sudoku grids of any size.

- Irregular sudoku grids.

- Thermo sudoku.

- Kropki sudoku.

We plan to support more in the future (at least XV sudoku. killer sudoku, and

sandwich sudoku).

Known issues

------------

The current version is definitely not perfect, but it is usable.

Here are a few known limitations:

- Probably not sable on mobile platforms (phones, tablets).

- Verification of thermo sudoku is incomplete when there are diagonal lines.

- All browser keyboard shortcuts are disabled (including Ctrl+R).

- Reloading the page reinitialises the puzzle.