UntoldEngine/mkdocs.yml at develop · untoldengine/UntoldEngine · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
site_name: Untold Engine
site_url: https://untoldengine.github.io/UntoldEngine/
repo_url: https://github.com/untoldengine/UntoldEngine
repo_name: untoldengine/UntoldEngine

docs_dir: docs

theme:
  name: material
  logo: images/untoldenginewhite.png
  favicon: images/untoldenginewhite.png
  palette:
    - scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables

nav:
  - Introduction: index.md
  - Learning Paths:
    - Overview: LearningPaths/index.md
    - Archviz To Vision Pro: LearningPaths/ArchvizToVisionPro.md
  - Tutorials:
    - Overview: Tutorials/index.md
    - Starter Demo: Tutorials/StarterDemo.md
    - Lighting Demo: Tutorials/LightingDemo.md
    - Rendering Quality Demo: Tutorials/RenderingQualityDemo.md
    - Exporter Pipeline Demo: Tutorials/ExporterPipelineDemo.md
    - Interaction / Gameplay Demo: Tutorials/InteractionGameplayDemo.md
    - Large Scene Streaming Demo: Tutorials/LargeSceneStreamingDemo.md
    - Showcase Demo: Tutorials/ShowcaseDemo.md
    - Create A New Xcode Project: Tutorials/CreateXcodeProjectTutorial.md
    - Export Assets With The CLI: Tutorials/CLIExporterTutorial.md
    - Scene Channels And Passthrough Rendering: Tutorials/SceneChannelsTutorial.md
    - Light Portals: Tutorials/LightPortalsTutorial.md
    - Blender Add-On Workflow: Tutorials/BlenderAddonTutorial.md
    - Materials, Textures, And Color Management: Tutorials/MaterialsPipelineTutorial.md
    - XR App Basics: Tutorials/XRTutorial.md
    - Spatial Input And Manipulation: Tutorials/SpatialInputTutorial.md
    - Performance Diagnostics: Tutorials/PerformanceDiagnosticsTutorial.md
  - API:
    - Getting Started: API/GettingStarted.md
    - Untold Engine CLI: API/UsingUntoldEngineCLI.md
    - Usage Examples: API/UsageExamples.md
    - Scene Builder / UntoldView: API/UsingSceneBuilder.md
    - Engine Settings: API/UsingEngineAPI.md
    - Registration System: API/UsingRegistrationSystem.md
    - Transform System: API/UsingTransformSystem.md
    - Scene Graph: API/UsingScenegraph.md
    - Camera System: API/UsingCameraSystem.md
    - Input System: API/UsingInputSystem.md
    - Rendering System: API/UsingRenderingSystem.md
    - Materials: API/UsingMaterials.md
    - Lighting System: API/UsingLightingSystem.md
    - Animation System: API/UsingAnimationSystem.md
    - Animation Transitions: API/UsingAnimationTransitions.md
    - Root Motion: API/UsingRootMotion.md
    - Physics System: API/UsingPhysicsSystem.md
    - Steering System: API/UsingSteeringSystem.md
    - Scripting System: API/UsingScriptingSystem.md
    - Post Effects: API/UsingPostFX.md
    - Scene Channels: API/UsingSceneChannels.md
    - LOD System: API/UsingLODSystem.md
    - Static Batching: API/UsingStaticBatchingSystem.md
    - LOD + Batching + Streaming: API/UsingLOD-Batching-Streaming.md
    - Geometry Streaming: API/UsingGeometryStreamingSystem.md
    - Async Loading: API/UsingAsyncLoading.md
    - Spatial Input: API/UsingSpatialInput.md
    - XR Lighting: API/UsingXRLighting.md
    - XR Immersion Modes: API/UsingXRImmersionMode.md
    - Light Portals: API/UsingLightPortals.md
    - Rendering Extensions: API/UsingRenderingExtensions.md
    - Gaussian System: API/UsingGaussianSystem.md
    - Profiler: API/UsingProfiler.md
    - Spatial Debugger: API/SpatialDebugger.md
    - Logger: API/UsingTheLogger.md
    - Exporter: API/UsingTheExporter.md
    - Bake Materials: API/UsingBakeMaterials.md
    - Color Management: API/UsingColorManagement.md
    - Blender Add-on: API/UsingBlenderAddon.md
    - Optimizations: API/Optimizations.md
  - Architecture:
    - Rendering System: Architecture/renderingSystem.md
    - Rendering Extensions: Architecture/RenderingExtensions.md
    - XR Rendering System: Architecture/xrRenderingSystem.md
    - Animation Pose Layer: Architecture/animationPoseLayer.md
    - Asset Format: Architecture/assetFormat.md
    - Scene Channels: Architecture/sceneChannels.md
    - Tile-Based Streaming: Architecture/tilebasedstreaming.md
    - Out-of-Core Geometry: Architecture/outOfCore.md
    - Streaming Region Manager: Architecture/streamingRegionManager.md
    - Geometry Streaming System: Architecture/geometryStreamingSystem.md
    - Streaming Cache Lifecycle: Architecture/streamingCacheLifecycle.md
    - Texture Streaming System: Architecture/textureStreamingSystem.md
    - Mesh Resource Manager: Architecture/meshResourceManager.md
    - Progressive Asset Loader: Architecture/progressiveAssetLoader.md
    - Asset Profiler: Architecture/assetProfiler.md
    - Asset Remote Streaming: Architecture/asset_remote_streaming.md
    - Batching System: Architecture/batchingSystem.md
    - LOD System: Architecture/lodSystem.md
  - Extensions:
    - Plugin Architecture: Extensions/PluginArchitecture.md
    - Plugin Authoring Guidelines: Extensions/PluginAuthoringGuidelines.md
    - Creating a Rendering Extension Plugin: Extensions/CreatingRenderingExtensionPlugin.md
    - Creating an Engine Extension Plugin: Extensions/CreatingAnEngineExtensionPlugin.md
  - Contributing:
    - Guidelines: Contributor/ContributionGuidelines.md
    - Versioning: Contributor/versioning.md
    - Formatting: Contributor/Formatting.md