Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document Unity XR testing (fixes issue #155) #297

Merged
merged 1 commit into from Jun 26, 2018
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file added ArtSources/docs/images/unity-xr-settings-1.pxm
Binary file not shown.
Binary file added ArtSources/docs/images/unity-xr-settings-2.pxm
Binary file not shown.
Binary file added ArtSources/docs/images/unity-xr-settings-3.pxm
Binary file not shown.
Binary file added ArtSources/docs/images/unity-xr-settings-4.pxm
Binary file not shown.
Binary file added ArtSources/docs/images/unity-xr-settings-5.pxm
Binary file not shown.
Binary file added ArtSources/docs/images/unity-xr-settings-6.pxm
Binary file not shown.
Binary file added ArtSources/docs/images/unity-xr-settings-7.pxm
Binary file not shown.
Binary file added docs/images/standalone-platform.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/unity-xr-settings-1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/unity-xr-settings-2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/unity-xr-settings-3.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/unity-xr-settings-4.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/unity-xr-settings-5.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/unity-xr-settings-6.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/unity-xr-settings-7.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/unity-xr-settings.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 32 additions & 0 deletions docs/xr-testing.md
@@ -0,0 +1,32 @@
# Enabling Virtual Reality player mode in Unity's XR Editor

## XR Settings

For rapid testing in your headset, you can enable Virtual Reality support in your [Unity project](./project-setup.md).

![Animation of Unity's XR Settings](./images/unity-xr-settings.gif "Animation of Unity's XR Settings")

1. Select the **`File > Build Settings…`** menu option from the top-level Unity application menu.
2. When the pop-up window appears, select to highlight the **`PC, Mac & Linux Standalone`** option in the **`Platform`** list. (When you are ready to [build your application for WebVR](./build.md), ensure that **`WebGL`** is still the selected platform.)

![Screenshot of "Platform" list in Unity's "Build Settings…" menu](./images/standalone-platform.png 'Screenshot of "Platform" list in Unity\'s "Build Settings…" menu')

3. Click the **`Player Settings…`** button at the bottom of the pop-up window. Or you can access the **`Player Settings…`** by selecting the **`Edit > Project Settings > Player`** menu option from the top-level Unity application menu.

![Screenshot of Unity's "Player Settings…" menu](./images/unity-xr-settings-5.png 'Screenshot of Unity\'s "Player Settings…" menu')

4. In the **`Inspector`** pane, click the tab for **`Settings for PC, Mac & Linux Standalone`** pane (i.e., the icon with the underlined down arrow), if the tab is not already selected.

![Screenshot of Unity's "Settings for PC, Mac & Linux Standalone" pane](./images/unity-xr-settings-6.png 'Screenshot of Unity\'s "Settings for PC, Mac & Linux Standalone" pane')

5. Click on the **`XR Settings`** title to expose the section if it is hidden. Enable the **`Virtual Reality Supported`** checkbox field.

![Screenshot of Unity's "XR Settings"](./images/unity-xr-settings-7.png 'Screenshot of Unity\'s "XR Settings"')

6. Notice that are two **`Virtual Reality SDKs`** listed, sorted in the order in which Unity attempts to enable VR devices at runtime or during VR preview:
- **`OpenVR`** (i.e., for the HTC Vive and Windows Mixed Reality headsets)
- **`Oculus`** (i.e., for the Oculus Rift and, soon, Oculus Go headsets)

When building for [WebVR](./build.md), ensure that the **`WebGL`** option is still selected in the **`Platform`** list (**`File > Build Settings…`**).

![Screenshot of "Platform" list in Unity's "Build Settings…" menu](./images/webgl-platform.png 'Screenshot of "Platform" list in Unity\'s "Build Settings…" menu')
Binary file removed img/build-settings.png
Binary file not shown.