stevenfour/OculusSdk · Datasets at Hugging Face

text stringlengths 0 1.11k

After cloning the repo, you can run the showcase by opening the project folder in Unity and opening the scene located at Assets/SharedSpaces/Scenes/Startup.

Set up a new Quest Dev Center App

After opening the showcase in your Unity project, you will need to set up a new app in the Meta Quest Developer Center.

After logging into your organization, select Create a New App to open the window.

Enter a name for your app and, because this is a showcase app, it is recommended that you select the Quest (App Lab) platform.

Dev Center App Type

Once finished, click Create and your new app will be created and added to your organization.

Next, select the API tab and to view your App ID. The App ID for your created app will be used when initializing the Platform SDK for your app.

Destinations
Now that you’ve cloned SharedSpaces app, and created a corresponding app in your Meta Quest Developer Center, you will need to create the associated destinations for the showcase app.

Destinations are designated places in your app such as a level, map, multiplayer server, or a specific configuration of an activity that can be deep linked to for users to immediately join an experience.

Destinations in your app can be configured to provide the most relevant context based on the user’s activity and whether they are in a joinable state or not.

To begin setting up Destinations for your app, navigate to the Meta Quest Developer Center and select Platform Services.

Dev Center Platform Services

In Platform Services you will see a grid with all of the currently available Platform Services that can be enabled for your selected app.

Platform Services Grid

Use the following steps to create a new destination for your app:

Select Add Service under the Destinations option, then select either Create a Single Destination or Create Multiple Destinations.
When selecting Create a Single Destination you will be taken to the New Destination page. New Destination Setup
Enter the details for your destination into the available fields and ensure that the Deeplink Type is set to Enabled and the Audience is set to Everyone.
Select Submit for Review when finished.
For this example, your Destinations should consist of: The Lobby, The Red Room, The Green Room, The Blue Room, and The Purple Room. The Purple Room is set as a public room in this app.

Complete Destinations Setup

If you choose to create multiple destinations, you can upload a .TSV file containing the details for all the destinations in your app. A template for creating multiple destinations can be downloaded from the Create Multiple Destinations window.

In the template, it’s important to only use approved destination headers. More information about the approved destinations headers can be found on Destinations Implementation.

Once your destinations are created, you can view and edit them on the Destinations screen.

Reporting Services
Any multiplayer application in the Quest ecosystem must have reporting capabilities for users to report behavior that conflicts with the Code of Conduct for Virtual Experiences. The available options for user reporting are the User Reporting Plugin and the User Reporting Service.

The User Reporting Plugin can be implemented into your app by connecting your pre-existing reporting flow to your Meta Quest app. Once implemented, users can access your reporting flow by pressing the Meta Quest button button.

Check the User Reporting Plugin documentation for detailed implementation information.

The User Reporting Service is housed in the Meta Quest Developer Center, and can be configured for your app after it is created. Check the User Reporting Service documentation for detailed information about the service, or use the following steps for quick set up instructions.

Use the following steps to set up the User Reporting for your app:

Select the User Reporting tab from the left hand menu to open the Customize User Reporting screen. User Reporting
In the Receive reports by email field enter an email address that user reports will be directed to. These emails are encrypted on the Meta servers and deleted when the email is sent to protect user information.
Select the Report reasons you’d like users to select from when creating a report. It is recommended that you select between 5 and 7 reasons to ensure users are able to make an accurate choice for the report they want to send.
You can optionally customize the reporting flow by adding both custom reasons or localization and a branding image to your reporting flow. Custom Reports
Once finished, click Activate to enable the User Reporting Service for your app.
Data Use Checkup
Next you will have to complete a Data Use Checkup to enable Platform Services for your app. The Data Use Checkup is required for your app to access certain platform features for multiplayer experiences. Your app’s access to platform features is contingent upon a successful review of its Data Use Checkup.

Use the following steps to setup and complete the app’s Data Use Checkup:

Select the Data Use Checkup tab from the left hand Quest menu.
In the Request to Access Platform Features section select the following options and usage options:
User ID, User Profile, Deep Linking, Friends, Invites
Use Destinations, Group Presence and App Deep Linking
Use Multiplayer with Photon/Playfab
View Oculus username
Display friends to invite
Enable users to invite others
Once finished click Submit Requests and a summary of your selected choices will appear in the request window. Data Use Checkup Window You must have a privacy policy in place prior to completing your Data Use Checkup. Paste the link for your privacy policy into the Privacy Policy URL field.
Select the compliance check-box then click Submit for Review to submit your Data Use Checkup requests.
Once finished, the selected Platform features will be set to Approved.

Setup Photon Account for Networking

After setting up Group Presence in your project, you will need to select and implement a networking solution for your app. In Shared Spaces, this solution is Photon networking.

First you’ll need to configure the NetDriver with your own Photon account. To set up a Photon account, do the following:

Visit photonengine.com and create a user account.
After creating your account, you will be on the Photon dashboard. Click Create a New App.
Ensure that the Application Type is set to Multiplayer Game and the Photon SDK is set to Realtime.
After finishing the new app form, set the type to “Photon Realtime” then click Create.
Next you will need the App ID from your created app. You can find and copy the App ID string from the Photon dashboard where your newly created Photon Realtime app will be displayed.

Note: Be sure to keep your Photon App ID somewhere secure.

Paste your App ID in the Assets/Photon/Resources/PhotonAppSettings folder and the Photon Realtime transport should now be enabled. You can verify that the transport is working by checking for networking traffic on the dashboard on your Photon account.

Build SharedSpaces in Unity
After completing setup in the Meta Quest Developer Center and setting up networking with Photon, you are now ready to configure the SharedSpaces showcase app in Unity and run it on a Quest headset.

