Skip to content

README.md

Latest commit

 

History

History
123 lines (91 loc) · 3.95 KB

README.md

File metadata and controls

123 lines (91 loc) · 3.95 KB

🎮 GameForLinux

Play awesome Terminal UI games on Linux - No compilation, no hassle, just pure fun!

GitHub Release License: MIT Linux

⚡ Quick Start

Install all games with one command:

curl -fsSL https://raw.githubusercontent.com/ttasc/gameforlinux/main/scripts/install.sh | sh

Your games are now ready to play! 🎉

🎯 Available Games

Game Description Link
gotermoku A minimal, terminal-based Gomoku game written in Go. ttasc/gotermoku
typense A minimalist, real-time typing survival game for the terminal. ttasc/typense
termdash A minimalist geometry dash clone on the terminal. ttasc/termdash
termtron Real-time Tron lightcycle duel for the terminal. ttasc/termtron
termines A minimalist, terminal-first Minesweeper clone written in Go. ttasc/termines
sudokute A minimalist, terminal-native Sudoku implementation written in Go. ttasc/sudokute
2048 A minimal, terminal-based 2048 game. ttasc/2048

Built on the blazing-fast ttbox TUI library.

📦 Usage & Installation Methods

Method 1: Using Make (Recommended for developers)

git clone https://github.com/ttasc/gameforlinux.git
cd gameforlinux

# Install all games
make install

# Or install a specific game
make install-sudokute

Method 2: Manual Download

Download the binary files directly from GitHub Releases on each game's repository. Then:

# Example for one game
chmod +x <game-name>
sudo mv <game-name> /usr/local/bin/

🎮 How to play

Just type the name of the installed game in your terminal:

sudokute

🧹 Management

make test             # Verify installations
make uninstall        # Remove all games
make uninstall-termines # Remove specific game
make build            # Build all games from source

💻 System Requirements

  • OS: Linux, macOS (Darwin), FreeBSD, OpenBSD, NetBSD, DragonFly
  • Architecture: x86_64 (amd64), ARM64 (Apple Silicon), x86 (386)
  • Terminal: Any POSIX-compliant terminal
  • Dependencies: None! (Static binaries)

📁 Project Structure

This repository uses a zero-bloat, centralized configuration:

gameforlinux/
├── CONTRIBUTING.md     # How to add a new game
├── games.list          # Single Source of Truth for all games
├── Makefile            # Dynamic task delegator
├── README.md           # Project documentation
├── scripts
│   ├── builds.sh       # Compile games from source
│   ├── install.sh      # Smart POSIX installer
│   ├── readme.sh       # Auto-generate games table for README.md
│   ├── test.sh         # Verify installations
│   ├── uninstall.sh    # Clean uninstaller
│   └── web.sh          # Auto-generate index.html from template.html
└── template.html       # A website template

🤝 Contributing

Adding your game is incredibly easy! See CONTRIBUTING.md for details. TL;DR: Just add your game's repository name to the games.list file and submit a PR!

📄 License

MIT License - See LICENSE file for details.

Made with ❤️ by ttasc