knightstour 1.0.2 → 1.0.3

package/README.md

@@ -0,0 +1,115 @@
+```
+# KnightsTour
+
+A flexible **Knight's Tour** game engine in JavaScript/TypeScript.  
+Supports single-player (Open/Closed tours) and multiplayer (Co-op/Versus) modes, with built-in move validation, undo, hints, and automated tour generation.
+
+---
+
+## Installation
+
+```bash
+npm install knightstour
+```
+
+or with Yarn:
+
+```bash
+yarn add knightstour
+```
+
+---
+
+## Usage
+
+```ts
+import KnightsTour from "knightstour";
+
+// Create a new game
+const game = new KnightsTour({
+  rows: 8,
+  cols: 8,
+  players: [
+    { name: "Alice", color: "red", moveIndexes: [] },
+    { name: "Bob", color: "blue", moveIndexes: [] }
+  ],
+  gameMode: "Co-op", // Open, Closed, Versus, Co-op
+  disabledIndexes: [0, 7] // optional blocked cells
+});
+
+// Make a move
+game.move(10);
+
+// Undo last move
+game.undo();
+
+// Get the next available moves for current player
+const nextMoves = game.getAvailableMovesFor(game.turnIndex);
+console.log(nextMoves);
+
+// Reset the game
+game.reset();
+```
+
+---
+
+## API
+
+### `new KnightsTour(config?: KnightsTourConfig)`
+
+- `rows` – number of rows (default: 6)
+- `cols` – number of columns (default: 5)
+- `players` – array of player objects:
+  ```ts
+  {
+    name: string;
+    color: string;
+    moveIndexes: number[];
+    CPU?: boolean; // optional
+  }
+  ```
+- `gameMode` – `"Open" | "Closed" | "Co-op" | "Versus"` (default depends on player count)
+- `disabledIndexes` – array of blocked cell indices
+
+---
+
+### Methods
+
+- `move(index: number): boolean` – Move the current player to the given index
+- `undo(): void` – Undo the last move
+- `getAvailableMovesFor(playerIndex: number): number[]` – Get valid moves for a player
+- `reset(): void` – Reset the game to initial configuration
+- `updateBoard(autoMove?: boolean): void` – Refresh the board and calculate next moves
+- `hint(): void` – Suggest and execute the best move for the current player
+- `solve(increment?: number): void` – Attempt to solve the tour (single-player)
+- `generate(increment?: number): void` – Attempt to generate a valid tour
+
+---
+
+### Properties
+
+- `rows`, `cols` – board dimensions
+- `players` – current players with their moves
+- `turnIndex` – index of current player
+- `cells` – array of cell objects for rendering
+- `state` – current game state (e.g., `"Game Over"`, `"Alice's Turn"`)
+- `solved` – boolean indicating if a tour is completed
+- `generated` – boolean indicating if a tour was generated
+- `allMoveIndexes` – flattened move history of all players
+
+---
+
+## TypeScript Support
+
+Type definitions are included. Importing in TypeScript will give full IntelliSense support.
+
+```ts
+import KnightsTour from "knightstour";
+```
+
+---
+
+## License
+
+MIT © Puzzookie
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knightstour",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "",
   "main": "index.js",
   "types": "index.d.ts",