Archived Documentation

This version of the guide is out of date. Click here for the latest version.

Oculus Platform Setup

Here are the basic setup steps you'll need to take before you can add Oculus Platform features to your app.

Creating an Organization

Before you can do anything with the Oculus Platform, you need to create or join an organization.

To create an organization, go to the Oculus developer dashboard and follow the on-screen prompts.

To add yourself to an organization, ask the organization owner to go to the Oculus developer dashboard and select the Members tab. From there, they can add you as another admin, as a developer, or as a member of the finance team for your organization. If you are a developer or admin, you will automatically have entitlements to all apps within the organization.

Building Your App

In most cases, you'll want to start building your app before deciding which Oculus Platform features to include.

To get started, choose one of the following options:

Note: If you have an existing app ecosystem (such as a non-VR PC version of your game with existing player accounts) and need to set up single-signon (SSO), contact us at sso-help@oculus.com

Oculus Account

You'll need to create an Oculus account to use key Oculus developer functions, including Oculus Platform features.

Here are a few key points to keep in mind:

  • You're prompted to create an account the first time you run the Oculus software on your computer.
  • If you have an Oculus account already, you can use it as your developer account.
  • You need an Oculus account to set up your app in the Oculus system. You also manage developer and tester privileges using your Oculus account.

Developer Dashboard and Oculus App Setup

You'll need to take the following steps in the Oculus developer dashboard and on your computer before you can include Oculus Platform features.

In the Oculus developer dashboard, take the following steps:

  1. Click Create New App in the My Apps tab.
  2. Select either Gear VR or Oculus Rift for your app platform.
  3. Enter a name for your app and click Save and Continue.
  4. You'll now see your App ID, which is a unique identifier in the Oculus ecosystem used to initialize the Platform SDK, as we'll discuss later in our platform walkthrough examples. You'll also use it when making REST requests. You can always find your App ID at any time in the API tab within My Apps.
  5. If you wish, you can enter your app information in the Submission Info tab toward the upper left, but this is optional right now.
  6. Select the Builds tab in the upper left.
  7. Click Upload Build and upload a build in executable format (.zip containing an .exe). Your binary can be an empty executable, though. The Alpha release channel is the default, but you can also create new release channels called whatever you wish.
  8. In the Build Dashboard, click the + icon under Subscribed Users to add test users to a release channel.

In the Oculus app on your computer, take the following steps to create the necessary pathway for your app:

  1. Go to settings, click General, and enable the Unknown Sources setting. See the Rift User Guide.
  2. Restart the Oculus app.
  3. Go to your Oculus Library, where your test app will be visible.
  4. Download your app once so the Oculus runtime is aware of your app. This allows you to test future changes without having to upload them to the developer dashboard first.