https://github.com/mrozio13pl/sudoku-in-terminal
🧩 Sudoku game in terminal.
https://github.com/mrozio13pl/sudoku-in-terminal
cli console game ink puzzle react sudoku terminal
Last synced: 3 months ago
JSON representation
🧩 Sudoku game in terminal.
- Host: GitHub
- URL: https://github.com/mrozio13pl/sudoku-in-terminal
- Owner: mrozio13pl
- License: apache-2.0
- Created: 2024-05-30T14:18:56.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-14T17:11:45.000Z (5 months ago)
- Last Synced: 2025-01-10T04:56:03.621Z (4 months ago)
- Topics: cli, console, game, ink, puzzle, react, sudoku, terminal
- Language: TypeScript
- Homepage: https://npm.im/sudoku-in-terminal
- Size: 775 KB
- Stars: 14
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license
Awesome Lists containing this project
README
```md
__ __ __
____ __ __ /\ \ ___ /\ \/ \ __ __
/ ,__\ /\ \/\ \ \_\ \ / __`\ \ \ < /\ \/\ \
/\__, `\\ \ \_\ \/\ ,. \ /\ \_\ \ \ \ ^ \ \ \ \_\ \
\/\____/ \ \____/\ \____\\ \____/ \ \_\ \_\ \ \____/
\/___/ \/___/ \/___ / \/___/ \/_/\/_/ \/___/
# in terminal c:
```
# sudoku-in-terminal [](https://www.npmjs.com/package/sudoku-in-terminal)
Sudoku game working entirely within your terminal window. 🧩\
Built with Typescript on top of [Ink](https://github.com/vadimdemedes/ink) and [React](https://github.com/facebook/react).
## ✨ Features
* Easy to navigate sudoku board using either arrow keys or `HJKL`.
* Solver for your current game.
* Automatically detects mistakes.
* 4 levels of difficulty.
* Customizable settings.
* Stores settings, unfinished games in a cache file.
* Many helpful keybindings.
* Game Replays.
* Custom themes.
* Supports terminals without unicode support.
* Interactive and responsive.
## 📝 Requirements
* Node 18 or above.
* NPM or an alternative package manager.
## 🚀 Getting Started
Use NPM (or package manager of your choice) to download the game as a global package on your system:
```sh
npm i sudoku-in-terminal -g
```
Now to start it, just type in the console:
```sh
sudoku
# You might need to prefix it with npx.
```
> For more information run the game in your command line.
## 🛫 Roadmap
- [ ] Add tests.
- [ ] Improve readability of the code.
- [ ] Add more JSDocs.
- [ ] Cache validator.
- [ ] Allow arrow keys with __CTRL__ to skip occupied cells.
- [ ] Improve replays.
- [ ] CLI flags.
- [ ] More options for creating sudoku game.
- [ ] Customizable keystrokes.
- [ ] Update cache file before exiting.
## ❤ Support
Consider starring [my repo](https://github.com/mrozio13pl/sudoku-in-terminal) if you like this project. 🌟
## Versioning
This project follows [Semantic Versioning](https://semver.org) (SemVer).
## License
This project is licensed under the Apache License 2.0. See the [LICENSE](./license) file for details.