Quickstart for Google VR SDK for Unity with Android

This guide shows you how to set up Google VR development with Unity and build a demo Daydream or Cardboard app for Android.

Set up your development environment

Hardware requirements:

Software requirements:

  • Install Unity:

    Make sure that the Android Build Support component is selected during installation.

  • Make sure your environment is configured for Android development.

    Refer to Unity's guide for Android SDK/NDK setup.

Download the Google VR SDK for Unity

  • Download the latest GoogleVRForUnity_*.unitypackage from the releases page.

    The SDK includes the following demo scenes for Daydream and Cardboard:

    Scene Description
    HelloVR Simple VR game in which you find and select a geometric shape
    KeyboardDemo Daydream: Shows keyboard input on a UI canvas
    PermissionsDemo Daydream: Shows a correct user permissions request flow
    VideoDemo Shows various ways to use stereo or 360° video through playback or remote streaming

Create a new Unity project and import the Google VR Unity package

  1. Open Unity and create a new 3D project.

  2. Select Assets > Import Package > Custom Package.

  3. Select the GoogleVRForUnity_*.unitypackage file that you downloaded.

  4. In the Importing Package dialog, click Import.

    Accept any API upgrades, if prompted.

Configure build settings and player settings

  1. Select File > Build Settings.

  2. Select Android and click Switch Platform.

  3. In the Build Settings window, click Player Settings.

    Configure the following player settings:

    Setting Value
    Player Settings > Other Settings > Virtual Reality Supported Enabled
    Player Settings > Other Settings > SDKs Click + and select Daydream or Cardboard.
    Player Settings > Android > XR Settings > Virtual Reality SDKs > Daydream > Positional Head Tracking Click + and select Disabled, Supported, or Required.
    Player Settings > Other Settings > Minimum API Level Daydream: Android 7.0 'Nougat' (API level 24) or higher.
    Cardboard: Android 4.4 'Kit Kat' (API level 19) higher

Preview the demo scene in Unity

  1. In the Unity Project window, go to Assets > Google VR > Demos > Scenes. Open the HelloVR scene.

  2. Press the Play button. In the Game view you should see a rendered demo scene.

    Note that although the scene here is monoscopic, the rendering on your phone will be stereo. Unity might display this warning message as a reminder:

    VRDevice daydream not supported in Editor Mode. Please run on target device.

  1. Interact with the scene using simulation controls:

    Type Simulated action What to do
    Head movement Turn your head Hold Alt + move mouse
    Tilt your view Hold Control + move mouse
    Cardboard input Button press Click anywhere in the Game view
    Daydream input Change controller orientation Hold Shift + move mouse
    Click touchpad button Hold Shift + click left
    Click app button Hold Shift + click right
    Click home button to recenter Hold Shift + click middle
    Touch the touchpad.
    To see the controller, tilt your view down    		 Hold Control
    Change the touch position on the touchpad.
    To see the controller, tilt your view down    		 Hold Control + move mouse

  2. Daydream: (Optional) You can use a physical Daydream controller instead of simulated controls while in play mode in the editor. To do this, use Instant Preview.

Prepare your device

To prepare your supported device, enable developer options and USB debugging.

Build and run the demo scene on your device

  1. Connect your phone to your computer using a USB cable.

  2. Select File > Build and Run.

    Unity builds your project into an Android APK, installs it on the device, and launches it.

  3. Put the phone in your viewer and try out the demo.

Next steps