Zenith

A simple 2D video game engine which uses SFML.

How to Use

1. Make sure to clone this repository recursively with the --recursive option in git to clone the project's dependencies as well.

   git clone --recursive https://github.com/Kosmit147/Zenith.git Zenith
   

2. If you use Linux, install SFML's dependencies using your system package manager. On Ubuntu and other Debian-based distributions you can use the following commands:

   sudo apt update
   sudo apt install \
       libxrandr-dev \
       libxcursor-dev \
       libudev-dev \
       libfreetype-dev \
       libopenal-dev \
       libflac-dev \
       libvorbis-dev \
       libgl1-mesa-dev \
       libegl1-mesa-dev
   

3. Configure and build your project using CMake. Most popular IDEs support CMake projects with very little effort on your part.

   • VS Code via the CMake extension
   • Visual Studio
   • CLion
   • Qt Creator

   Alternatively, run these commands using the terminal. Be sure to run them in the root directory of the project you just created.

   cmake -B build
   cmake --build build
   

License

Zenith is licensed under the MIT License.