After cloning the repo, you can run the showcase by opening the project folder in Unity and opening the scene located at Assets/SharedSpaces/Scenes/Startup.

Set up a new Quest Dev Center App

After opening the showcase in your Unity project, you will need to set up a new app in the Meta Quest Developer Center.

After logging into your organization, select Create a New App to open the window.

Enter a name for your app and, because this is a showcase app, it is recommended that you select the Quest (App Lab) platform.

Dev Center App Type

Once finished, click Create and your new app will be created and added to your organization.

Next, select the API tab and to view your App ID. The App ID for your created app will be used when initializing the Platform SDK for your app.

Destinations

Now that you’ve cloned SharedSpaces app, and created a corresponding app in your Meta Quest Developer Center, you will need to create the associated destinations for the showcase app.

Destinations are designated places in your app such as a level, map, multiplayer server, or a specific configuration of an activity that can be deep linked to for users to immediately join an experience.

Destinations in your app can be configured to provide the most relevant context based on the user’s activity and whether they are in a joinable state or not.

To begin setting up Destinations for your app, navigate to the Meta Quest Developer Center and select Platform Services.

Dev Center Platform Services

In Platform Services you will see a grid with all of the currently available Platform Services that can be enabled for your selected app.

Platform Services Grid

Use the following steps to create a new destination for your app:

Select Add Service under the Destinations option, then select either Create a Single Destination or Create Multiple Destinations.

When selecting Create a Single Destination you will be taken to the New Destination page. New Destination Setup

Enter the details for your destination into the available fields and ensure that the Deeplink Type is set to Enabled and the Audience is set to Everyone.

Select Submit for Review when finished.

For this example, your Destinations should consist of: The Lobby, The Red Room, The Green Room, The Blue Room, and The Purple Room. The Purple Room is set as a public room in this app.

Complete Destinations Setup

If you choose to create multiple destinations, you can upload a .TSV file containing the details for all the destinations in your app. A template for creating multiple destinations can be downloaded from the Create Multiple Destinations window.

In the template, it’s important to only use approved destination headers. More information about the approved destinations headers can be found on Destinations Implementation.

Once your destinations are created, you can view and edit them on the Destinations screen.

Reporting Services

Any multiplayer application in the Quest ecosystem must have reporting capabilities for users to report behavior that conflicts with the Code of Conduct for Virtual Experiences. The available options for user reporting are the User Reporting Plugin and the User Reporting Service.

The User Reporting Plugin can be implemented into your app by connecting your pre-existing reporting flow to your Meta Quest app. Once implemented, users can access your reporting flow by pressing the Meta Quest button button.

Check the User Reporting Plugin documentation for detailed implementation information.

The User Reporting Service is housed in the Meta Quest Developer Center, and can be configured for your app after it is created. Check the User Reporting Service documentation for detailed information about the service, or use the following steps for quick set up instructions.

Use the following steps to set up the User Reporting for your app:

Select the User Reporting tab from the left hand menu to open the Customize User Reporting screen. User Reporting

In the Receive reports by email field enter an email address that user reports will be directed to. These emails are encrypted on the Meta servers and deleted when the email is sent to protect user information.

Select the Report reasons you’d like users to select from when creating a report. It is recommended that you select between 5 and 7 reasons to ensure users are able to make an accurate choice for the report they want to send.

You can optionally customize the reporting flow by adding both custom reasons or localization and a branding image to your reporting flow. Custom Reports

Once finished, click Activate to enable the User Reporting Service for your app.

Data Use Checkup

Next you will have to complete a Data Use Checkup to enable Platform Services for your app. The Data Use Checkup is required for your app to access certain platform features for multiplayer experiences. Your app’s access to platform features is contingent upon a successful review of its Data Use Checkup.

Use the following steps to setup and complete the app’s Data Use Checkup:

Select the Data Use Checkup tab from the left hand Quest menu.

In the Request to Access Platform Features section select the following options and usage options:

User ID, User Profile, Deep Linking, Friends, Invites

Use Destinations, Group Presence and App Deep Linking

Use Multiplayer with Photon/Playfab

View Oculus username

Display friends to invite

Enable users to invite others

Once finished click Submit Requests and a summary of your selected choices will appear in the request window. Data Use Checkup Window You must have a privacy policy in place prior to completing your Data Use Checkup. Paste the link for your privacy policy into the Privacy Policy URL field.

Select the compliance check-box then click Submit for Review to submit your Data Use Checkup requests.

Once finished, the selected Platform features will be set to Approved.

Setup Photon Account for Networking

After setting up Group Presence in your project, you will need to select and implement a networking solution for your app. In Shared Spaces, this solution is Photon networking.

First you’ll need to configure the NetDriver with your own Photon account. To set up a Photon account, do the following:

Visit photonengine.com and create a user account.

After creating your account, you will be on the Photon dashboard. Click Create a New App.

Ensure that the Application Type is set to Multiplayer Game and the Photon SDK is set to Realtime.

After finishing the new app form, set the type to “Photon Realtime” then click Create.

Next you will need the App ID from your created app. You can find and copy the App ID string from the Photon dashboard where your newly created Photon Realtime app will be displayed.

Note: Be sure to keep your Photon App ID somewhere secure.

Paste your App ID in the Assets/Photon/Resources/PhotonAppSettings folder and the Photon Realtime transport should now be enabled. You can verify that the transport is working by checking for networking traffic on the dashboard on your Photon account.

Build SharedSpaces in Unity

After completing setup in the Meta Quest Developer Center and setting up networking with Photon, you are now ready to configure the SharedSpaces showcase app in Unity and run it on a Quest headset.