Variants Guide

const engine = createEngine({ variant: "windoku" });
const game = engine.generatePuzzle("medium")!;
// play / solve / validate with `engine` — not top-level classic helpers

import { createEngine } from "@reetesh/sudoku-engine";
import type { MetaConstraint } from "@reetesh/sudoku-engine";
 
const engine = createEngine({ variant: "killer" }); // or "thermo" | "kropki"
const game = engine.generatePuzzle("easy");
if (!game?.metaConstraints) throw new Error("expected meta");
 
// Persist both puzzle AND metaConstraints in your save file / API
function saveGame(game: {
  puzzle: typeof game.puzzle;
  solution: typeof game.solution;
  meta: readonly MetaConstraint[];
}) {
  /* your storage */
}
 
const play = engine.withMeta(game.metaConstraints);
 
play.validateBoard(game.puzzle); // includes cage / thermo / kropki rules
play.getCandidates(game.puzzle, 0, 0);
play.solve(game.puzzle);
play.applyMove(/* … */); // houses + meta on the scoped engine

const samurai = createEngine({ variant: "samurai" });
const game = samurai.generatePuzzle("easy")!;
 
game.puzzle.length; // 21
// Many cells are permanently null (inactive). Do not force-fill them.
 
samurai.isBoardComplete(game.solution); // true — only playable cells matter
samurai.allCellCoordinates(); // full 21×21 canvas; filter with isPlayableCell if needed
 
import { isPlayableCell } from "@reetesh/sudoku-engine";
isPlayableCell(samurai.variant, row, col);

import { listVariants, getVariant } from "@reetesh/sudoku-engine";
 
listVariants().map((v) => v.id);
getVariant("hyper").clueRanges;