# jkatsanis/spriteengineui architecture

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

- Interactive diagram: https://gitdiagram.com/jkatsanis/spriteengineui
- Repository: https://github.com/jkatsanis/spriteengineui

## Overview

Sprite Engine is a 2D game engine with an editor for creating projects and scenes, configuring sprites and their components, simulating physics, and building or launching a game. The documented runtime starts from the generated game’s Engine, which owns the window, scene handler, and user Game class; sprites are managed in a repository. The README documents the principal workflow and capabilities, while source excerpts and the SOURCE INDEX establish several component and module relationships. Unsampled editor internals and runtime wiring are represented cautiously.

Main entry points: [`Engine/Engine/Core/Source/Sprite/Sprite.h`](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Sprite/Sprite.h) (Sprite components), [`Engine/Template/Engine/Source/Engine.cpp`](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Template/Engine/Source/Engine.cpp) (Template engine), [`Engine/Editor/Source/GUI/ProjectSelector`](https://github.com/jkatsanis/spriteengineui/tree/main/Engine/Editor/Source/GUI/ProjectSelector) (Project selector), [`Engine/Engine/Core/Source/Sprite/SpriteRepository.cpp`](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Sprite/SpriteRepository.cpp) (Sprite repository)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_editor["Editor"]
  node_editor_app["Editor app<br/>[Main.cpp]"]
  node_editor_gui["Editor UI"]
  node_scene_tools["Scene tools"]
  node_editor_state["Editor repository<br/>[GUIRepository.cpp]"]
end

subgraph group_project["Project workflow"]
  node_project_selector["Project selector"]
  node_project_build["Project builder<br/>[BuildManager.cpp]"]
  node_project_state["Project settings<br/>[EngineData.h]"]
end

subgraph group_runtime["Game runtime"]
  node_template_engine["Template engine<br/>[Engine.cpp]"]
  node_user_game["User game<br/>[IScript.h]"]
  node_scene_handler["Scene handler<br/>[SeceneHandler.h]"]
  node_initializer["Scene initializer<br/>[Initializer.h]"]
  node_sprite_repo["Sprite repository"]
  node_camera["Camera<br/>[Camera.h]"]
end

subgraph group_features["Sprite features"]
  node_sprite["Sprite components<br/>[Sprite.h]"]
  node_physics["Physics simulation<br/>[Physics.cpp]"]
  node_prefabs["Prefab repository"]
  node_lighting["Lighting"]
end

node_developer(("Developer"))
node_game_author(("Game developer"))

node_developer -->|"opens"| node_editor_app
node_editor_app -->|"starts"| node_project_selector
node_editor_app -.->|"uses"| node_editor_gui
node_editor_gui -.->|"provides"| node_scene_tools
node_editor_gui -->|"uses"| node_editor_state
node_developer -->|"creates project"| node_project_selector
node_project_selector -.->|"requests build"| node_project_build
node_project_build -->|"uses settings"| node_project_state
node_game_author -->|"writes"| node_user_game
node_project_selector -->|"copies template"| node_template_engine
node_template_engine -->|"owns"| node_user_game
node_template_engine -->|"updates scenes"| node_scene_handler
node_scene_handler -->|"loads scenes"| node_initializer
node_scene_handler -->|"manages sprites"| node_sprite_repo
node_initializer -.->|"initializes sprites"| node_sprite_repo
node_sprite_repo -->|"stores sprites"| node_sprite
node_sprite -->|"supports physics"| node_physics
node_sprite -->|"supports prefabs"| node_prefabs
node_sprite -->|"has light component"| node_lighting
node_template_engine -->|"owns camera"| node_camera
node_sprite -->|"retrieved by game"| node_sprite_repo

click node_editor_app "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Editor/Source/Main.cpp"
click node_editor_gui "https://github.com/jkatsanis/spriteengineui/tree/main/Engine/Editor/Source/GUI"
click node_scene_tools "https://github.com/jkatsanis/spriteengineui/tree/main/Engine/Editor/Source/GUI/Property"
click node_project_selector "https://github.com/jkatsanis/spriteengineui/tree/main/Engine/Editor/Source/GUI/ProjectSelector"
click node_project_build "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Core/BuildManager.cpp"
click node_project_state "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Core/EngineData.h"
click node_template_engine "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Template/Engine/Source/Engine.cpp"
click node_user_game "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Template/Engine/Source/IScript.h"
click node_scene_handler "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Core/SeceneHandler.h"
click node_initializer "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/RessourceHandler/Initializer.h"
click node_sprite_repo "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Sprite/SpriteRepository.cpp"
click node_sprite "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Sprite/Sprite.h"
click node_physics "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Framework/Source/Physics/Physics.cpp"
click node_prefabs "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Framework/Source/PrefabRepository/PrefabRepository.cpp"
click node_lighting "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Sprite/Components/Light/LightRepository.cpp"
click node_camera "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Camera/Camera.h"
click node_editor_state "https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Editor/Source/GUI/GUIRepository.cpp"

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_editor_app,node_editor_gui,node_scene_tools,node_editor_state toneBlue
class node_project_selector,node_project_build,node_project_state toneAmber
class node_template_engine,node_user_game,node_scene_handler,node_initializer,node_sprite_repo,node_camera toneMint
class node_sprite,node_physics,node_prefabs,node_lighting toneRose
class node_developer,node_game_author toneIndigo
```

## Components

### Editor

- [Editor app](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Editor/Source/Main.cpp): `Engine/Editor/Source/Main.cpp`
- [Editor UI](https://github.com/jkatsanis/spriteengineui/tree/main/Engine/Editor/Source/GUI): `Engine/Editor/Source/GUI`
- [Scene tools](https://github.com/jkatsanis/spriteengineui/tree/main/Engine/Editor/Source/GUI/Property): `Engine/Editor/Source/GUI/Property`
- [Editor repository](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Editor/Source/GUI/GUIRepository.cpp): `Engine/Editor/Source/GUI/GUIRepository.cpp`

### Project workflow

- [Project selector](https://github.com/jkatsanis/spriteengineui/tree/main/Engine/Editor/Source/GUI/ProjectSelector): `Engine/Editor/Source/GUI/ProjectSelector`
- [Project builder](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Core/BuildManager.cpp): `Engine/Engine/Core/Source/Core/BuildManager.cpp`
- [Project settings](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Core/EngineData.h): `Engine/Engine/Core/Source/Core/EngineData.h`

### Game runtime

- [Template engine](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Template/Engine/Source/Engine.cpp): `Engine/Template/Engine/Source/Engine.cpp`
- [User game](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Template/Engine/Source/IScript.h): `Engine/Template/Engine/Source/IScript.h`
- [Scene handler](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Core/SeceneHandler.h): `Engine/Engine/Core/Source/Core/SeceneHandler.h`
- [Scene initializer](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/RessourceHandler/Initializer.h): `Engine/Engine/Core/Source/RessourceHandler/Initializer.h`
- [Sprite repository](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Sprite/SpriteRepository.cpp): `Engine/Engine/Core/Source/Sprite/SpriteRepository.cpp`
- [Camera](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Camera/Camera.h): `Engine/Engine/Core/Source/Camera/Camera.h`

### Sprite features

- [Sprite components](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Sprite/Sprite.h): `Engine/Engine/Core/Source/Sprite/Sprite.h`
- [Physics simulation](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Framework/Source/Physics/Physics.cpp): `Engine/Framework/Source/Physics/Physics.cpp`
- [Prefab repository](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Framework/Source/PrefabRepository/PrefabRepository.cpp): `Engine/Framework/Source/PrefabRepository/PrefabRepository.cpp`
- [Lighting](https://github.com/jkatsanis/spriteengineui/blob/main/Engine/Engine/Core/Source/Sprite/Components/Light/LightRepository.cpp): `Engine/Engine/Core/Source/Sprite/Components/Light/LightRepository.cpp`

### Other components

- **Developer**
- **Game developer**

## Connections

- Developer → Editor app: opens
- Editor app → Project selector: starts (evidence: `Engine/Editor/Source/Main.cpp`)
- Editor app → Editor UI: uses (evidence: `Engine/Editor/Source/Main.cpp`)
- Editor UI → Scene tools: provides (evidence: `Engine/Editor/Source/GUI/Property/Inspector/UIInspector.cpp`)
- Editor UI → Editor repository: uses (evidence: `Engine/Editor/Source/GUI/GUIRepository.cpp`)
- Developer → Project selector: creates project
- Project selector → Project builder: requests build
- Project builder → Project settings: uses settings (evidence: `Engine/Engine/Core/Source/Core/BuildManager.cpp`)
- Game developer → User game: writes
- Project selector → Template engine: copies template
- Template engine → User game: owns
- Template engine → Scene handler: updates scenes
- Scene handler → Scene initializer: loads scenes (evidence: `Engine/Engine/Core/Source/Core/SeceneHandler.h`)
- Scene handler → Sprite repository: manages sprites (evidence: `Engine/Engine/Core/Source/Core/SeceneHandler.h`)
- Scene initializer → Sprite repository: initializes sprites
- Sprite repository → Sprite components: stores sprites (evidence: `Engine/Engine/Core/Source/Sprite/SpriteRepository.cpp`)
- Sprite components → Physics simulation: supports physics
- Sprite components → Prefab repository: supports prefabs
- Sprite components → Lighting: has light component (evidence: `Engine/Engine/Core/Source/Sprite/Sprite.h`)
- Template engine → Camera: owns camera
- Sprite components → Sprite repository: retrieved by game (evidence: `Engine/Engine/Core/Source/Sprite/SpriteRepository.cpp`)
