https://github.com/kaamkiya/gg

:space_invader: Games you can play in your terminal written in Go
https://github.com/kaamkiya/gg

cli cli-game cli-games game games go go-app go-tui golang golang-application good-first-issue good-first-pr hacktoberfest tui tui-game

Last synced: about 2 months ago
JSON representation

:space_invader: Games you can play in your terminal written in Go

• Host: GitHub
• URL: https://github.com/kaamkiya/gg
• Owner: Kaamkiya
• License: unlicense
• Created: 2024-11-02T00:54:13.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-06-08T12:34:12.000Z (4 months ago)
• Last Synced: 2025-06-08T13:31:44.785Z (4 months ago)
• Topics: cli, cli-game, cli-games, game, games, go, go-app, go-tui, golang, golang-application, good-first-issue, good-first-pr, hacktoberfest, tui, tui-game
• Language: Go
• Homepage:
• Size: 496 KB
• Stars: 53
• Watchers: 1
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          


gg



games you can play in your terminal!







Report a bug or request a feature





[![License: Unlicense](https://img.shields.io/github/license/Kaamkiya/gg)](https://unlicense.org)

[![Open issue count](https://img.shields.io/github/issues/Kaamkiya/gg)](https://github.com/Kaamkiya/gg/issues)

[![Open pull request count](https://img.shields.io/github/issues-pr/Kaamkiya/gg)](https://github.com/Kaamkiya/gg/pulls)

[![Latest release](https://img.shields.io/github/v/tag/Kaamkiya/gg)](https://github.com/Kaamkiya/gg/releases)

[![Go report card](https://goreportcard.com/badge/github.com/Kaamkiya/gg)](https://goreportcard.com/report/github.com/Kaamkiya/gg)

## About The Project

![A recording of a maze game being played, then the dodger game.](assets/gg.gif)

![A screenshot of 2048, dodger, and a maze running in separate windows.](assets/gameplay.png)

I like to play video games, probably like you. But I prefer smaller, more minimal games. And I figured the best way to keep games minimal is to play them from the CLI!

And as a developer, that's perfect because half of my computer time is spent in a terminal.

Enjoy playing terminal games :)

### Built With

- [Go](https://go.dev)

- [Charm libraries](https://charm.sh)

## Getting Started

This section is about installation and usage.

### Prerequisites

- Go (optional)

### Installation

1. Installation with Go:

  ```

  go install github.com/Kaamkiya/gg/cmd/gg@latest

  ```

2. Running with Go: if you don't want to install it but still want to play

  ```

  go run github.com/Kaamkiya/gg/cmd/gg@latest

  ```

3. Release binary:

  * Go to the [releases page](https://github.com/Kaamkiya/gg/releases)

  * Download the one for your platform

  * Make it executable (`chmod +x ./`)

  * Run it!

## Usage

Enter the command into the terminal:

```

gg

```

Then select a game and enjoy!

## Contributing

All sorts of contributions are welcome!

To contribute:

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

## Roadmap

* [ ] Blackjack

* [ ] A simple platforming game

* [ ] Space invaders (minimal, the invaders don't have to actually look like

  invaders)

* [ ] Simon

* [ ] Solitaire

* [ ] Tron

* [ ] Typespeed

## License

Distributed under the Unlicense. See [Unlicense License](https://unlicense.org) for more information.

## Acknowledgments

* [Al Sweigart's list of games to clone](https://inventwithpython.com/blog/2012/02/20/i-need-practice-programming-49-ideas-for-game-clones-to-code/)