README.md

Sudoku

This is a TypeScript library which gives you the tools for creating a Sudoku or Killer Sudoku game.

Examples

This is just a quick peek to get you started. Check out the API docs for the full documentation.

Initialize a Sudoku game

let game = new Sudoku<Tile<IGroup>, Group<ITile>>(Tile, Group);

While this might look overly complicated, it gives use great freedom to extend our tiles and group. For a Tile you might for example want to know if you have currently selected the tile. You may then extend the original Tile like so:

class CustomTile extends Tile<CustomGroup> {
    isActiveTile: boolean = false;
}
class CustomGroup extends Group<CustomTile> {
    isActiveGroup: boolean = false;
}
new Sudoku<CustomTile, CustomGroup>(CustomTile, CustomGroup);

Setup a board

There are currently two type of modes supported. Regular Sudoku, and Killer Sudoku.

Regular Sudoku

game.setupNormalSudoku(board);
// or
game.setupSudoku(board, GameModes.Normal /* 0 */);

board is an array of 81 values where falsy values represents empty cells.

Killer Sudoku

game.setupKillerSudoku(board);
// or
game.setupSudoku(board, GameModes.Killer /* 1 */);

board is an array with all the groups. Each group is an array where the first value is the sum of the group and the remaining values are the ID (0 based) of the cells that's part of the group.

Values

if (game.setValue(tile, 9)) {
    // successfully set the value 9 to the cell.
    // note that it was not necessarily a correct number, it might result in some tiles being invalid, including itself.
} else {
    // the cell was blocked (e.g. it has a given value).
}

While it may be tempting to simply set value on a Tile, calling Sudoku.setValue updates the invalid status of all tiles and group. You can of course choose to do this manually instead by calling Sudoku.updateInvalidTiles() and Sudoku.updateInvalidGroups().

Notes

tile.toggleNote(1);
tile.toggleNote(5);
tile.toggleNote(9);
tile.getNotes(); // [true, false, false, false, true, false, false, false, true];

tile.setInvalidNote(5, true);
tile.getNotes(); // [true, false, false, false, false, false, false, false, true];
tile.notes; // [true, false, false, false, true, false, false, false, true];

Again, while it might be tempting to simply use Tile.notes, as you can see above Tile.setInvalidNote does not update the notes array. Instead it updates a private array which is then used to calculate which notes are actually valid when calling Tile.getNotes(). This let's us get the note back again in case the value of another tile is removed again making the note valid.

NOTE: You generally don't need to bother with Tile.setInvalidNote, using Sudoku.setValue will keep this updated for you. I just used it here to prove a point.