https://github.com/maxpaulus43/go-sweep

minesweeper cli
https://github.com/maxpaulus43/go-sweep

Last synced: 21 days ago
JSON representation

minesweeper cli

• Host: GitHub
• URL: https://github.com/maxpaulus43/go-sweep
• Owner: maxpaulus43
• License: gpl-3.0
• Created: 2023-11-26T07:36:48.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-29T04:32:05.000Z (about 1 year ago)
• Last Synced: 2024-09-06T01:12:56.577Z (5 months ago)
• Language: Go
• Size: 2.4 MB
• Stars: 48
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• charm-in-the-wild - go-sweep - Minesweeper in the terminal. (_built with Bubble Tea_) (Applications / Games)

README

        
# go-sweep: Minesweeper in your terminal

I needed to learn go in preparation for advent of code this year, so I thought I would make one of my favorite games using go! I also wanted to learn how to make terminal UI apps, so I opted to use the [bubbletea tui framework](https://github.com/charmbracelet/bubbletea) to accomplish that. For future reference, this whole project took about 3 nights to accomplish.

## To Install and Run

1. Make sure your $GOPATH is set

1. `go install github.com/maxpaulus43/go-sweep@latest`

1. `go-sweep`

## Demo

### emoji view

![go-sweep gif](./go-sweep.gif)

### ascii view

![go-sweep ascii gif](./go-sweep-ascii.gif)

## To Run

1. `go build .`

2. `./go-sweep`

### Options

- `-w 30`: width of the minefield. default 30

- `-h 30`: height of the minefield. default 30

- `-n 90`: number of mines. default 99

- `-e`: use emoji characters instead. by default, uses ascii to render cells

Please feel free to make an issue if you find any problems with the game! Sweep on!