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.

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

Documentation changes for VR Client #269

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion content/player/general/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ date: 2018-01-01
title: Introduction
description: Decentraland is a virtual reality platform powered by Ethereum.
aliases:
- /login?redirect=docs
- /login/redirect=docs
- /docs
- /docs/
- /decentraland/introduction/
Expand Down
4 changes: 4 additions & 0 deletions content/player/general/vr-client/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
bookCollapseSection: true
weight: 21
---
43 changes: 43 additions & 0 deletions content/player/general/vr-client/vr-client-introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
date: 2023-09-21
title: Introduction
aliases:
description: Intro to the DCL VR Client.
categories:
- Decentraland
type: Document
url: /player/general/vr-client/vr-client-introduction
weight: 1
---

<b>
The Decentraland VR Client allows the a user to experience this Metaverse from within virtual reality!

</b>

This is where you will find instructions on how to set up and play Decentraland from your Meta Quest 2. In future sections, we will run through how to use Quest Link and the Oculus desktop app to play Decentraland on a PC/VR setup as well as show how you can side-load Decentraland directly onto you your Quest using SideQuest.

In certain ways, the decentraland VR-Client is not too different from the desktop version. In terms of how the world is setup, you will still be able to do things that other players can. The main difference is the way your viewing your environment (from within you headset), and how you interact with the world around you (with controllers instead of a keyboard and mouse).


---

### **Compatible Headsets**

- Currently, the native client supports the Meta Quest 2, and Pro headsets.
- The PCVR install has been tested with Meta Quest 2, Quest Pro, and Windows Mixed Reality headsets.




### **User Controls**

<img src="/images/media/VRClient/Quest Controllers.png" style="margin: 2rem auto; display: block;width: 70%;"/>


### **Known Issues**

- Many scenes were not created with VR experiences in mind, and may not be fully playable as a VR experience. This may mean that certain elements may not interact correctly with controllers, or objects that can be picked up may be placed awkwardly. Some objects may respond to a trigger click, while others may only respond to X (E) or Y (F).

- You can modify settings within the Decentraland settings menu, such as the graphics settings to acheive better quality, but some settings such as Bloom will cause rendering issues, especially around Genesis Plaza. Other settings such as Parcel Load Radius can be raised, but increases the amount of models in memory and can lead to low frame rate, instability and crashing on Android.

114 changes: 114 additions & 0 deletions content/player/general/vr-client/vr-client-pcvrsetup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
---
date: 2023-31-01
title: PCVR Client Setup
aliases:

description: How a user can set themselves up to play Decentraland using PC/VR.
categories:
- Decentraland
type: Document
url: /player/general/vr-client/vr-client-pcvrsetup
weight: 2
---

{{< hint warning >}}
**📔 Note**: If you're interested in playing the PCVR version, refer to the [Hardware Requirements](https://docs.decentraland.org/player/general/hardware-requirements/) for more information about what your PC needs to be able to play Decentraland.
{{< /hint >}}


**This section will help you get set to play Decentraland using PCVR! We will walk through the steps we need to set up your headset, download the game, and launch it in your headset.**


---
# Using the Quest App

Meta has already created some articles and documentation on many of the features of the Quest 2. To set up Air Link,


