Kazu documentation
Kazu 数 — Sudoku and grid number puzzles
Generate checked Sudoku and logic puzzles, read native rules and hints, and draw or embed playable boards.
Install
npm install @johnmorrisdotca/kazu
Start here
Entry points
| Import it | What it is | Size |
|---|---|---|
@johnmorrisdotca/Number-grid SVG · 18 exports | Kazu's drawing: a puzzle as SVG text, with the style that gives it its look, and where everything sits in it (so a page can tell which cell a finger is over). | 12.7 kB |
@johnmorrisdotca/Playable number grid · 17 exports | Kazu, played in a page: mountKazu draws a puzzle into any element and plays it by touch, mouse and keyboard, with a number pad, pencil marks, Undo, Hint, Check and a clock, and the words in English and Japanese. | 27.3 kB |
@johnmorrisdotca/Puzzle elements · 4 exports | 27.7 kB | |
@johnmorrisdotca/Register puzzle elements · 4 exports | Defines the <kazu-board> element on the page. | 27.7 kB |
@johnmorrisdotca/Shikaku rules · 33 exports | Shikaku shares Kazu's number puzzle package, with its own rectangle model. | 5.3 kB |
@johnmorrisdotca/Shikaku player · 9 exports | 7.3 kB | |
@johnmorrisdotca/Shikaku SVG · 2 exports | 2.2 kB | |
@johnmorrisdotca/Hitori rules · 25 exports | 4.5 kB | |
@johnmorrisdotca/Hitori player · 9 exports | 6.3 kB | |
@johnmorrisdotca/Hitori SVG · 2 exports | 0.8 kB | |
@johnmorrisdotca/Nurikabe rules · 18 exports | 2.2 kB | |
@johnmorrisdotca/Nurikabe player · 9 exports | 5.3 kB | |
@johnmorrisdotca/Nurikabe SVG · 2 exports | 0.8 kB | |
@johnmorrisdotca/Akari rules · 40 exports | 9.1 kB | |
@johnmorrisdotca/Akari player · 7 exports | 7.2 kB | |
@johnmorrisdotca/Akari SVG · 2 exports | 2.3 kB | |
@johnmorrisdotca/Juosan rules · 35 exports | 6.1 kB | |
@johnmorrisdotca/Juosan player · 9 exports | 5.6 kB | |
@johnmorrisdotca/Juosan SVG · 2 exports | 2.0 kB | |
@johnmorrisdotca/Loop rules · 38 exports | Loop uses a dedicated edge model and a single-loop constraint. | 11.2 kB |
@johnmorrisdotca/Loop player · 8 exports | 8.3 kB | |
@johnmorrisdotca/Loop SVG · 2 exports | 2.2 kB | |
@johnmorrisdotca/Masyu rules · 25 exports | 2.6 kB | |
@johnmorrisdotca/Masyu player · 6 exports | 4.5 kB | |
@johnmorrisdotca/Masyu SVG · 2 exports | 1.6 kB | |
@johnmorrisdotca/Yajilin rules · 28 exports | 3.2 kB | |
@johnmorrisdotca/Yajilin player · 6 exports | 5.1 kB | |
@johnmorrisdotca/Yajilin SVG · 2 exports | 1.8 kB | |
@johnmorrisdotca/Ripple Effect rules · 33 exports | Ripple Effect has its own room and spacing model. | 8.2 kB |
@johnmorrisdotca/Ripple Effect player · 6 exports | 6.6 kB | |
@johnmorrisdotca/Ripple Effect SVG · 2 exports | 1.0 kB | |
@johnmorrisdotca/Cross Sums rules · 44 exports | 10.4 kB | |
@johnmorrisdotca/Cross Sums player · 5 exports | 6.8 kB | |
@johnmorrisdotca/Cross Sums SVG · 2 exports | 1.5 kB | |
@johnmorrisdotca/Regions rules · 31 exports | 6.5 kB | |
@johnmorrisdotca/Regions player · 9 exports | 6.5 kB | |
@johnmorrisdotca/Regions SVG · 2 exports | 2.0 kB | |
@johnmorrisdotca/Heyawake rules · 36 exports | Heyawake has its own room model alongside Kazu's number puzzles. | 7.0 kB |
@johnmorrisdotca/Heyawake player · 4 exports | 5.8 kB | |
@johnmorrisdotca/Heyawake SVG · 2 exports | 1.9 kB | |
@johnmorrisdotca/Number-puzzle engines · 483 exports | Kazu 数: the Numbers family of grid puzzles. | 64.8 kB |
Guides
How-to
- Choose Sudoku and number-grid rulesKeep printed codes and variant constraints together.
- Use the dedicated logic-puzzle enginesSelect the right state model for rectangles, shading, lamps and loops.
- Separate answer checking, hints and proofTreat bounded search completion as part of a uniqueness result.
- Keep entries, notes and native progressStore the puzzle identity alongside the player state.
- Draw and embed the native playersUse each family mount and keep display choices separate from rules.
Explanation
- Codes, indices and edge modelsUnderstand why native codes cannot be exchanged across puzzle kinds.
- Architecture and checked generationKeep rules, seeded puzzles and players in their native layers.