Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fedeztk/sku
Simple TUI written in go to play sudoku in the terminal
https://github.com/fedeztk/sku
cli command-line go sudoku tui
Last synced: 2 months ago
JSON representation
Simple TUI written in go to play sudoku in the terminal
- Host: GitHub
- URL: https://github.com/fedeztk/sku
- Owner: fedeztk
- License: mit
- Created: 2022-06-06T16:10:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-10T16:36:23.000Z (about 2 years ago)
- Last Synced: 2024-09-06T01:13:24.263Z (5 months ago)
- Topics: cli, command-line, go, sudoku, tui
- Language: Go
- Homepage:
- Size: 26.4 KB
- Stars: 70
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
- charm-in-the-wild - sku - Sudoku on the CLI. (_built with Bubble Tea_) (Applications / Games)
README
# sku
Simple TUI written in go to play sudoku in the terminal
[](https://github.com/fedeztk/sku/tree/master/.github/workflows/go.yml) [](https://github.com/fedeztk/sku/tree/release/.github/workflows/deploy.yml) [](https://aur.archlinux.org/packages/sku-git) [](https://goreportcard.com/report/github.com/fedeztk/sku)
## Table of Contents
[Usage](#orgfa2aa9c) -
[Features](#org26baa6c) -
[Testing](#org2744438)
sku is a simple TUI for playing sudoku inside the terminal. It uses the awesome [bubbletea](https://github.com/charmbracelet/bubbletea) TUI library for the UI.
Screenshots [here](#org26baa6c)
> Disclaimer: there are probably many other sudoku TUIs around with all kind of features that sku does not have. PRs are welcomed but it is generally a better idea to just use those programs, since adding some features, like a pencil mode used to annotate the sudoku, would require too much effort.
# Usage
- Install `sku`:
With the `go` tool:
```sh
go install github.com/fedeztk/sku/cmd/sku@latest
```
**Or** from source:
```sh
# clone the repo
git clone https://github.com/fedeztk/sku.git
# install manually
make install
```
In both cases make sure that you have the go `bin` directory in your path:
```sh
export PATH="$HOME/go/bin:$PATH"
```
If you are an Arch user there is also an AUR package available:
```sh
paru -S sku-git
```
- Run it interactively:
```sh
sku # use default mode (easy)
```
For more information about version and modes check the help (`sku -h`)
# Features
- Minimal/clean interface, only displays the board, the help and the game state (timer and remaining cells). Cursor position is marked with green. Greyed cells are unmodifiable (the base of the sudoku); when the cursor is under those cells it will darken
- Game check:
- when the last cell is filled, `sku` will perform a check of the sudoku:
- if it is correct, an animation will let you know that you won the game
https://user-images.githubusercontent.com/58485208/172200661-78ce055f-b5b9-44aa-bf4d-a27e9f8fce85.mp4
- otherwise it will color with red the errors
- Simple keys to interact with the puzzle:
- moving around: use the arrows or the vim motion keys, as preferred
- setting a cell: just press the desired number
- unsetting a cell: press spacebar or enter
- toggle help: press the question mark
- quit: you can quit anytime by pressing esc or q
- Check the version with `sku -v`
- Get the help menu with `sku -h`
- Set a sudoku mode with `sku MODE`. Valid MODEs are: easy, medium, hard and expert (also displayed with `-h` flag)
# Testing
Development is done through `docker`, build the container with:
make docker-build
Check that the build went fine:
docker images | grep sku
Test it with:
make docker-run
Pre-built Docker image available [here](https://github.com/fedeztk/sku/pkgs/container/sku)