# klemmbaustein/klemmgine2 architecture

> Architecture diagram of the GitHub repository klemmbaustein/klemmgine2, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/klemmbaustein/klemmgine2
- Repository: https://github.com/klemmbaustein/klemmgine2

## Overview

Klemmgine 2 is a lightweight C++ 3D game engine with an optional graphical editor. Its principal runtime workflow starts in the executable, initializes the engine and its subsystems, then repeatedly updates and renders them; project loading and asset scanning occur during initialization. The README also describes scene editing, scripting and UI definitions, graphics effects, physics, audio, plugins, serialization, and virtual/remote resources. Runtime wiring is grounded in the sampled engine entry and initialization code; other capability branches are documented in the README, not verified from their implementations.

Main entry points: [`EngineSource/Engine/Engine.cpp`](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Engine.cpp) (Engine lifecycle), [`EngineSource/Engine/File/Resource.h`](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/File/Resource.h) (Virtual resources), [`EngineSource/Engine/Objects/Scene/SceneManager.cpp`](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Objects/Scene/SceneManager.cpp) (Scene management), [`EngineSource/Engine/Script/ScriptSubsystem.h`](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Script/ScriptSubsystem.h) (Script runtime)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["Engine runtime"]
  node_entry["Executable entry<br/>[main.cpp]"]
  node_engine["Engine lifecycle<br/>[Engine.cpp]"]
  node_subsystem["Subsystem framework<br/>[Subsystem.h]"]
end

subgraph group_content["Content and scripting"]
  node_project["Project configuration<br/>[ProjectFile.cpp]"]
  node_resources["Virtual resources<br/>[Resource.h]"]
  node_serialization["Serialization formats<br/>[SerializedData.h]"]
  node_scene["Scene management<br/>[SceneManager.cpp]"]
  node_scripting["Script runtime<br/>[ScriptSubsystem.h]"]
  node_ui_language["Script UI language<br/>[ParseUI.h]"]
end

subgraph group_graphics["Graphics and simulation"]
  node_video["Video subsystem<br/>[VideoSubsystem.h]"]
  node_rendering["Rendering and effects<br/>[OpenGLRenderer.cpp]"]
  node_physics["Physics and collision<br/>[Physics.h]"]
  node_audio["Sound system<br/>[Sound.h]"]
end

subgraph group_authoring["Editor and extensions"]
  node_editor["Graphical editor"]
  node_text_editor["Script editor"]
  node_editor_server["Editor collaboration"]
  node_plugins["Plugin support<br/>[PluginSubsystem.h]"]
  node_csharp["C&#35; integration"]
end

subgraph group_core["Core services"]
  node_threading["Thread pool<br/>[ThreadPool.h]"]
  node_compression["Miniz compression<br/>[miniz.c]"]
  node_engine_text["Text utilities<br/>[StringUtil.h]"]
  node_version["Version metadata<br/>[Version.h]"]
end

node_user(("Game user"))

node_user -->|"starts"| node_entry
node_entry -->|"enters runtime"| node_engine
node_engine -->|"updates and renders"| node_subsystem
node_engine -->|"loads"| node_video
node_engine -->|"loads"| node_scripting
node_engine -->|"loads"| node_audio
node_engine -->|"loads"| node_plugins
node_engine -->|"loads"| node_scene
node_engine -.->|"loads optionally"| node_editor
node_engine -->|"allocates pool"| node_threading
node_engine -->|"scans assets"| node_resources
node_engine -->|"loads project"| node_project
node_engine -->|"logs version"| node_version
node_video -.->|"renders scenes"| node_rendering
node_scene -.->|"simulates collisions"| node_physics
node_scene -.->|"loads assets"| node_resources
node_resources -.->|"compresses assets"| node_compression
node_resources -.->|"serializes data"| node_serialization
node_scripting -->|"parses UI definitions"| node_ui_language
node_editor -.->|"provides editing"| node_text_editor
node_editor -.->|"supports collaboration"| node_editor_server
node_scripting -.->|"extends scripting"| node_csharp
node_audio -.->|"plays audio"| node_user
node_video -.->|"displays graphics"| node_user

