snake is a cross-platform TUI snake game.
I wanted to create a simple game to learn more about TUI (text-based user interface) programming.
- Written in modern C# (.NET 8).
- Comprehensive code documentation.
This project has been tested on the following systems:
- macOS 15.1 (Sequoia)
Automated testing is also performed on the latest versions of macOS, GNU/Linux, and Windows using GitHub Actions.
Pre-built framework-dependent executables are available for macOS (ARM64), GNU/Linux (x86_64), and Windows (x86_64). You can download the latest version from the Releases page.
Note: These executables require .NET 8.0 runtime (or later). You can download the runtime from the .NET website (brew install --cask dotnet on macOS). Alternatively, you can download the full SDK (brew install --cask dotnet-sdk on macOS) to build the project from source.
To remove macOS quarantine, use the following commands:
xattr -d com.apple.quarantine snake-macos-arm64
chmod +x snake-macos-arm64On Windows, the OS might complain about the executable being unsigned. You can bypass this by clicking on "More info" and then "Run anyway".
To build and run this project, you'll need:
- .NET SDK 8.0 or later (for pre-built executables, only the runtime is required)
Follow these steps to build the project:
-
Clone the repository:
git clone https://github.com/ryouze/snake.git
-
Compile the project:
cd snake dotnet publish
After successful framework-dependent executable compilation, you can run the program using ./publish/snake. However, it is highly recommended to install the program, so that it can be run from any directory. Refer to the Install section below.
Note: The mode is set to Release by default. To build in Debug mode, use ``dotnet publish --configuration Debug`.
If not already built, follow the steps in the Build section.
To install the program, use the following command:
sudo cp publish/snake /usr/local/binTo run the program, use the following command:
snakeTo build and run the program from source, use:
dotnet run --project Snake/Snake.csprojNote: By default, the program will be built and ran in Debug mode. To build in Release mode, use dotnet run --project Snake/Snake.csproj --configuration Release.
To create a self-contained executable, use:
dotnet publish --self-containedNote: The /p:PublishTrimmed=true flag causes issues with the Spectre.Console library. As a result, the untrimmed executable is around 75 MB.
To run the tests manually, use:
dotnet testAll contributions are welcome.
This project is licensed under the MIT License.