Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
geefr committed Jun 9, 2022
1 parent 02cef2c commit 7e0e119
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# VSG OpenXR Integration

(prototype) VR support for [VulkanSceneGraph](https://github.com/vsg-dev/VulkanSceneGraph)
(prototype) VR support for [VulkanSceneGraph](https://github.com/vsg-dev/VulkanSceneGraph) via OpenXR.

Latest State: vsgvr library created, functionality encapsulated in a few functions & VRViewer class.
## Status
vsgvr library created, functionality encapsulated in a few functions & VRViewer class.
Functionality under OpenXR has reached parity with previous openvr version, so OpenXR will be the backend going forward.
(openvr version should be available in a branch if you want it)

[![Demo Video](http://img.youtube.com/vi/ZA7syEMAIMo/0.jpg)](http://www.youtube.com/watch?v=ZA7syEMAIMo "vsgvr Demo Video")

example_vr.cpp should be similar enough to a desktop 'hello world'.
example\_vr.cpp should be similar enough to a desktop 'hello world'.

Thing | Status
-----------------------------|--------
Expand All @@ -17,15 +18,14 @@ Windows Build | Building
Code | Messy, but in roughly the right structure
OpenXR Presentation | Present, will need cleanup but should be functional for now
OpenXR Input | Not Implemented Yet
Controller tracking | Not Implemented Yet
Controller models in scene | Not Implemented Yet
Controller tracking | Working
Controller models in scene | Working
HMD tracking | Working
Desktop view | Not Implemented Yet

Issue | Status
-----------------------------|-------


## Setup

If you don't have a headset see here - Force a null driver to allow basic display output:
Expand All @@ -35,7 +35,7 @@ Building requires:
* cmake > 3.14
* vulkan sdk
* VulkanSceneGraph
* OpenXR loader (Included in deps/openxr)
* OpenXR loader (Git submodule in deps/openxr)
* (For model creation) vsgXchange

```
Expand All @@ -60,3 +60,5 @@ Export from blender to gltf:
Convert to vsg via `vsgconv model.glb model.vsgt`
* Ensure vsgXchange is built with assimp support (For assimp itself I used vcpkg)
* Ensure a recent build is used for correct lighting (fd35cc2 or newer)#


0 comments on commit 7e0e119

Please sign in to comment.