kengen
TypeScript icon, indicating that this package has built-in type declarations

0.1.3 • Public • Published

KenKen

This is a library for generating and rendering KenKen puzzles. Puzzle generation is seedable and highly customizable. Rendering can also be customized.

KenKen are mathematical puzzles similar to Sudoku. They must include exactly one of each number in each column and row while also solving the simple math problems arranged throughout the board.

This library generates KenKen puzzles of any size and is capable of rendering them as images via an HTMLCanvasElement.

Usage

Generate a 4x4 KenKen puzzle.
import { KenKenGenerator } from 'kengen'
 
const puz = KenKenGenerator.generate({ size: 4 })
Generate a 6x6 KenKen puzzle with a specific seed and more math operations
import { KenKenGenerator, MathOperators } from 'kengen'
 
const puz = KenKenGenerator.generate({ 
  size: 6, 
  seed: 1069, 
  operations: [
    MathOperators.ADDITION, 
    MathOperators.SUBTRACTION, 
    MathOperators.MULTIPLICATION, 
    MathOperators.DIVISION] 
})
Render a 7x7 to a PNG

Uses the node-canvas library.

import { KenKenGenerator, Renderer } from 'kengen'
import { createCanvas } from 'canvas'
import * as fs from 'fs'
 
const puz = KenKenGenerator.generate({ size: 7 })
const canvas = createCanvas(100, 100)
Renderer.renderCanvas(puz, canvas.getContext('2d'), { withSolution: true })
const canvasBuffer = canvas.toBuffer()
fs.writeFileSync('kenken-7x7.png', canvasBuffer)

Output

4x4

4x4 Puzzle 4x4 Puzzle Solution

5x5

5x5 Puzzle 5x5 Puzzle Solution

6x6

6x6 Puzzle 6x6 Puzzle Solution

7x7

7x7 Puzzle 7x7 Puzzle Solution

8x8

8x8 Puzzle 8x8 Puzzle Solution

9x9

9x9 Puzzle 9x9 Puzzle Solution

10x10

10x10 Puzzle 10x10 Puzzle Solution

TODO

  • Allow more complex math constraints to be imposed
  • Test the various types of math operations
  • Generate cell and math distributions
  • Add CLI interface

Package Sidebar

Install

npm i kengen

Weekly Downloads

2

Version

0.1.3

License

MIT

Unpacked Size

543 kB

Total Files

65

Last publish

Collaborators

  • wyattis