Helios Engine Documentation¶
v0.5.0 — A modular, data-driven game engine built with C++20 and Vulkan 1.3.
The Helios Book¶
The Helios Book provides high-level conceptual guides for the engine's major systems.
| Section | Description |
|---|---|
| Architecture | Module layout, dependency graph, plugin system |
| ECS | World, entities, components, systems, scheduling |
| Assets | Async loading, binary format, thread pool |
| Scenes | Serialization, SceneRoot, sub-scenes, runtime switching |
| Rendering | RHI, Vulkan backend, Forward+ pipeline |
| Physics | Jolt integration, body lifecycle, contact events |
| Audio | SoLoud, 3D spatial playback |
| Scripting | C# via CoreCLR, ScriptBehaviour, native bridge |
| Editor | Panels, Play/Stop, gizmos, project system |
API Reference¶
The API Reference provides detailed documentation for every major class and function in the engine.
- Core API (ECS, Assets, Window, Input, Scene, App)
- Renderer API (RHI, Render Graph, Pipeline)
- Physics API (Jolt integration)
- Audio API (SoLoud integration)
- Scripting API (C# and C++ hosting)
Examples¶
Check out the Code Snippets for quick "How-to" guides on common tasks.
Getting Started¶
git clone git@github.com:RyuTribal/helios.git
cd helios
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build . --target helios-editor
./bin/helios-editor /path/to/project.hveproject