Skip to content
/ gg Public

👾 Games you can play in your terminal written in go

License

Notifications You must be signed in to change notification settings

Kaamkiya/gg

gg

games you can play in your terminal!

Report a bug or request a feature

License: Unlicense Last commit Open issue count Open pull request count Latest release Go report card Go version

GitHub contributors Repo size Top language

About The Project

A screenshot of 2048, dodger, and a maze running in separate windows.

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

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
  1. 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
  1. Release binary:
  • Go to the releases page
  • 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
  • Snake
  • Solitaire
  • Tetris
  • Tron
  • Typespeed

License

Distributed under the Unlicense. See Unlicense License for more information.

Acknowledgments