- Visit the [Meta Quest Link page](https://www.meta.com/help/quest/articles/headsets-and-accessories/oculus-link/) page and scroll down to the "Air Link" section.

- The dropdown titled "Connect Meta Quest Pro or Meta Quest 2 to your PC with Air Link" has the instructions you need to get your Quest 2 set up with Air Link. It will also help you to set up with the Oculus App, which is a required dependency for Air Link.

- If you haven't already, open the Oculus app and navigate to the settings. Click on the "General" tab and check to see if Oculus is set to be the active OpenXR Runtime. If not, click "Set Oculus as Active."

- After you have completed this, proceed to download the latest version of [DecentralandVR](https://sidequestvr.com/app/11626/decentraland-vr) on SideQuest by selecting "Download APP (PCVR)" on the download dropdown.

<img src=\images\media\VRClient\SideQuestPCVR.png style="margin: 2rem auto; display: block;width: 35%;"/>


## Launch Quest Link and Play the Game
Once you have completed the previous steps, you should be ready to launch the Air Link and play the game. Follow the steps listed below to do just that!



- Open your universal Menu with the Oculus button on your right Touch controller. Navigate to your "Quick Settings" menu by hovering on the clock on the far left of the universal menu.

- Click on "Quest Link." Make sure that "Use Air Link" is enabled at the top.

- Select your PC from the "Available PCs" list and click Pair.

- You will see a pairing code appear in your headset. If you look back at your Oculus app, you should see the same pairing code. Click "Confirm" in the desktop app if it matches.

{{< hint warning >}}
**📔 Note**: If you do not see a paring code, ensure that your headset and desktop app are fully up to date.
{{< /hint >}}

- Click "Launch" back in the headset to start using Air Link.

- If you haven't already, unzip the DecentralandVR game file we downloaded earlier. Open the unzipped folder, and open the "DecentralandVR.exe" application.

{{< hint warning >}}
**📔 Note**: A window may pop up from windows defender saying that it blocked the app from opening since it was from an unknown publisher. Click "See More" or "More" and then click "Run Anyway."
{{< /hint >}}



You should now be able to play Decentraland in your Oculus Quest! You will be able to sign in with your Wallet or opt to play as a Guest. Refer to other sections in the documentation for more information on how to play Decentraland in VR.



# Using SteamVR

Setting Up with SteamVR:
Install Steam and SteamVR:

If you haven’t already, download and install Steam.
Next, search for and install SteamVR from the Steam store.
Connect Your VR Headset:

Ensure that your VR headset is properly connected to your PC.
Launch SteamVR from Steam. You should see the status icons at the bottom showing that your headset and controllers (if any) are tracked.
Download DecentralandVR through SteamVR:

Navigate to the DecentralandVR page on Steam (Note: You might want to provide an actual link here if the game is available on Steam).
Click on "Add to Library" and then download and install the game.
Launch DecentralandVR.exe:

With SteamVR running and your headset connected, navigate to your library and launch DecentralandVR.
{{< hint info >}}
📔 Note: Ensure that SteamVR recognizes your VR headset and controllers correctly before launching Decentraland. Adjust the room setup if necessary using SteamVR's Room Setup tool.
{{< /hint >}}

# Using Windows Mixed Reality:
Setting Up with Windows Mixed Reality (WMR):
Set Up Your WMR Headset:

Connect your WMR headset to your PC and ensure it's recognized.
If this is your first time using WMR, follow the on-screen instructions to set up the play area and calibrate your controllers.
Install WMR for SteamVR:

Open Steam and search for Windows Mixed Reality for SteamVR.
Download and install this tool. It will act as a bridge between WMR and SteamVR.
Download DecentralandVR:

Navigate to the DecentralandVR page on Steam (Note: Provide an actual link here if the game is available on Steam).
Click "Add to Library" and then download and install the game.
Launch DecentralandVR:

With WMR running, open Steam and launch SteamVR.
After SteamVR initializes and recognizes your WMR headset, navigate to your library and launch DecentralandVR.
{{< hint info >}}
📔 Note: For an optimal experience, ensure you've updated to the latest drivers for your WMR headset and graphics card.
{{< /hint >}}


52 changes: 52 additions & 0 deletions content/player/general/vr-client/vr-client-settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
date: 2023-09-21
title: VR Client Login Screen
aliases:
description: Intro to the DCL VR Client.
categories:
- Decentraland
type: Document
url: /player/general/vr-client/vr-client-settings
weight: 4
---

### **Startup Screen**

The Startup Screen provides methods to sign into Decentraland, as well as some customization options for those that want to utilize advanced functionality.
You will also be able to sign in with your wallet, or opt to play as a guest.

<b>Wallet </b>

<img src="/images/media/VRClient/LoginScreen.png" style="margin: 2rem auto; display: block;width: 70%;"/>

Wallet options that work within the VR client is:<br>
* **Fortmatic:** Allows signing in using an email or phone number.<br>
* **WalletConnect:** Allows signing in using a QR code. Works with the Metamask phone application. PCVR duplicates the QR code to the monitor screen. Android requires scanning the QR code through the headset lens.
* **CoinBase:** Allows signing in using a QR code. Works with the Coinbase phone application. PCVR duplicates the QR code to the monitor screen. Android requires scanning the QR code through the headset lens.

### **Settings Screen**
<img src="/images/media/VRClient/VRSettingsButton.png" style="margin: 2rem auto; display: block;width: 20%;"/>

<img src="/images/media/VRClient/StartupSettings.png" style="margin: 2rem auto; display: block;width: 70%;"/>

Some of these settings require restarting the application after modifying to apply. <br>
<B>Use New UI:</B> allows you to switch between the graphical login and browser view. Helpful if something in the UI breaks.<br>
<B>Open Browser on Start:</b> Disabling this requires opening the browser manually. Do not do on Android native build.<br>
<B>Internal Browser:</b>On uses the embedded webview. Off uses your default browser. Do not turn off for Android native build.<br>
<B>WebSocket SSL:</b>Turn on to use SSL certificate for .org base url mode. Turn off for Android native build<br>
<B>BaseURLMode:</b>Allows to set to use .org or .zone website. play.decentraland.org requires SSL turned on. play.decentraland.zone requires SSL turned off Android native build only works with .zone with ssl turned off.<br>
<B>Network:</b>Mainnet or Sepolia etherium networks<br>
<B>Start in coords:</b>Initial coordinate settings<br>
<B>Solo Scene:</b>If enabled, only the single parcel will load<br>
<B>Disable Asset Bundles:</b>Asset Bundles are optimized models to import for each scene. Turning this on will default to importing the original gltf models. Asset bundles are not built for android native builds currently so enabling this will help models load in faster.<br>
<B>Kernel Version:</b>Setting a specific kernel version will use that version. This might be helpful if something changes in the future that breaks functionality between new versions of the VR client<br>
<B>Catalyst:</b>If you have a personal catalyst set up running your own customized version of Decentraland, you can set it here<br>
<B>Realm:</b>You can set your default realm or automatically load into your own world by setting this field. <br>
<B>Use Custom Content Server:</b>Enabling this will allow you to connect to a specific content server if you build your own asset bundle server.<br>
<B>Custom Content Server:</b>the URI to your custom content server<br>
<B>Enable Debug Mode:</b>Enables Decentralands internal debugger<br>
<B>Debug Panel Mode:</b>Debugs the Scene or the Engine<br>
<B>Multithreaded Download:</b>Enabled allows multithreaded download of scene contents. This will speed up loading based on network and hardware capabilities. It is generally advised to allow this.<br>
<B>Disable GLTF Download Throttle:</b>Turning this on removes the thread count limit which allows faster loading, but can cause instability based on your system.<br>
<B>Restart Application to Apply Changes:</b>This closes the application so you can re-open it to open a session running the changed settings.<br>
<B>Reset All Settings:</b>This resets the settings to the default settings. Settings can also be manually modified or backed up in your applications persistent data folder. For PCVR this will be "C:\Users\<user>\AppData\LocalLow\Decentraland\Decentraland\vrsettings1.2.dat"<br>
42 changes: 42 additions & 0 deletions content/player/general/vr-client/vr-client-sidequest-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
date: 2023-09-21
title: Quest Android Setup
aliases:

description: How to use SideQuest to side load the VR client and play directly on the headset.
categories:
- Decentraland
type: Document
url: /player/general/vr-client/vr-client-sidequest-setup
weight: 3
---

Did you know that you can also play Decentraland directly on your Meta Quest by sideloading the app through SideQuest?! If you don't already use SideQuest, this section will walk you through how to set it up, and use it to sideload the Decentraland app directly onto your headset.

## Get SideQuest

- To get started visit SideQuest's website and look at ["Get SideQuest"](https://sidequestvr.com/setup-howto). This page will give you all the information on how to set up an account and download SideQuest.
{{< hint warning >}}
**📔 Note**: You will need to enable developer mode onto your headset before you will be able to sideload apps. To do this, if you haven't already, you will need to first set up a developer account with Meta. These instructions should be outlined in the SideQuest setup documentation, but you can also follow Meta's instructions [here.](https://developer.oculus.com/documentation/native/android/mobile-device-setup/)
{{< /hint >}}

## SideLoad the App
- After you have finished the SideQuest setup, open up SideQuest and head to the homepage. Once there, you should be able to search for "Decentraland VR" using the search bar the centered close to the top of your screen. Click on it to navigate to the game's main page.
[Decentraland on SideQuest](https://sidequestvr.com/app/11626/decentraland-vr)
- Connect your headset to the computer with a USB-C cable.
> *Double check that your headset is connected by looking to see if has the headset's name showing in the top left of your SideQuest window* (i.e. *"Oculus Quest 2"*).

- Once it's connected, in SideQuest, press the "Download App (SideLoad)" button to download the app on your headset. The app will notify you of when the install is completed.

## Play the Game!

- After the app has been downloaded, put on your headset and open the universal menu. Navigate to you App Library on the headset and select the search bar and filter to the Unknown Sources list.

- Head to the dropdown on the top furthest to the right, and switch to the the "Unknown Sources" section. Note that all of you sideloaded apps will appear under this section.

- Launch the "DecentralandVR" App.

You should now be able to play Decentraland in your Oculus Quest! You will be able to sign in with your Wallet or opt to play as a Guest. Refer to other sections in the documentation for more information on how to play Decentraland in VR.

## Notes for the Quest Native Android application:
You can modify settings within the Decentraland settings menu, such as the graphics settings to acheive better quality, but some settings such as Bloom will cause rendering issues, especially around Genesis Plaza. Other settings such as Parcel Load Radius can be raised, but increases the amount of models in memory and can lead to low frame rate, instability and crashing.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
@ echo off
FOR %%F IN (*.GLB) DO (
start "" /b GLTF-PIPELINE -i "%%F" -t -o "out/%%F"
)
@ echo off

FOR %%F IN (*.GLB) DO (
start "" /b GLTF-PIPELINE -i "%%F" -t -o "out/%%F"
)
PAUSE
Binary file added static/images/media/VRClient/LoginScreen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/media/VRClient/SideQuestPCVR.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/media/VRClient/StartupSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/media/VRClient/VRSettingsButton.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.