VIMazing Sudoku
-
-
+ {gameStatus === 'waiting' && (
+
+ )}
- {gameStatus === "game-won" && (
-
🎉 Score: {scoreManager.finalScore?.toLocaleString()}
+
+
+ {gameStatus === 'game-won' && (
+
+
You Won!
+
Score: {scoreManager.finalScore} / 1000
+
Time: {Math.floor(scoreManager.timeValue / 1000)}s
+
)}
);
}
```
-> **Note:** You must manually import the CSS file. The package exports styles but does not auto-import them, giving you control over when and how styles are loaded.
+> **Note:** You must manually import `game.css` for styling.
---
-## VIM Modal Editing
+## API Reference
-VIMazing Sudoku follows VIM's modal editing philosophy with strict insert/replace semantics:
+### `useGame(options?, platformHook?)`
-### Navigation Mode (default)
+Main orchestrator hook that composes all game functionality.
+
+#### Options
+
+```typescript
+type GameOptions = {
+ difficulty?: 'easy' | 'medium' | 'hard'; // Default: 'easy'
+ timeLimit?: number; // In seconds, default: 600 (10 min)
+ removedCells?: number; // Override difficulty default
+};
+```
+
+**Difficulty Defaults:**
+- `easy`: 25 cells removed (~56 givens)
+- `medium`: 40 cells removed (~41 givens)
+- `hard`: 50 cells removed (~31 givens)
+
+**Examples:**
+```typescript
+// Default configuration
+useGame()
+
+// Hard difficulty with defaults
+useGame({ difficulty: 'hard' })
+
+// Custom puzzle size
+useGame({ removedCells: 30 })
+
+// Custom everything
+useGame({
+ difficulty: 'hard',
+ removedCells: 45,
+ timeLimit: 480 // 8 minutes
+})
+```
+
+#### Returns: GameManager
+
+```typescript
+type GameManager = {
+ // DOM Reference
+ containerRef: RefObject