Documentation

Sudoku Engine Documentation

Official guides for @reetesh/sudoku-engine 3.x — install, play loop, Killer/Thermo/Kropki/Samurai variants, batch generation, and API reference. By Reetesh Kumar.

npm install @reetesh/sudoku-engine· v3.0.0

Getting started

Getting Started

Install @reetesh/sudoku-engine, generate a classic puzzle, and wire variant engines in minutes.

Read guide →

Getting started

Overview

Mental model — Board, PuzzleEngine, meta constraints, and when to use BatchEngine.

Read guide →

Getting started

Play Loop

Session pattern for moves, hints, cell display state, and importing string puzzles.

Read guide →

Guides

Variants Guide

Killer, Thermo, Kropki meta constraints, Samurai playable cells, and preset listing.

Read guide →

Guides

Batch & Daily

Seeded batch generation, daily puzzles, and global seed patterns.

Read guide →

Guides

Migration (2.1 → 3.0)

Upgrade checklist for new variants, meta constraints, and API changes.

Read guide →

Guides

Troubleshooting

Fix null generation, meta constraint errors, and common integration mistakes.

Read guide →

Reference

API Reference

Function signatures, types, PuzzleEngine methods, and house builders.

Read guide →

Reference

Architecture

House composition, custom variant definitions, and solver internals.

Read guide →

Reference

Roadmap

Shipped features and planned work for @reetesh/sudoku-engine.

Read guide →

Changelog and examples live in the GitHub docs folder.

Documentation

Sudoku Engine Documentation

Official guides for @reetesh/sudoku-engine 3.x — install, play loop, Killer/Thermo/Kropki/Samurai variants, batch generation, and API reference. By Reetesh Kumar.

npm install @reetesh/sudoku-engine· v3.0.0