Tutorials
The tutorials use the demos in Sources/Demos as small, runnable examples of
the Untold Engine API. Each tutorial focuses on the engine calls that matter for
building an application: creating a renderer, registering entities, loading or
creating renderable content, configuring cameras and lights, handling input, and
updating the scene every frame.
The demo READMEs explain how to run each executable. These tutorials explain how the demos are built and how the same API calls transfer into your own project.
Learning Path
Learn The Engine API
| Tutorial | Run Command | Main API Focus |
|---|---|---|
| Starter Demo | swift run StarterDemo |
Renderer setup, frame callbacks, scene readiness, entities, meshes, transforms, camera movement, mouse input. |
| Lighting Demo | swift run LightingDemo |
Light entities, directional lights, point lights, spot lights, area lights, light color, intensity, and runtime controls. |
| Rendering Quality Demo | swift run RenderingQualityDemo |
Rendering settings, anti-aliasing, debug views, PostFX presets, and runtime quality controls. |
| Exporter Pipeline Demo | swift run ExporterPipelineDemo |
Loading .untold assets, exported animation clips, validation metadata, and authored asset workflows. |
| Interaction / Gameplay Demo | swift run InteractionGameplayDemo |
Gameplay-style input, animation switching, physics pause/resume, parented entities, and update-loop behavior. |
| Large Scene Streaming Demo | swift run LargeSceneStreamingDemo |
Tiled scene manifests, geometry streaming, LOD, static batching, cache budgets, and streaming diagnostics. |
Build Your Own Project
| Tutorial | Run Command | Main API Focus |
|---|---|---|
| Create A New Xcode Project | untoldengine create |
Generate a standalone Xcode project, choose a platform, understand dependencies, and use GameData. |
| Export Assets With The CLI | untoldengine export |
Export single assets, animations, optimized assets, and tiled scenes into the generated project's GameData layout. |
Production Workflows
| Tutorial | Run Command | Main API Focus |
|---|---|---|
| Scene Channels And Passthrough Rendering | API workflow | Scene channels, custom channels, channel render modes, passthrough ghosting, and channel picking. |
| Light Portals | API workflow | Window/opening channels, portal proxy lights, XR real-world tint, diagnostics, and performance limits. |
| Blender Add-On Workflow | Authoring workflow | Installing the add-on, exporting models, animations, tiled scenes, tile previews, and export hints. |
| Materials, Textures, And Color Management | Asset workflow | Runtime material edits, textures, material baking, color LUTs, scene-authored data, and optimization. |
| XR App Basics | Vision Pro workflow | Immersion mode, environment rendering, real-world lighting, spatial input setup, and scene placement. |
| Spatial Input And Manipulation | Vision Pro workflow | Tap selection, pinch manipulation, parent/root manipulation, and picking participation. |
| Performance Diagnostics | Debug workflow | Metrics, frame stats, spatial overlays, streaming diagnostics, batching diagnostics, and logger categories. |
How To Use These Tutorials
Start with the Starter Demo even if your goal is XR, streaming, or custom rendering. It shows the basic shape of an Untold Engine application without external assets or large-scene systems.
After that, choose the demo that matches the system you want to learn. The tutorials are meant to be read with the source files open:
Sources/Demos/<DemoName>/main.swiftSources/Demos/<DemoName>/AppDelegate.swiftSources/Demos/<DemoName>/GameScene.swift
Most demos also use shared setup helpers from Sources/Demos/DemoUtils. Those
helpers keep the demo files short, but the tutorials call out the underlying
engine APIs so you can use them directly in your own app.