Nuclear-Engine icon indicating copy to clipboard operation
Nuclear-Engine copied to clipboard

A W.I.P Modern C++20 Cross-Platform Game Engine with C# Scripting.

Nuclear Engine

Current To-dos

  • W.I.P:

    • Basic Editor support (Nuclear Editor).
    • Basic Shadow mapping for all 3 light types.
    • Text rendering
  • TODO:

    • Motion blur
    • SSAO
    • FIX BRDF generation in IBL Pipeline
    • Clean and document Samples.
    • Replace GLFW with SDL or SFML
    • GUI (basic widgets)
    • add DebugSystem

Getting started

Follow the instructions below to compile and run the engine from source.

Windows

  • Visual Studio 2022 or newer is required
  • Clone repo & submodules
  • Run RunCmakeForDependencies.bat
  • Compile Assimp & Diligent & GLFW found in External/CmakeProjects
  • Download and compile the remaining dependencies (PHYSX & FreeImage & FMOD & Freetype & msdf-atlas-gen 'as static lib')
  • Run CopyDependenciesBinaries.bat
  • Open Nuclear Engine.sln and set your solution configuration and platform
  • Compile
Dependencies Type
Assimp Submodule & built with cmake
DiligentCore Submodule & built with cmake
GLFW Submodule & built with cmake
AngelScript included
spdlog included
IMGUI included
stb_truetype included
entt included
cereal included
FMOD SDK External 'Download it through their site'
PhysX 4.1 submodule
Freeimage submodule
Freetype submodule
msdf-atlas-gen submodule