How jkatsanis/spriteengineui works
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: Sprite.h Sprite components · Engine.cpp Template engine · ProjectSelector Project selector · SpriteRepository.cpp Sprite repository
Components 19
Editor
- Editor app
Engine/Editor/Source/Main.cpp - Editor UI
Engine/Editor/Source/GUI - Scene tools
Engine/Editor/Source/GUI/Property - Editor repository
Engine/Editor/Source/GUI/GUIRepository.cpp
Project workflow
- Project selector
Engine/Editor/Source/GUI/ProjectSelector - Project builder
Engine/Engine/Core/Source/Core/BuildManager.cpp - Project settings
Engine/Engine/Core/Source/Core/EngineData.h
Game runtime
- Template engine
Engine/Template/Engine/Source/Engine.cpp - User game
Engine/Template/Engine/Source/IScript.h - Scene handler
Engine/Engine/Core/Source/Core/SeceneHandler.h - Scene initializer
Engine/Engine/Core/Source/RessourceHandler/Initializer.h - Sprite repository
Engine/Engine/Core/Source/Sprite/SpriteRepository.cpp - Camera
Engine/Engine/Core/Source/Camera/Camera.h
Sprite features
- Sprite components
Engine/Engine/Core/Source/Sprite/Sprite.h - Physics simulation
Engine/Framework/Source/Physics/Physics.cpp - Prefab repository
Engine/Framework/Source/PrefabRepository/PrefabRepository.cpp - Lighting
Engine/Engine/Core/Source/Sprite/Components/Light/LightRepository.cpp
Other components
- Developer
- Game developer
Connections 21
- Developer → Editor app: opens
- Editor app → Project selector: starts
Engine/Editor/Source/Main.cpp - Editor app → Editor UI: uses
Engine/Editor/Source/Main.cpp - Editor UI → Scene tools: provides
Engine/Editor/Source/GUI/Property/Inspector/UIInspector.cpp - Editor UI → Editor repository: uses
Engine/Editor/Source/GUI/GUIRepository.cpp - Developer → Project selector: creates project
- Project selector → Project builder: requests build
- Project builder → Project settings: uses settings
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
Engine/Engine/Core/Source/Core/SeceneHandler.h - Scene handler → Sprite repository: manages sprites
Engine/Engine/Core/Source/Core/SeceneHandler.h - Scene initializer → Sprite repository: initializes sprites
- Sprite repository → Sprite components: stores sprites
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
Engine/Engine/Core/Source/Sprite/Sprite.h - Template engine → Camera: owns camera
- Sprite components → Sprite repository: retrieved by game
Engine/Engine/Core/Source/Sprite/SpriteRepository.cpp