Oculus Platform Developer Guide

The Oculus Platform is a suite of tools and services that help developers create, distribute, and monetize VR experiences. The Oculus Platform is designed to make it easier for developers to create high-quality VR experiences and get them in front of a large audience. It provides developers with access to a variety of tools and services, including a game engine, a marketplace, and a SDK. The Oculus Platform also includes a set of social features that allow users to connect with friends and family in VR.

PDF

Document

Oculus Platform
Developer Guide
Version 1.10.0.0

2 | Introduction | Oculus Platform
2 | |
Copyrights and Trademarks
© 2017 Oculus VR, LLC. All Rights Reserved.
OCULUS VR, OCULUS, and RIFT are trademarks of Oculus VR, LLC. (C) Oculus VR, LLC. All rights reserved.
BLUETOOTH is a registered trademark of Bluetooth SIG, Inc. All other trademarks are the property of their
respective owners. Certain materials included in this publication are reprinted with the permission of the
copyright holder.

Oculus Platform | Contents | 3
Contents
Update Your App.................................................................................................4
Adding Oculus Platform Support to Your Project............................................................................................ 4
Making REST Requests......................................................................................................................................4
Native Rift and Gear VR Apps.......................................................................................................................... 5
Unity................................................................................................................................................................... 6
Oculus Platform Feature Tutorials....................................................................... 8
Entitlements: App Authorizations...................................................................................................................... 8
Ownership: Additional Authorizations...............................................................................................................9
User and Friends................................................................................................................................................9
Rooms.............................................................................................................................................................. 10
Coordinated App Launch (CAL)...................................................................................................................... 12
Room Invites.................................................................................................................................................... 13
Parties...............................................................................................................................................................15
Basic Matchmaking Walkthrough.................................................................................................................... 17
Advanced Matchmaking.................................................................................................................................. 21
VoIP: Voice over IP..........................................................................................................................................24
P2P................................................................................................................................................................... 26
In-App Purchases............................................................................................................................................. 28
Oculus Keys..................................................................................................................................................... 30
Leaderboards................................................................................................................................................... 31
Achievements................................................................................................................................................... 34
Cloud Storage..................................................................................................................................................36
App Groupings................................................................................................................................................ 39

4 | Update Your App | Oculus Platform
Update Your App
This section describes how to prepare your app or experience for the Oculus Platform features.
Adding Oculus Platform Support to Your Project
To add Oculus Platform support to your Visual C++ project:
1. Open the Properties page.
2. Select VC++ Directories.
3. Add the location of the SDK includes folder (InstallFolder\include) to Include Directories.
4. Add the location of the lib file (InstallFolder\Windows) to Library Directories.
5. Expand Linker and select Input.
6. Add the loader library (LibOVRPlatform32_1.lib or LibOVRPlatform64_1.lib) to Additional Dependencies.
7. Using the DLL loader instead of direct linking enables DLL signature verification and graceful detection of
the Oculus Runtime. To use the loader, drop the cpp file (InstallFolder/Windows/OVR_PlatformLoader.cpp )
into your project.
To bypass the Loader, add this define before including OVR_Platform.
#define OVRPL_DISABLED
#include <OVR_Platform.h>
Making REST Requests
Depending on the type of operation, you might use the Platform UI or API.
Although many requests are made in the UI, eventually you will be able to make most of them
programmatically. This section describes how to make REST requests.
Before you can make a request, make sure you have the credentials for your app. For more information, see
Oculus Platform Setup.
Many types of requests to the API use the following format:
[GET/POST/DELETE] https://graph.oculus.com/app_id/api
?access_token=token|app_id|app_secret
&option_1=<option-1>
&option_2=<option-2>
...
where:
• app_id—ID of the app.
• api—name of the API (e.g., "leaderboards").
• token—Request token.
• app_secret—the secret key for the app.

Key features

Entitlements
Matchmaking
Rooms
VoIP
In-App Purchases
Leaderboards
Achievements
Cloud Storage
App Groupings

Frequently asked questions

To check for an entitlement, use the Platform.Entitlement.IsUserEntitledToApplication().OnComplete(callbackMethod) function. This will call the callbackMethod when the results are returned. To process the results, check if !msg.IsError. If it is not an error, the entitlement check passed. If it is, the check failed.

Quickmatch mode automatically matches players together based on criteria you set, while Browse mode allows players to choose from a list of rooms to join.

To create a skill pool, go to the Oculus Developer Dashboard, select the Platform tab, choose Skill Pools from the menu, and click Create Skill Pool. Enter a unique Skill Pool Key, select a Luck Factor, and enter a Draw Probability. Once the skill pool is created, you can add it to a matchmaking pool by selecting Pools from the menu and clicking Create Pool. Then select the skill pool you created for the Skill Pool option and submit.

You can send invites by building your own UI or using the Oculus UI. To send an invite using your own UI, call ovr_Room_GetInvitableUsers to get a list of users who can be invited and their unique invite tokens. Then call ovr_Room_InviteUser(roomID, inviteToken) to send the invite. To use the Oculus UI, call ovr_Room_LaunchInvitableUserFlow(roomID).

Coordinated App Launch allows users to launch your app from the Rooms Group App Launcher. This allows users to discover, install, and play your app together. To enable CAL, go to the Developer Dashboard, select your app, navigate to CAL in the Platform tab, and select 'Supported'. Then enter the minimum version code for the first build that supports CAL and choose the minimum and maximum users allowed.

The Shared Microphone API allows sharing of mic access between multiple services so that an app can access the user's mic data while in a Party. To integrate with the API, you need to instantiate the mic object and retrieve PCM data from it.