Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 13 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,7 @@ Untold Engine is built for developers and teams who:
Creator & Lead Developer:
https://www.haroldserrano.com

[![untoldengine-image](/docs/images/engine-highlight-5.png)](https://vimeo.com/1176995991?fl=ip&fe=ec)

Click to Play
![archviz-demo](docs/images/gifs/archviz-demo.gif)

---

Expand All @@ -69,18 +67,16 @@ workflow, product experience, and customer-specific behavior.

## Watch It in Action — Apple Vision Pro Demos

<table>
<tr>
<td><a href="https://vimeo.com/1186637984?share=copy&fl=sv&fe=ci"><img src="https://vumbnail.com/1186637984.jpg" width="280"></a></td>
<td><a href="https://vimeo.com/1186592834?share=copy&fl=sv&fe=ci"><img src="https://vumbnail.com/1186592834.jpg" width="280"></a></td>
<td><a href="https://vimeo.com/1176823067?share=copy&fl=sv&fe=ci"><img src="https://vumbnail.com/1176823067.jpg" width="280"></a></td>
</tr>
<tr>
<td><a href="https://vimeo.com/1176823994?share=copy&fl=sv&fe=ci"><img src="https://vumbnail.com/1176823994.jpg" width="280"></a></td>
<td><a href="https://vimeo.com/1176995991?fl=ip&fe=ec"><img src="https://vumbnail.com/1176995991.jpg" width="280"></a></td>
<td></td>
</tr>
</table>
| Demo | Description |
| --- | --- |
| [CoolSaber](https://github.com/untoldengine/UntoldArcade/tree/main/CoolSaber) | PSVR2-driven lightsaber duels, blades clashing over SharePlay |
| [CoolWater](https://github.com/untoldengine/UntoldArcade/tree/main/CoolWater) | Real-time animated water with reflection, refraction, and ripples |
| [CoolCloth](https://github.com/untoldengine/UntoldArcade/tree/main/CoolCloth) | GPU cloth simulation (XPBD) you can punch a ball through |
| [Archviz Viewer](https://untoldengine.github.io/UntoldEngine/LearningPaths/ArchvizToVisionPro/) | Blender-authored architectural scene walked through in mixed reality |
| [Bedroom Digital Twin](https://untoldengine.github.io/UntoldEngine/LearningPaths/BedroomDigitalTwin/) | Tap-to-inspect digital twin bedroom with live mock status data |
| [City Streaming](https://untoldengine.github.io/UntoldEngine/LearningPaths/CityStreamingOnVisionPro/) | City-scale scene streamed in tile by tile with LOD/HLOD |

Full source for every demo above lives in the [UntoldArcade](https://github.com/untoldengine/UntoldArcade) repo.

## Requirements

Expand All @@ -89,6 +85,8 @@ workflow, product experience, and customer-specific behavior.
- Apple Silicon Mac
- Supported platforms: macOS, iOS, and visionOS

![coolsaber-demo](docs/images/gifs/coolsaber-demo.gif)

## Try the Engine Right Now

The best first step is to run the Starter Demo. It is intentionally small and
Expand Down Expand Up @@ -124,8 +122,6 @@ The demos live under `Sources/Demos`. They are runnable when working inside the
engine repository, but are not exposed as products to apps that add Untold
Engine as a package dependency.

![untoldengine-image-2](/docs/images/engine-highlight-6.png)

---

## Getting Started
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,20 @@
"size": "253.4 MB"
},
{
"id": "starter-tiled-scene",
"name": "Tiled Scene Starter Assets",
"description": "A tile-streamed city scene for the Geometry Streaming System.",
"id": "starter-streamed-city",
"name": "Streamed City Starter Assets",
"description": "A low-poly city scene for the tile-based Geometry Streaming System.",
"version": "1.0.0",
"downloadURL": "https://d8pyi1c08k1w.cloudfront.net/TiledScenePack.zip",
"size": "34.1 MB"
"downloadURL": "https://d8pyi1c08k1w.cloudfront.net/LowPolyCity.zip",
"size": "58.9 MB"
},
{
"id": "starter-digital-twin",
"name": "Digital Twin Starter Assets",
"description": "Bedroom digital-twin scene with light portal and selectable devices.",
"version": "1.0.0",
"downloadURL": "https://d8pyi1c08k1w.cloudfront.net/DigitalTwinPack.zip",
"size": "424.3 MB"
}
]
}
6 changes: 3 additions & 3 deletions docs/API/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Let's download a Stream Starter Scene

```bash

untoldengine assets install starter-tiled-scene
untoldengine assets install starter-streamed-city

```

Expand All @@ -205,10 +205,10 @@ To load a Tiled-Stream scene, you need to use `setEntityStreamScene` and pass th


let sceneRoot = createEntity()
setEntityName(entityId: sceneRoot, name: "City")
setEntityName(entityId: sceneRoot, name: "LowPolyCity")

// Local manifest
setEntityStreamScene(entityId: sceneRoot, manifest: "City", withExtension: "json") { success in
setEntityStreamScene(entityId: sceneRoot, manifest: "LowPolyCity", withExtension: "json") { success in
setSceneReady(success)
}
```
Expand Down
2 changes: 2 additions & 0 deletions docs/LearningPaths/ArchvizToVisionPro.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ The goal is a simple but complete archviz viewer:

This path uses the starter archviz asset so you can focus on the engine workflow first. After this is working, you can replace the starter asset with your own Blender export.

Want to run it right away instead of building it step by step? The finished project, **ArchvizViewer**, is in the [UntoldArcade](https://github.com/untoldengine/UntoldArcade) demo collection: [github.com/untoldengine/UntoldArcade/tree/main/ArchvizViewer](https://github.com/untoldengine/UntoldArcade/tree/main/ArchvizViewer). Clone it, open the Xcode project, and run.

## Prerequisites

You need:
Expand Down
Loading
Loading