gg - GitLite

KO | EN

gitlite — search

#python #typescript #javascript #nodejs #java #docker #rust #nlp #react #android #golang #node

gg

★ 65 Open GitHub ↗

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
<h2 align="center">gg</h2>
<p align="center">
games you can play in your terminal!

<a href="https://github.com/Kaamkiya/gg/issues/new">Report a bug or request a feature</a>

</p>
</div>

[![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.](https://raw.githubusercontent.com/Kaamkiya/gg/main/assets/gg.gif)
![A screenshot of 2048, dodger, and a maze running in separate windows.](https://raw.githubusercontent.com/Kaamkiya/gg/main/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 ./<file>`)
  * 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

## 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/)

gg

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README