click node_entry "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/main.cpp"
click node_engine "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Engine.cpp"
click node_subsystem "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Subsystem/Subsystem.h"
click node_project "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/ProjectFile.cpp"
click node_resources "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/File/Resource.h"
click node_serialization "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Core/File/SerializedData.h"
click node_scene "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Objects/Scene/SceneManager.cpp"
click node_scripting "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Script/ScriptSubsystem.h"
click node_ui_language "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Script/UI/ParseUI.h"
click node_video "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Graphics/VideoSubsystem.h"
click node_rendering "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Graphics/Backend/OpenGLRenderer.cpp"
click node_physics "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Physics/Physics.h"
click node_audio "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Sound/Sound.h"
click node_editor "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Editor/EditorSubsystem.cpp"
click node_text_editor "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Editor/UI/EngineTextEditorProvider.cpp"
click node_editor_server "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Editor/Server/ServerConnection.cpp"
click node_plugins "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Plugins/PluginSubsystem.h"
click node_csharp "https://github.com/klemmbaustein/klemmgine2/blob/main/Plugins/CSharp/Loader/CSharpLoaderRuntime.cpp"
click node_threading "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Core/ThreadPool.h"
click node_compression "https://github.com/klemmbaustein/klemmgine2/blob/main/Dependencies/miniz/miniz.c"
click node_engine_text "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Core/StringUtil.h"
click node_version "https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Version.h"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_entry,node_engine,node_subsystem,node_user toneBlue
class node_project,node_resources,node_serialization,node_scene,node_scripting,node_ui_language toneAmber
class node_video,node_rendering,node_physics,node_audio toneMint
class node_editor,node_text_editor,node_editor_server,node_plugins,node_csharp toneRose
class node_threading,node_compression,node_engine_text,node_version toneIndigo
```

## Components

### Engine runtime

- [Executable entry](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/main.cpp): `EngineSource/main.cpp`
- [Engine lifecycle](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Engine.cpp): `EngineSource/Engine/Engine.cpp`
- [Subsystem framework](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Subsystem/Subsystem.h): `EngineSource/Engine/Subsystem/Subsystem.h`

### Content and scripting

- [Project configuration](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/ProjectFile.cpp): `EngineSource/Engine/ProjectFile.cpp`
- [Virtual resources](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/File/Resource.h): `EngineSource/Engine/File/Resource.h`
- [Serialization formats](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Core/File/SerializedData.h): `EngineSource/Core/File/SerializedData.h`
- [Scene management](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Objects/Scene/SceneManager.cpp): `EngineSource/Engine/Objects/Scene/SceneManager.cpp`
- [Script runtime](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Script/ScriptSubsystem.h): `EngineSource/Engine/Script/ScriptSubsystem.h`
- [Script UI language](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Script/UI/ParseUI.h): `EngineSource/Engine/Script/UI/ParseUI.h`

### Graphics and simulation

- [Video subsystem](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Graphics/VideoSubsystem.h): `EngineSource/Engine/Graphics/VideoSubsystem.h`
- [Rendering and effects](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Graphics/Backend/OpenGLRenderer.cpp): `EngineSource/Engine/Graphics/Backend/OpenGLRenderer.cpp`
- [Physics and collision](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Physics/Physics.h): `EngineSource/Engine/Physics/Physics.h`
- [Sound system](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Sound/Sound.h): `EngineSource/Engine/Sound/Sound.h`

### Editor and extensions

- [Graphical editor](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Editor/EditorSubsystem.cpp): `EngineSource/Editor/EditorSubsystem.cpp`
- [Script editor](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Editor/UI/EngineTextEditorProvider.cpp): `EngineSource/Editor/UI/EngineTextEditorProvider.cpp`
- [Editor collaboration](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Editor/Server/ServerConnection.cpp): `EngineSource/Editor/Server/ServerConnection.cpp`
- [Plugin support](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Plugins/PluginSubsystem.h): `EngineSource/Engine/Plugins/PluginSubsystem.h`
- [C# integration](https://github.com/klemmbaustein/klemmgine2/blob/main/Plugins/CSharp/Loader/CSharpLoaderRuntime.cpp): `Plugins/CSharp/Loader/CSharpLoaderRuntime.cpp`

### Core services

- [Thread pool](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Core/ThreadPool.h): `EngineSource/Core/ThreadPool.h`
- [Miniz compression](https://github.com/klemmbaustein/klemmgine2/blob/main/Dependencies/miniz/miniz.c): `Dependencies/miniz/miniz.c`
- [Text utilities](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Core/StringUtil.h): `EngineSource/Core/StringUtil.h`
- [Version metadata](https://github.com/klemmbaustein/klemmgine2/blob/main/EngineSource/Engine/Version.h): `EngineSource/Engine/Version.h`

### Other components

- **Game user**

## Connections

- Game user → Executable entry: starts
- Executable entry → Engine lifecycle: enters runtime (evidence: `EngineSource/main.cpp`)
- Engine lifecycle → Subsystem framework: updates and renders (evidence: `EngineSource/Engine/Engine.cpp`)
- Engine lifecycle → Video subsystem: loads (evidence: `EngineSource/Engine/Engine.cpp`)
- Engine lifecycle → Script runtime: loads (evidence: `EngineSource/Engine/Engine.cpp`)
- Engine lifecycle → Sound system: loads (evidence: `EngineSource/Engine/Engine.cpp`)
- Engine lifecycle → Plugin support: loads (evidence: `EngineSource/Engine/Engine.cpp`)
- Engine lifecycle → Scene management: loads (evidence: `EngineSource/Engine/Engine.cpp`)
- Engine lifecycle → Graphical editor: loads optionally (evidence: `EngineSource/Engine/Engine.cpp`)
- Engine lifecycle → Thread pool: allocates pool (evidence: `EngineSource/Engine/Engine.cpp`)
- Engine lifecycle → Virtual resources: scans assets (evidence: `EngineSource/Engine/Engine.cpp`)
- Engine lifecycle → Project configuration: loads project (evidence: `EngineSource/Engine/Engine.cpp`)
- Engine lifecycle → Version metadata: logs version (evidence: `EngineSource/Engine/Engine.cpp`)
- Video subsystem → Rendering and effects: renders scenes
- Scene management → Physics and collision: simulates collisions
- Scene management → Virtual resources: loads assets
- Virtual resources → Miniz compression: compresses assets
- Virtual resources → Serialization formats: serializes data
- Script runtime → Script UI language: parses UI definitions (evidence: `EngineSource/Engine/Script/ScriptSubsystem.h`)
- Graphical editor → Script editor: provides editing
- Graphical editor → Editor collaboration: supports collaboration
- Script runtime → C# integration: extends scripting
- Sound system → Game user: plays audio
- Video subsystem → Game user: displays graphics
