Update README.md

2023-09-07 14:07:18 +01:00
1 changed files with 23 additions and 5 deletions
@@ -1,12 +1,30 @@
 # speckle-unity-vr

-A work in progress example project of Speckle in VR!
+A VR Sample project for a Speckle Unity VR app.

-Currently working with OpenXR on Windows, with the Quest 2.
+https://www.youtube.com/watch?v=Y-RGPZJIHf4

-https://drive.google.com/file/d/1ls5zovY15Bxhis9e0SgxjKp9k_rLsxzE/preview
+This project demonstrates a minimal VR app to visualise and modify 3D models in VR.
+3D data can be sent through any [Speckle](https://speckle.systems) connector, and received in the VR application.

- Receiving a selected Speckle commit (from a selection of accounts -> stream -> branch -> commit)
+The sample project is built to showcase the Speckle Unity connector, and how developers can easily build custom tools and applications that integrate with Speckle.
+
+---
+
+### Features
+- UI for Receiving a selected Speckle commit (from a selection of accounts -> stream -> branch -> commit)
+- Move objects around in 3D space using XR Grab Interactables
 - Sending (all) to a selected branch

-Note: Currently wip, and only working on PCVR (See [discussion](https://speckle.community/t/virtual-augmented-reality/4467))
+
+
+### Pre-requisites
+
+Currently working with OpenXR on Windows, Likely won't work out of the box for android standalone (See [discussion](https://speckle.community/t/virtual-augmented-reality/4467))
+
+You must have [Speckle Manager](https://speckle.systems/download/) installed with an [Speckle account](https://speckle.xyz/) setup.
+You should send some 3D data to Speckle from one of the other [supported connectors](https://speckle.systems/features/connectors/)
+
+Clone this repo, and open in Unity 2021 or 2022.
+
+Feel free to ask any questions on [our Forum](https://speckle.community/)_