Saturn is primarily an early-stage game engine for Windows.
Currently Saturn is built in Vulkan, in the furture we want to support other graphics APIs.
Visual Studio 2022 is recommended as Saturn is officially untested on other development environments whilst we focus on a Windows build.
First, start by cloning the repository with git clone --recursive https://github.com/BEASTSM96/Saturn-Engine.
If the repository was previously cloned non-recursively then use git submodule update --init to clone the necessary submodules.
Make sure to check that you are on the branch vulkan. If not you can run git checkout vulkan
In order to start you will need to download Premake
You may have to add the premake executable to you PATH environment variable.
To generate the project files, you can run the premake executable that you downloaded, if you already have premake installed make sure it can support generating Visual Studio 2022 project files (premake version v5.0.0-beta1 onwards).
So for generating the project files on Visual Studio 2022 you'd do premake5.exe vs2022
To compile the engine simply open the newly generated project files and build the entire solution.
Before launching the editor you must create a new project as this repo does not contain a default project. So, set the project browser as the startup project and run (F5), create a new project and launch it from the browser.