Skip to content

Commit a906041

Browse files
authored
Merge pull request #41 from keveleigh/update-readme
Update link to MRTK folder in readme
2 parents d8fa5cf + 454eef7 commit a906041

File tree

2 files changed

+15
-12
lines changed

2 files changed

+15
-12
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.vs
2+
.vscode
23
/SimpleWebXR-DemoUWPTempPath
34
/SimpleWebXR-DemoLibrary
45
*.csproj

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,26 @@ Thus, after a Unity [WebGL build](https://docs.unity3d.com/Manual/webgl-gettings
1717
# Compatible browsers
1818
Works on :
1919
- [Google Chrome](https://play.google.com/store/apps/details?id=com.android.chrome) on Android (:warning: a secure https connection is required)
20-
- [Edge](https://docs.microsoft.com/fr-fr/windows/mixed-reality/new-microsoft-edge) on Windows 10 for Mixed Reality Headsets
21-
- [Edge](https://docs.microsoft.com/en-us/hololens/hololens-insider#introducing-the-new-microsoft-edge) on Hololens 2
22-
- [Firefox Reality](https://www.microsoft.com/en-gb/p/firefox-reality/9npq78m7nb0r?activetab=pivot:overviewtab) on Hololens 2
23-
- [Mozilla WebXR Viewer](https://apps.apple.com/fr/app/webxr-viewer/id1295998056) on iOS (:warning: WebGL 2.0 should be disabled, it's a Webkit experimental feature)
24-
- [Oculus Browser](https://developer.oculus.com/webxr/?locale=fr_FR) on Oculus Quest 1 and 2
25-
- [Firefox emulator](https://addons.mozilla.org/fr/firefox/addon/webxr-api-emulator/) on desktop
20+
- [Edge](https://docs.microsoft.com/windows/mixed-reality/new-microsoft-edge) on Windows 10 for Mixed Reality Headsets
21+
- [Edge](https://docs.microsoft.com/hololens/hololens-insider#introducing-the-new-microsoft-edge) on Hololens 2
22+
- [Firefox Reality](https://www.microsoft.com/p/firefox-reality/9npq78m7nb0r?activetab=pivot:overviewtab) on Hololens 2
23+
- [Mozilla WebXR Viewer](https://apps.apple.com/app/webxr-viewer/id1295998056) on iOS (:warning: WebGL 2.0 should be disabled, it's a Webkit experimental feature)
24+
- [Oculus Browser](https://developer.oculus.com/webxr/) on Oculus Quest 1 and 2
25+
- [Firefox emulator](https://addons.mozilla.org/firefox/addon/webxr-api-emulator/) on desktop
2626
- [Chrome emulator](https://chrome.google.com/webstore/detail/webxr-api-emulator/mjddjgeghkdijejnciaefnkjmkafnnje) on desktop
2727

2828
---
2929

3030
# Integration examples
3131

3232
## MRTK
33+
3334
[Mixed Reality Toolkit](https://github.com/microsoft/MixedRealityToolkit-Unity) is a Microsoft-driven project that provides a set of components and features, used to accelerate cross-platform MR app development in Unity. It supports Hololens, Windows Mixed Reality headset, OpenVR, Ultraleap, Mobile devices and now **WebXR** !
3435

35-
The files in directory [/Assets/SimpleWebXR/Scripts/MRTK-Providers](https://github.com/Rufus31415/Simple-WebXR-Unity/tree/master/Assets/SimpleWebXR/Scripts/MRTK-Providers) add WebXR capabilities to MRTK with the following functions: controller tracking, **hand** tracking, hand ray, index pointer, grip pointer and spatial pointer. Teleportation could be added.
36+
The files in directory [/SimpleWebXR-Demo/Assets/SimpleWebXR/Scripts/MRTK](https://github.com/Rufus31415/Simple-WebXR-Unity/tree/master/SimpleWebXR-Demo/Assets/SimpleWebXR/Scripts/MRTK) add WebXR capabilities to MRTK with the following functions: controller tracking, **hand** tracking, hand ray, index pointer, grip pointer and spatial pointer. Teleportation could be added.
37+
38+
LIVE DEMO:
3639

37-
LIVE DEMO :
3840
- Hand interaction : [▶️ https://rufus31415.github.io/webxr/MRTK-HandInteraction](https://rufus31415.github.io/webxr/MRTK-HandInteraction/)
3941
- Color picker : [▶️ https://rufus31415.github.io/webxr/MRTK-ColorPicker](https://rufus31415.github.io/webxr/MRTK-ColorPicker/)
4042
- Elastic menus : [▶️ https://rufus31415.github.io/webxr/MRTK-ElasticSystem](https://rufus31415.github.io/webxr/MRTK-ElasticSystem/)
@@ -178,7 +180,7 @@ First create a new 3D project
178180

179181
Download the latest release of SimpleWebXR : https://github.com/Rufus31415/Simple-WebXR-Unity/releases
180182
- ```SimpleWebXR.unitypackage```: contains only SimpleWebXR and its demo scenes
181-
- ```SimpleWebXR+MRTK.unitypackage``` : contains SimpleWebXR addon for MRTK. MRTK should be initialized in your project, see : https://docs.microsoft.com/fr-fr/windows/mixed-reality/mrtk-unity/
183+
- ```SimpleWebXR+MRTK.unitypackage``` : contains SimpleWebXR addon for MRTK. MRTK should be initialized in your project, see : https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/
182184

183185

184186
Open the unitypackage file and import all resources : in tab ```Project```, right click on ```Assets > Import Package > Custom Package```
@@ -198,10 +200,10 @@ Select the WebGL plateform and click ```Switch platform```. Then click the ```Bu
198200

199201
Your browser should be compatible with WebXR. For a first try, you can install the emulator :
200202
- For Chrome : https://chrome.google.com/webstore/detail/webxr-api-emulator/mjddjgeghkdijejnciaefnkjmkafnnje
201-
- For Firefox : https://addons.mozilla.org/en-US/firefox/addon/webxr-api-emulator
203+
- For Firefox : https://addons.mozilla.org/firefox/addon/webxr-api-emulator
202204

203205
You now need a http server to serve you files. I recommend this one : https://www.npmjs.com/package/http-server
204-
- Just download node.js : https://nodejs.org/en/
206+
- Just download node.js : https://nodejs.org/
205207
- install the server in your system with the command ```npm install --global http-server```
206208

207209

@@ -235,7 +237,7 @@ Just add these 3 files in your Unity Asset folder, then add SimpleWebXR MonoBeha
235237
## Download Unity Package
236238
Download the latest release of SimpleWebXR from : https://github.com/Rufus31415/Simple-WebXR-Unity/releases
237239
- ```SimpleWebXR.unitypackage```: contains only SimpleWebXR and its demo scenes
238-
- ```SimpleWebXR+MRTK.unitypackage``` : contains SimpleWebXR addon for MRTK. MRTK should be initialized in your project, see : https://docs.microsoft.com/fr-fr/windows/mixed-reality/mrtk-unity/
240+
- ```SimpleWebXR+MRTK.unitypackage``` : contains SimpleWebXR addon for MRTK. MRTK should be initialized in your project, see : https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/
239241

240242
## Add from Package Manager
241243

0 commit comments

Comments
 (0)