. ▗▄▄▄▖▗▞▀▚▖ ▄▄▄ ▄▄▄▄ ▗▄▄▖▄ ▄ ▗▞▀▚▖▗▞▀▚▖▄▄▄▄ ▗▞▀▚▖ ▄▄▄ . . █ ▐▛▀▀▘█ █ █ █ ▐▌ █ ▄ █ ▐▛▀▀▘▐▛▀▀▘█ █ ▐▛▀▀▘█ . . █ ▝▚▄▄▖█ █ █ ▝▀▚▖█▄█▄█ ▝▚▄▄▖▝▚▄▄▖█▄▄▄▀ ▝▚▄▄▖█ . . █ ▗▄▄▞▘ █ . . ▀ . Customizable Minesweeper TUI in Go
TermSweeper is a TUI minesweeper game built with Go and the Bubble Tea TUI framework. It provides a clean, keyboard-driven interface, theming support, and a small set of configurable options.
- Terminal UI using Bubble Tea and Lip Gloss
- Classic Minesweeper mechanics: reveal, flag, and auto-reveal
- Timer, win/loss detection, and keyboard controls
- Configurable board size, mine count, and display characters
- Multiple color themes (see the Themes directory)
Prerequisites: Go 1.20 or newer
Clone the repository and run locally:
git clone https://github.com/yourusername/termsweeper.git
cd termsweeper
go run main.goOr build a standalone binary:
go build -o termsweeper ./
./termsweeperRuntime debug flags:
--debug: enable debug logging--debug-file <path>: write debug logs to the specified file
Configuration is loaded at startup (see src/config.go). An example config is provided at Themes/example-config.yaml.
Configurable items include board rows/columns, mine count, characters for mines/flags/unrevealed cells, and many color settings for cells and UI elements.
Use arrow keys or Vim-keys keys to move the cursor. Primary controls:
R: Reset the current boardF: Toggle a flag on the highlighted cellQ: Quit the game (or return to the menu when in-game)Space/Enter: Reveal the highlighted cell (or auto-reveal neighbors when applicable)
Theme files are stored in the Themes directory; several presets are included (catppuccin, dracula, gruvbox, rose-pine, tokyo-night).
Contributions are welcome! Open issues or pull requests for bugs, improvements, or new themes. If you prefer, feel free to fork the project and customize it for your needs.
This project is licensed under the MIT License, see the LICENSE file for details.