https://github.com/oug-t/zsweep
A minimalist, keyboard-driven Minesweeper game played with Vim motions. Built with Svelte 5 (Runes) & TypeScript.
https://github.com/oug-t/zsweep
full-stack game javascript keyboard-first minesweeper nvim open-source puzzle svelte svelte-5 trading typescript user-interface user-management vim vim-motions web website
Last synced: 3 months ago
JSON representation
A minimalist, keyboard-driven Minesweeper game played with Vim motions. Built with Svelte 5 (Runes) & TypeScript.
- Host: GitHub
- URL: https://github.com/oug-t/zsweep
- Owner: oug-t
- License: agpl-3.0
- Created: 2026-01-04T05:28:41.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-01-26T00:20:39.000Z (3 months ago)
- Last Synced: 2026-01-26T10:43:10.846Z (3 months ago)
- Topics: full-stack, game, javascript, keyboard-first, minesweeper, nvim, open-source, puzzle, svelte, svelte-5, trading, typescript, user-interface, user-management, vim, vim-motions, web, website
- Language: Svelte
- Homepage: https://zsweep.com
- Size: 849 KB
- Stars: 36
- Watchers: 1
- Forks: 4
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Table of Contents
## About The Project
**zsweep** is a modern reimagining of Minesweeper, inspired by the "Monkeytype" aesthetic. It strips away the clutter of traditional Windows-95 clones to focus purely on speed, accuracy, and flow state.
Most Minesweeper clones are old-fashioned, click-heavy, and lack detailed stats. zsweep fixes this by providing:
- **Keyboard-first navigation** (Tab to restart, Esc for commands).
- **Advanced metrics** like 3BV/s (Bechtel's Board Benchmark per second).
- **A "Time Mode"** that challenges you to solve as many grids as possible in 15/30/60 seconds.
Whether you are a competitive sweeper or just looking for a zen break, zsweep is designed to feel "just right.
## Built With
- [![Svelte][svelte-badge]][svelte-url]
- [![TailwindCSS][tailwind-badge]][tailwind-url]
- [![Supabase][supabase-badge]][supabase-url]
- [![TypeScript][ts-badge]][ts-url]
## Getting Started
To get a local copy up and running for development or contribution, follow these steps.
### Prerequisites
npm
```sh
npm install npm@latest -g
```
### Installation
1. Clone the repo
```Bash
git clone https://github.com/oug-t/zsweep
```
2. Install packages
```Bash
npm install
```
3. Setup Environment Rename .env.example to .env.
```Bash
# If you don't have Supabase keys, the game will still run, but scores won't save.
```
4. Run the server
```Bash
npm run dev
```
## Features
### 🎮 Game Modes
- Time Mode: Clear as many grids as possible within a set time limit (15s, 30s, 60s).
- Standard Mode: Classic Minesweeper pacing and rules (9x9, 16x16, 30x16).
### 📊 Stats & Progression
- 3BV/s Tracking: Measures the theoretical difficulty of a board divided by time.
- Heatmap: Visualizes your activity over the last year (GitHub style).
- Estimated Mines Swept: Tracks your total career "damage."
### 🎨 Theming
- Built-in Command Palette (Cmd+K or Esc) to switch themes instantly.
- "Explosion" particle effects on game over.
## Contribution
- We are actively looking for contributors!
- Contributions are what make the open source community such an amazing place to learn, inspire, and create. Whether you are fixing a typo, optimizing the 3BV algorithm, or adding a new theme, your help is greatly appreciated.
- 🏆 Contributor Perk: All contributors who have a PR merged will be listed on the "About" page as a gratidude.
- If you have a suggestion that would make this better:
### Fork the Project
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
- Commit your Changes (git commit -m 'Add some AmazingFeature')
- Push to the Branch (git push origin feature/AmazingFeature)
- Open a Pull Request
- Good First Issues: Check out the Issues tab for tickets labeled good first issue if you are new to the codebase!
## License
Distributed under the AGPLv3 License.
See `LICENSE` for more information.
## Contact
Tommy Guo - tommyguo024@outlook.com
Project Link: https://github.com/oug-t/zsweep
## Acknowledgments
- Monkeytype for the visual inspiration and philosophy.
- Supabase for making the backend effortless.
- Lucide Icons for the beautiful SVG set.
## Star History
[contributors-shield]: https://img.shields.io/github/contributors/oug-t/zsweep.svg?style=flat
[contributors-url]: https://github.com/oug-t/zsweep/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/oug-t/zsweep.svg?style=flat
[forks-url]: https://github.com/oug-t/zsweep/network/members
[stars-shield]: https://img.shields.io/github/stars/oug-t/zsweep.svg?style=flat
[stars-url]: https://github.com/oug-t/zsweep/stargazers
[issues-shield]: https://img.shields.io/github/issues/oug-t/zsweep.svg?style=flat
[issues-url]: https://github.com/oug-t/zsweep/issues
[license-shield]: https://img.shields.io/github/license/oug-t/zsweep.svg?style=flat
[license-url]: https://github.com/oug-t/zsweep/blob/main/LICENSE
[svelte-badge]: https://img.shields.io/badge/Svelte-FF3E00?style=flat&logo=svelte&logoColor=white
[tailwind-badge]: https://img.shields.io/badge/TailwindCSS-06B6D4?style=flat&logo=tailwindcss&logoColor=white
[supabase-badge]: https://img.shields.io/badge/Supabase-3ECF8E?style=flat&logo=supabase&logoColor=white
[ts-badge]: https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=typescript&logoColor=white
[svelte-url]: https://svelte.dev
[tailwind-url]: https://tailwindcss.com
[supabase-url]: https://supabase.com
[ts-url]: https://www.typescriptlang.org
