beastsm96 / saturn-engine Goto Github PK

Saturn is primarily an early-stage game engine for Windows.
Currently Saturn is built in Vulkan, in the furture we want to support other APIs.

Visual Studio 2022 is recommended, Saturn is officially untested on other development environments whilst we focus on a Windows build.

Start by cloning the repository with git clone --recursive https://github.com/BEASTSM96/Saturn-Engine.

If the repository was cloned non-recursively previously, use git submodule update --init to clone the necessary submodules.

In order to start building you will need Premake

Download

Learn More

You may have to add the premake executable to you PATH environment varible.

To generate the project files, you can just run the premake executable that you downloaded, if you already have premake installed make sure it can support generating Visual Studio 2022 project files so 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 solution.

• Core
  • Custom Title bar
  • Event System
  • Input
  • Window
  • Asset Manager
  • Projects
  • ECS (entt)
• Renderer
  • Core Renderer
  • PBR
  • Shadows
  • Material
  • Bloom
  • Soft shadows
  • SSAO, HBAO+, GTAO, VXAO
  • Instanced Rendering
  • Skybox
  • Text rendering
• Scripting (C++)
  • Core scripting
  • Core build tool
  • Scriptable Components
  • Public property viewer in the editor
  • General Game API and framework
• Physics
  • Core PhysX API
  • Mesh Colliders
  • Cooking of mesh colldiers
  • Joints
  • Ragdolls
• Audio
  • Initial Audio API
  • Initial Play/Stop
  • Sound Assets