diff --git a/README.md b/README.md index a5aae90..6b5d2b9 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,45 @@ -# SFML Snake Game +# CyberSerpent + +CyberSerpent is essentially a classic snake game that moves in different directions, passes through borders, and appears on the other side. With its neon-lit grid design, it gives players a sense of nostalgia while remaining fun at the same time. Demo Video: https://youtu.be/nnagibXqy0g -
-Download Latest Release: https://github.com/zEuS0390/cpp-sfml-snake-game/releases/latest -## How to Build? -1. Download the latest version of [SFML 2.x](https://www.sfml-dev.org/download.php), make sure it is compatible to your platform. After that, extract and place it in the libs directory. If you want to let the CMake handle it for you, just set the ```SNAKE_AUTO_DOWNLOAD``` to ```TRUE```. -3. Open the terminal or command prompt and navigate to the project's build directory. -4. Proceed to step 5 if you're not using Linux. Install the required dependency ```libopenal-dev```. -5. Execute the command ```cmake ..``` followed by ```mingw32-make```, ```cmake --build .``` or ```make```. -6. A bin directory will be created, which contains the executable program. Go there and run it. +## Installation +The binaries I have made so far are for Linux and Windows machines; I haven’t tried to build them on macOS. Just go to the latest release link and download the installer or archive file for your operating system. + +Download the Latest Release: https://github.com/zEuS0390/cpp-sfml-snake-game/releases/latest + +## Build from Source +You can build the game from the source using the [CMake](https://cmake.org/download/) tool, so make sure you have it installed. I designed it to allow you to easily build it on your own machine. The game was created with the SFML library, but since it's already defined in the CMake configuration file, you don’t need to handle it manually. + +If you are using Linux, make sure that the following [dependencies](https://gist.github.com/zEuS0390/1b2dfd25e01692e6c1cd1d86fd72b4df) are present on your system; otherwise, it will not work properly: + +- libfreetype6-dev +- libx11-dev +- libxrandr-dev +- libudev-dev +- libgl1-mesa-dev +- libflac-dev +- libsndfile1-dev +- libvorbis-dev +- libvorbisenc2 +- libvorbisfile3 +- libopenal-dev +- libpthread-stubs0-dev +- libjpeg8-dev +- libxcursor-dev + +**Note:** Make sure you have [Git](https://git-scm.com/downloads) installed, as it will be used by CMake to download SFML. + +Follow these steps: + +1. Open a terminal and navigate to the root directory of the project. +2. Create an empty directory: `mkdir build/`. +3. Generate the build system files in it: `cmake -S . -B build/`. +4. Build the project: `cmake --build build/`. +5. Finally, navigate to the `build/bin` directory and run the game. -## Screenshots +## Demo Screenshots

menu

gameplay-2