Skip to content

Latest commit

 

History

History
80 lines (61 loc) · 3.77 KB

README.md

File metadata and controls

80 lines (61 loc) · 3.77 KB
Raw

Snek logo

A simple clone and re-implementation of the all known Snake game for todays Terminal. Featuring multiple game modes and some other nice additions!

CodeQL-badge linux-badge macos-badge windows-badge repo-maintained

Demo video

[Coming soon]

Platform support

Platform Support
Windows Only Windows 10 and higher are supported. Use the microsoft Terminal or Powershell 7 for the best result. Older versions of Windows don't have proper Terminal support.
Linux All distributions supported. Most Terminals are tested. Feel free to create an issue if a Terminal is not working.
MacOS The default Terminal app is not supporting True color which means that it can't display more than 265 colors (true color has 16M). You have to wait for 8bit color fall back support, sorry.

Roadmap

The roadmap can be found here.

Building

This section explains, how you can compile and install Snek by yourself on each supported platform.

Build support

Operating System compile install Package
Windows 10 MSVC (covered by unit testing), MinGW (gcc), MSYS2 (clang + gcc) MinGW, MSYS2 Not implemented yet
Linux clang, gcc yes Not implemented yet
MacOS clang, gcc yes Not implemented yet

Build on Windows

Building on Windows is recommended by using Visual Studio Community. Simply open the Git repository. If you are using a recent version of Visual Studio Community and has installed the CMake tools, it'll setup Snek automatically. All you need to do then, is to select Snek as compile target on the top drop down menu and click on the run button.

build in MSYS2/MinGW on windows and install it

Note: This method is compiling a binary that is only able to run inside of your MinGW / MSYS2 installation. Copying the binary is not possible without including the runtime. This guide assumes that you have installed MSYS2 or MinGW already and made sure that clang cmake make git are installed and executable.

# generate build files
cmake .
# compile
make
# install
make install
# run
snek

Please note that you might have to open the Terminal as administrator to install Snek.

Build on Linux and MacOS and install it

This guide assumes that you have already installed the required packages like clang cmake make git sudo.

Compiling Snek is just like compiling any other CMake project.

# generate build files
cmake .
# compile
make
# install
sudo make install
# run
snek

Contributing

There are many ways to contribute to Snek. You could start with things like finding and reporting bugs, requesting features or sharing ideas, maybe even by adding things yourself and create a Pull-Request! Contribution in any form is really appreciated!

License

Snek is Licensed under MIT.