Klemmgine

A simple 3D game engine written in C++ using OpenGL and SDL2 for Windows and Linux. It has basic support for scripting in C#.

Use with pre-built binaries

Requirements

The .NET 8 SDK is required.

For shaders, I recommend this Visual Studio extension.

How to use

1. Download the latest pre-built binaries here.

2. Extract the .zip file and run ProjectGenerator.exe to create a new project.

   # Windows
   ProjectGenerator.exe -projectName {Your project name}
   # Linux
   ./ProjectGenerator -projectName {Your project name}

   The new project files will be put in EngineDir/Games/{Your project name}/.

3. Run EngineDir\Games\{Your project name}\Editor.bat on Windows or EngineDir/Games/{Your project name}/Editor.sh on Linux.

Build from source:

Windows

• Requirements

  Visual Studio 2022 is required. For shaders, I recommend this extension.

  The required workloads are:

  • Desktop development with C++

  • Desktop development with C#

• How to build

  1. Clone the repository and it's submodules.

     git clone https://github.com/Klemmbaustein/Klemmgine.git --recurse-submodules

  2. In the engine directory, run setup.ps1

     using the Visual Studio Developer Powershell. This will build the engine and it's dependencies.

     .\setup.ps1

  3. Run the newly built ProjectGenerator.exe to create a new project.

     ProjectGenerator.exe -projectName {Project name}

     The new project files will be put in EngineDir\Games\{Project name}\.

  4. Open the generated solution file.

     start devenv "Games\{Project name}\{Project name}.sln"

  5. Set the project configuration of your project to Editor and press F5 to run the editor.

CMake

The engine can be built using cmake for both Windows and Linux.

1. Run cmake in the root directory to compile the project generator.
2. Use the project generator to generate a new project. On Windows, -buildSystem cmake needs to be added as a command argument.
3. The new project will have a CMakeLists.txt file to compile it.

Building documentation

The documentation is generated using Doxygen. To generate the documentation, run doxygen in the engine's root directory, where the doxyfile is located.

Note: Some Linux distros (like Ubuntu) have an old version of doxygen (1.9 or 1.8) in their package repositories that will improperly build the C# documentation. To install the latest version of doxygen, download it from their website.