About this project

TUI GAME is a cross-platform collection of classic games that runs inside the terminal, described by its author as a project that began as a spontaneous idea and was developed over several days with Rust and Lua. The README notes that the project is currently undergoing a major architectural refactor and that the current code is highly unstable; the documentation reflects the 1.0 stable release, while 2.0 is still being refactored and its development documentation is described as internal-testing-only with no practical value. The README lists 18 playable games: 2048, Blackjack, Color Memory Game, Lights Out, Maze Escape, Memory Flip, Minesweeper, Pac-Man, Rock Paper Scissors, Air Shooter, Number Sliding Puzzle, Snake, Solitaire (with FreeCell, Klondike and Spider variants), Sudoku, Tetris, Tic-Tac-Toe, 24 Points and Wordle. Screenshots for the main page, game list and each game are included in the repository. Language and platform support - Interface languages: English and Simplified Chinese, switched in settings; a Chinese translation of the README is linked. - Platforms: Windows, Linux and macOS, with the README stating that macOS has not been tested on real hardware and asking users to file issues for bugs found. Notable details - The distributed build is bytecode, so no separate Rust or Lua compiler is required to play. - Built-in terminal responsiveness, with a notice when the terminal is too small. - Custom languages can be added by placing JSON language files in the resource folder. - Some games support saving so play can continue later. Command usage The command is tg, with the following options: no option launches the game; -v/-V/-version shows the installed version and the latest online version; -h/-H/-help shows usage instructions; -p/-P/-Path shows the installation path (for package-manager installs, it points to the symlink). Installation - Windows: extract the windows zip and add the directory to PATH, or install through Scoop, winget (the README notes this method does not support command arguments) or Chocolatey, each using a downloaded manifest. - Linux: extract the linux tar.gz and add it to PATH, or install the .deb with apt or the .rpm with dnf. - macOS: extract the macOS tar.gz and add it to PATH, or install via Homebrew using the provided formula file. The macOS instructions repeat the untested-hardware caveat. Future plans The roadmap lists 13 additional games, including Roulette, Code Breaker, Blind Box, Highway Racing, Dungeon Crawl, Guess the Number, Color Matcher, Hitori, Nonogram, Pipe Mania, Breakout, Paint by Numbers and Sokoban. Planned features include modding so users can add their own games (basic interfaces are said to already be in place), a boss key that opens a disguise interface aimed at avoiding detection while at work, and customizable in-game key bindings. The README also asks readers to star the repository, report bugs and open issues with ideas or suggestions, and links to the official website and GitHub repository.