GettingStarted.md

Getting Started

These are the steps for getting up and running quickly with MR-MUSK.

Create Unity Project

First you'll need a Unity project. If you already have one, great! Feel free to use it. If you're starting from scratch we recommend Unity 2022.3.19f1. Install Unity Hub then click here to install the right editor version. During installation, be sure to include Android Build Support since Quest devices are based on Android.

When creating your project we recommend 3D URP, but standard 3D is also fine.

Add Normcore Registry

This starter kit uses Normcore for networking, but Normcore distributes its packages through their own package server. We need to add their scoped registry to our project or Unity won't know how to find their packages.

1. Click on Edit > Project Settings > Package Manager

2. Under Scoped Registries, add the following information:

Name: Normal
URL: https://normcore-registry.normcore.io
Scope(s): 
com.normalvr
io.normcore

When you're done it should look like this:

Add MRMUSK Package

Now we can add the starter kit to our project.

1. Go to Window -> Package Manager

2. Click the '+' dropdown in the top-left corner and choose Add Package from git URL.

   

3. In the URL field enter:

   https://github.com/SolerSoft/mr-musk.git?path=/Assets/Packages/com.solersoft.mrmusk
   

4. Click the Add button

This process may take a minute or two since it's installing MR-MUSK, Normcore and all of the Oculus SDK. You may also be prompted to restart the Unity editor during installation.

Oculus Setup

Now that the Oculus SDK is part of our project, we need to configure it.

1. Click on File > Build Settings

2. Select Android and click Switch Platform (this will take a minute)

   

3. Click on Edit > Project Settings > XR Plugin Management then click the Install XR Plugin Management button.

   

   (This button won't exist if XR is already installed in your project.)

4. Under XR Plugin Management, check the box for Oculus.

   

5. Under XR Plugin Management > Oculus, check the box for Quest 3.

   

6. Under Edit > Project Settings > Oculus, click Fix All and Apply All to resolve any issues.

   

Scene Setup

Now we need to configure our scene for Mixed Reality on the Quest. The easiest way to do this is to import the sample scenes that come with MR-MUSK.

1. Click on Window > Package Manager

2. Select MRMUSK in the list on the left

3. Click on the Samples tab

4. Click the Import button next to Starter Samples

   

5. Then, in Project Explorer, go to Samples\MRMUSK#.#.#\Starter Samples\Scenes.

   

   You can use the MRMUSK MR Test scene as a starting point for your project.

If you want to add MR-MUSK to an existing scene, here's what we recommend:

• Camera Rig building block

• Passthrough building block

• Controller building block

• MRMUSK MR prefab

• (Optional) Hand Tracking building block

• (Optional) Synthetic Hands building block

• (Optional) NetworkGrabbableCube prefab

IMPORTANT: Don't forget to configure the building blocks after adding them. For example, Camera Rig > Passthrough Support has to be either Supported or Required, even if the Passthrough block has been added.

Configure Normcore

The last step before pressing Play or deploying to a device is configuring Normcore.

1. In your Unity scene, find and expand the MRMUSK MR prefab

2. Select the Realtime child object

   

3. In the Inspector window, paste in your App Key.

   

If you are a University student, your professor will likely provide this key to you. Otherwise, you can create your own account at Normal.io then create an application to get an App Key.

TIP: It's also a good idea to use a custom Room Name if multiple students are sharing the same App Key. Otherwise you might have some unexpected guests!