Skip to content
Really Him edited this page Apr 29, 2026 · 1 revision

Welcome to the GitHub Minesweeper wiki!

Minesweeper is a classic computer game popularized most famously by Microsoft Minesweeper (no affiliation or endorsement with the current repo), and it was a fixture in many households, as it was shipped with Windows PCs up until Windows 8. The game itself, however, is not an exclusive Microsoft property, and many variations have existed (see https://en.wikipedia.org/wiki/Minesweeper_(video_game) for more information).

For many users, it's a very enjoyable game, and the size of the game board can be scaled up arbitrarily, which enables some extremely challenging games.

For other people, they may not be familiar with the game at all.

This repo implements a standard, basic version of minesweeper, currently with a 9x9 board available. If users are interested, I would be happy to offer other sizes of game boards to cater to varying degrees of difficulty.

This game is part of a series of GitHub-native, in-repo games that I am developing. These projects provide the opportunity to learn a lot about how to navigate GitHub's infrastructure, and I enjoy the challenge of trying to create an interactive experience given the limited resources the platform provides for that purpose. I will use this wiki to discuss any interesting technical or operational decisions that I made while developing this iteration of minesweeper - and why, for instance, I decided to use an external service (Cloudflare worker) to manage the gameplay interactions as opposed to relying only on GitHub Actions workflows.

I hope you enjoy this game and I'm happy to discuss any related topics or answer any questions, so feel free to open a thread in the Discussions tab.

As mentioned in the README, the main branch of this repo does not actually contain the majority of the source code. That is because I like to treat the main README as a "UI" for the game itself - and if I launched a computer game, I wouldn't expect to see a bunch of test suites or internal logic directly exposed in the primary UI. However, for anyone who's interested, the full source code does live on develop, although it may be migrated to a separate (public) repository if this two-branch model proves to be unmaintainable, which it almost certainly will.

How to Support This Project

The best way to support this project is to visit my GitHub sponsorship page and consider becoming a sponsor. I encourage people to join at the $1/month tier - that's more than enough to show your support, and it will help me to continue to invest my time and money into these projects.

Clone this wiki locally