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.

Sign up for GitHub

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

Jump to bottom

Typo in usage section #710

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Typo in usage section #710

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions neon/neon-xr/MRTK3-template-project/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# MRTK3 Template Project

Check warning on line 1 in neon/neon-xr/MRTK3-template-project/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (MRTK)
The [Mixed Reality Toolkit 3 (MRTK3)](https://learn.microsoft.com/en-us/windows/mixed-reality/mrtk-unity/mrtk3-overview/) is a collection of scripts and components that make it easy to build XR applications for a variety of platforms. We provide a template project for the MRTK3 with Neon XR already integrated to kickstart your development.

Check warning on line 2 in neon/neon-xr/MRTK3-template-project/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (MRTK)

Check warning on line 2 in neon/neon-xr/MRTK3-template-project/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (MRTK)

The template contains several demo scenes that showcase how to use Neon XR with MRTK3, including e.g. the following scenes demonstrating gaze-based interaction:

Check warning on line 4 in neon/neon-xr/MRTK3-template-project/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (MRTK)

<Youtube src="2e8kRTn3NJI" />

## Running the Template Project
If you just want to try out the demo scenes included in the template project in action, you can download and install a pre-built APK. The APKs a platform-specific and we currently only offer one for the Pico 4 headset. You can download it at this link:

Check warning on line 9 in neon/neon-xr/MRTK3-template-project/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (Pico)

[Pico 4 - MRTK3 Template Project](https://drive.google.com/file/d/1WaJxx6wgQNKFfpGUAPKxbOfHZ49kXJgW/view?usp=sharing)

Check warning on line 11 in neon/neon-xr/MRTK3-template-project/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (Pico)

Check warning on line 11 in neon/neon-xr/MRTK3-template-project/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (MRTK)

To install it, simply open the link in the browser of your Pico 4 headset, download the file and open it.

Check warning on line 13 in neon/neon-xr/MRTK3-template-project/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (Pico)

## Building the Project

Expand All @@ -21,10 +21,10 @@
git clone git@github.com:pupil-labs/MixedRealityToolkit-Unity.git
```

Depending on your target platform the required setup may differ slightly as some platforms require e.g. specific SDKs. Here we provide instructions for the Pico 4 as well as generic instructions that can be adapted to other platforms.

Check warning on line 24 in neon/neon-xr/MRTK3-template-project/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (Pico)


### Pico 4

Check warning on line 27 in neon/neon-xr/MRTK3-template-project/index.md

View workflow job for this annotation

GitHub Actions / ✍️ Check spelling 

Unknown word (Pico)
Follow these steps to setup the template project for the Pico 4 headset:
1. Checkout the `neon-pico` branch which is setup to use the PICO Unity Integration SDK.
```
Expand Down Expand Up @@ -65,5 +65,5 @@

## Usage

All the pre-configured sampe scenes that work with Neon XR start with a `PL_` prefix, e.g. `PL_HandInteractionExamples`. Check them out!
<!-- TODO: Add descriptions of all available scenes. Add instructions on how to switch between scenes when running the app. -->
All the pre-configured sample scenes that work with Neon XR start with a `PL_` prefix, e.g. `PL_HandInteractionExamples`. Check them out!
<!-- TODO: Add descriptions of all available scenes. Add instructions on how to switch between scenes when running the app. -->
Loading