Merge pull request #11 from fundale/main

Basis VR on Linux

Author: towneh

docs/avatars.mdx

@@ -7,7 +7,7 @@ title: Avatars
 ## Set up the Unity Editor
 - As per the [Getting Started](/docs/getting-started#installing-unity) section for installing the latest supported Unity editor version and acquiring the Basis framework.
 - Open Unity Hub and add an existing project, choose the extracted/cloned Basis project folder
-- On the initial project load you will see the following prompt, please hit 'Restart Editor'.
+- On the initial project load you will see the following prompt, please hit 'Restart Editor'.<br />
 ![image](..\static\img\avatars\0.png)
 - Once the project has loaded, you can now load in your Avatar files:
 - Either,

docs/getting-started.mdx

@@ -25,11 +25,15 @@ Add the following modules via the "Add modules" screen when installing the Unity
 |_ &check; OpenJDK<br />
 |_ &check; Android SDK & NDK Tools<br />
 &check; Linux Build Support (IL2CPP)<br />
-&check; Linux Build Support (Mono)<br />
-&check; Windows Build Support (IL2CPP)
+&check; Linux Build Support (Mono) \[Windows Only\]<br />
+&check; Windows Build Support (IL2CPP) \[Windows Only\]<br />
+&check; Windows Build Support (Mono) \[Linux Only\]
 :::info
 Even if you only are only building user generated content for Avatar and World creation, you will still these additional modules for making this content available on these platforms.
 :::
+:::tip
+If you have the correct Unity version already installed but the "Add Modules" option isn't available it was likely installed externally from Unity Hub, please reinstall the correct Unity version from Unity Hub.
+:::
 
 # Acquiring the Basis framework
 ## Git

docs/linux.mdx

@@ -0,0 +1,54 @@
+---
+id: linux
+title: Building from Linux
+---
+
+:::warning
+Linux support is experimental and may have extra issues.
+:::
+:::note
+It is not recommended to build a Windows or Android build from Linux currently as they will likely be missing features or not function at all.
+:::
+
+This page assumes you have gone through [Getting Started](/docs/getting-started) first.
+
+# Linux prerequisites
+:::danger
+**Do not commit the removal of the Utilites listed on this doc page!**
+They are required for building Windows and Android clients!
+:::
+
+In order to build anything Basis under Linux you need to remove `com.meta.xr.sdk.core` "Meta XR Core SDK" and `com.unity.xr.openxr` "OpenXR Plugin" via the [Unity Package Manager](https://docs.unity3d.com/6000.0/Documentation/Manual/upm-ui.html),<br />
+You may need to install `com.unity.toolchain.linux-x86_64` "Toolchain Linux x64" but Unity should install that for you.
+
+![image](..\static\img\linux\1.png)
+![image](..\static\img\linux\2.png)
+
+
+# Building .BEE files from Linux
+For building .bee files for Windows and Android from a Linux Editor you will need to delete the `Assets/Basis/Profiles/HTCViveTrackerProfile.cs` file and set the "Scripting Backend" to `Mono` under `Edit > Project Settings > Player > Configuration > Scripting Backend`.
+
+![image](..\static\img\linux\3.png)
+![image](..\static\img\linux\4.png)
+
+# Building a native Linux client from Linux
+:::tip
+It is recommended to change your "Scripting Backend" to `IL2CPP` for better performance.
+![image](..\static\img\linux\3.png)
+![image](..\static\img\linux\5.png)
+:::
+
+- Make sure you have [removed the unsupported packages](/docs/linux#linux-prerequisites) first.
+- Make sure you *do not* have `Use Scene Provided Here` checked from [World Testing](/docs/worlds#test-the-scene).
+
+Then build Basis as you would normally.
+
+# Basis VR on Linux
+You may need to launch Basis with the `OXR_PARALLEL_VIEWS=1` environment variable and `--force-OpenVRLoader` flag for it to function properly in VR:<br />
+`OXR_PARALLEL_VIEWS=1 ./basis.x86_64 --force-OpenVRLoader`
+
+You do not use these when launching for Desktop.
+
+# Other Info
+- Last tested working on branch `#developer` commit `70a695d11082a2806f0933145d448143207c72e4`<br />
+https://github.com/BasisVR/Basis/commit/70a695d11082a2806f0933145d448143207c72e4