Skip to content

YanSchw/SuoraEngine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Suora Engine

SuoraEngine is an open-source C++ Engine for building 3D real-time rendering Applications and interactive Content, especially Video Games.

Screenshot of the Suora Engine editor

Current Features

Gameplay Programming

Gameplay Programming Gameplay Programming using C++ and a custom C++ Reflection System using SuoraHeaderTool and SuoraBuildTool. Everything is devided into C++ Modules, which can be compiled incrementally. Full Clean Engine Build within 5 Minutes. Incremental C++ Build (Compile + Editor Startup) in <15 Seconds.

Gameplay Scripting (Experimental)

Gameplay Scripting Gameplay Scripting using C#. Extend Native C++ Classes and Functionality with C# and .Net Core 8. .Net Core 8 SDK is required! Full C# Build + HotReload in <5 Seconds.

Visual Scripting (Experimental)

Visual Scripting Create custom Gameplay Logic using Visual Scripting. Easy interoperability with C++ using SuoraHeaderTool.

Other Features Suora offers:

Feature Description
Custom SuoraBuildTool To extend the Engine using Modules as Plugins and to allow Reflection and Introspection
Custom Visual Scripting Tools Node-based Visual Scripting to enable easy implementation of custom logic
Physics 3D Physics using JoltPhysics
GameFramework Flexible Node-based GameFramework
Custom EditorUI using the RenderingAPI as a Backend (Immediate)
InGameUI using the GameFramework and UINodes (Retained)
Full Visual Editor Feature complete Level- and Asset-Editor to enable authoring game content
Deferred Rendering Deferred + Forward Rendering using scriptable Shaders
Particle Systems using Instanced Rendering

Getting Started [Windows]

  • Download the latest Engine Release on GitHub
  • Install the .Net Core 8 SDK
  • Install Visual Studio 2022 and also install Desktop Development with C++ using the Visual Studio Installer Screenshot of VS2022-Installer-Workloads
  • To create a new or open an existing Suora Project, start the Launcher in /Binaries/
  • Choose a Project Name and Location and select Create Project CreateProject
  • Visual Studio should open by default
    • If not, open the Location in your File Explorer and use the Buildscripts in {ProjectLocation}/Scripts/
    • Open the .sln manually
  • Choose Editor as your Startup Project and Release as your Configuration
  • Compile and Run

Build the Engine Yourself

  • Clone the repository: git clone --recursive https://github.com/YanSchw/SuoraEngine
  • Generate the Solution using /GenerateSolution.bat
    • Make sure, MSBuild Path is valid
    • This script compiles SuoraBuildTool.exe and copies it into /Binaries/Scripts/
    • It executes SuoraBuildTool.exe and generates a VS2022 Solution
  • Open the Solution using Visual Studio 2022
  • Build using VS2022

Build Requirements

  • C++20 Compiler
  • [Windows] Visual Studio 2022 Toolset (MSVC) (Community Edition)

Supported Platforms

  • Windows (64bit)