Skip to content

Commit 16ec8fa

Browse files
authored
Merge pull request #99 from De-Panther/base_docs
Added basic documentation
2 parents cc769cc + 0b7f671 commit 16ec8fa

13 files changed

+61
-3
lines changed

Documentation/Getting-Started.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Getting Started
2+
3+
In this page, we have a step by step guide on how to build a project from the Sample Scene.
4+
5+
## Let's build some WebXR stuff
6+
7+
Create a new Unity Project (2019.4.7f1 and up). Switch platform to WebGL.
8+
9+
Import WebXR Export and WebXR Interactions packages from OpenUPM.
10+
- [WebXR Export ![openupm](https://img.shields.io/npm/v/com.de-panther.webxr?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.de-panther.webxr/)
11+
- [WebXR Interactions ![openupm](https://img.shields.io/npm/v/com.de-panther.webxr-interactions?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.de-panther.webxr-interactions/)
12+
13+
Once packages are imported, Go to `Window > WebXR > Copy WebGLTemplates`.
14+
15+
![Copy WebGLTemplates](unity-webxr-export-copy-webgltemplates.png)
16+
17+
After `WebGLTemplates` are in the `Assets` folder, Open the `XR Plug-in Management` tab in the `Project Settings` window and select the `WebXR Export` plug-in provider.
18+
19+
![XR Plug-in Management](unity-webxr-export-xr-plug-in-management.png)
20+
21+
Now you can import the `Sample Scene` from `Window > Package Manager > WebXR Interactions > Sample Scene > Import into Project`.
22+
23+
![Import Sample Scene](unity-webxr-export-import-sample-scene.png)
24+
25+
In `Project Settings > Player > Resolution and Presentation`, select `WebXR` as the `WebGL Template`. (If you are using Unity 2020.x you should use the 2020 templates)
26+
27+
![Resolution and Presentation](unity-webxr-export-resolution-and-presentation.png)
28+
29+
Now you can build the project.
30+
31+
![Build](unity-webxr-export-build.png)
32+
33+
Make sure to build it from `Build Settings > Build`. Unity's `Build And Run` server use HTTP. Run the build on your own HTTPS server.
34+
35+
![Result](unity-webxr-export-result.png)
36+
37+
That's it.

Documentation/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# WebXR Export - Documentation
2+
3+
This folder contains some docs and manuals, to help you use WebXR Export and WebXR Interactions.
62.2 KB
Loading
12.8 KB
Loading
88.5 KB
Loading
73.5 KB
Loading
445 KB
Loading
56 KB
Loading
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# WebXR Interactions - Documentation
2+
3+
To keep it simple to maintain, docs for WebXR Interactions can be found at [WebXR Export Documentation](https://github.com/De-Panther/unity-webxr-export/Documentation).

Packages/webxr-interactions/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,8 @@ To add the package to your Unity project using Git, open the Package Manager win
1818

1919
`https://github.com/De-Panther/unity-webxr-export.git?path=/Packages/webxr-interactions`
2020

21-
To update the package, you'll have to manually remove the corresponding package section from the `packages-lock.json` file. For more info read about [Git dependencies](https://docs.unity3d.com/Manual/upm-git.html) in Unity's manual.
21+
To update the package, you'll have to manually remove the corresponding package section from the `packages-lock.json` file. For more info read about [Git dependencies](https://docs.unity3d.com/Manual/upm-git.html) in Unity's manual.
22+
23+
## Sample Scene
24+
25+
You can import the `Sample Scene` from `Window > Package Manager > WebXR Interactions > Sample Scene > Import into Project`.

0 commit comments

Comments
 (0)