Skip to content

About

Cross-platform C++ Vulkan game engine

Topics

Resources

Stars

78 stars

Watchers

4 watching

Forks

Repository files navigation

Saturn

Saturn Logo

License Repo Size Trello Codacy

Saturn is a free cross-platform 3D game engine.

Platforms

Platform Supported Architecture Build Status Stability
Windows 10+ ✅ x86_64 & AArch64 Repo Size Very stable
Linux ✅ x86_64 No CI yet. Stable
macOS 15+ (Sequoia) ✅ AArch64 (Apple M-Series) macOS CI Unstable

Windows ARM builds are only available on Windows 11

Features

  • Renderer

    • PBR Rendering
    • SSAO
    • GTAO
    • SMAA
    • Bloom (done the proper way)
    • Shadow Mapping
    • Forward+
    • Skeletal Animation
    • Font rendering, Screenspace/Worldspace
    • Normal Mapping
    • Instanced Rendering
    • Volumetric Clouds
  • Editor

    • Node Editors for Materials, Sounds, Animation Graphs and Behaviour Trees.
    • Undo/Redo tracking
    • Asset Browser
    • World outliner panel (SceneHierarchyPanel)
    • Many built-in Asset Viewers
    • Autosaves
    • Project Browser
    • Hot code reloading
  • Engine

    • AI Pathfinding and Navmesh generation using Recast
    • Behaviour Trees (Node Editor and Custom Tasks via C++)
    • C++ Gameplay Scripting, using an Unreal-like UClass and UObject reflection system with a Custom Build Tool, with support for SProperties.
    • Physics System via JoltPhysics
    • Distribution i.e. shipping the game as a standalone executable via our Asset Bundle system
    • Audio System via MiniAudio
    • Game UI system (named Alura)
    • Job system
    • ECS via EnTT
    • Support for custom keybinds
    • Online subsystem (Steamworks API)
    • Texture streaming

Captures

17 November Capture

17 November Capture, second

18 November Capture

Roadmap

For upcoming features and a general status of Saturn it is best to view the Trello

Getting Started & Prerequisites

Before anything please make sure you have the Vulkan SDK installed. If you do not have the Vulkan SDK the project will not build.

Saturn requires a Vulkan SDK of version 1.3, however any newer version should "just work".

When installing if there's an option about debug binaries make sure to tick that.

If you are on macOS or Linux you should check if your system has the .NET SDK installed, if you do not, you can download it from here.

Now, start by cloning the repository with git clone --recursive https://github.com/0xsmft/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.

Building

See BUILDING.md.

Documention

Documention can be found here.

License

This project is licensed under the MIT License, for more information check the LICENSE file.

About

Cross-platform C++ Vulkan game engine

Topics

Resources

Stars

78 stars

Watchers

4 watching

Forks

Releases

Contributors

Languages