Documentation

Mobile Build Target: Android

This section describes targeting Unity project builds to Android.

Build Settings

  1. From the File menu, select Build Settings…. From the Build Settings… menu, select Android as the platform. Set Texture Compression to ETC2 (GLES 3.0).
  2. Add any scenes you wish to include in your build to Scenes In Build..

Player Settings

  1. Click the Player Settings… button and select the Android tab. Set Default Orientation to Landscape Left in Settings for Android (may be collapsed).
  2. As a minor optimization, 16 bit buffers, color and/or depth may be used. Most VR scenes should be built to work with 16 bit depth buffer resolution and 2x MSAA. If your world is mostly pre-lit to compressed textures, there will be little difference between 16 and 32 bit color buffers.
  3. Select the Splash Image section. For Mobile Splash image, choose a solid black texture.
  4. While still in Player Settings, select Other Settings and verify that Rendering Path* is set to Forward, Multithreaded Rendering* is selected, and Install Location is set to Force Internal, as shown below:
  5. Set the Stripping Level to the maximum level your app allows. It will reduce the size of the installed .apk file.
    Checking Optimize Mesh Data may improve rendering performance if there are unused components in your mesh data.

Quality Settings

  1. Go to the Edit menu and choose Project Settings, then Quality. In the Inspector, set Vsync Count to Don’t Sync. The TimeWarp rendering performed by the Oculus Mobile SDK already synchronizes with the display refresh.
  2. Anti Aliasing should be set to Disabled. You may change the camera render texture antiAliasing by modifying the Eye Texture Antialiasing parameter on OVRManager. The current default is 2x MSAA. Be mindful of the performance implications. 2x MSAA runs at full speed on chip, but may still increase the number of tiles for mobile GPUs which use variable bin sizes, so there is some performance cost. 4x MSAA runs at half speed, and is generally not fast enough unless the scene is very undemanding.
  3. Pixel Light Count is another attribute which may significantly impact rendering performance. A model is re-rendered for each pixel light that affects it. For best performance, set Pixel Light Count to zero. In this case, vertex lighting will be used for all models depending on the shader(s) used.

Time Settings

Go to the Edit -> Project Settings -> Time and change both Fixed Timestep and Maximum Allowed Timestep to “0.0166666” (i.e., 60 frames per second).
Fixed Timestep is the frame-rate-independent interval at which the physics simulation calculations are performed. In script, it is the interval at which FixedUpdate() is called. The Maximum Allowed Timestep sets an upper bound on how long physics calculations may run.

Android Manifest File

Open the AndroidManifest.xml file located under Assets/Plugins/Android/. You will need to configure your manifest with the necessary VR settings, as shown in the following manifest segment:

<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="<packagename>"  
android:versionCode="1" android:versionName="1.0" android:installLocation="internalOnly">
<application android:theme="@android:style/Theme.Black.NoTitleBar.Fullscreen" >
<meta-data android:name="com.samsung.android.vr.application.mode" android:value="vr_only"/>
<activity  android:screenOrientation="landscape" 
android:launchMode="singleTask"
android:configChanges="screenSize|orientation|keyboardHidden|keyboard">
</activity>
</application>
<uses-sdk android:minSdkVersion="19" android:targetSdkVersion="19" />
<uses-feature android:glEsVersion="0x00030000" />
  • Replace <packagename> in the first line with your actual package name, such as "com.oculus.cinema".
  • Unity will overwrite the required setting android:installLocation="internalOnly" if the Player Setting Install Location is not set to Force Internal.
  • The Android theme should be set to the solid black theme for comfort during application transitioning: Theme.Black.NoTitleBar.Fullscreen
  • The vr_only meta data tag should be added for VR mode detection.
  • The required screen orientation is landscape: android:screenOrientation="landscape"
  • We recommended setting your configChanges as follows: android:configChanges="screenSize|orientation|keyboardHidden|keyboard"
  • The minSdkVersion and targetSdkVersion are set to the API level supported by the device. For the current set of devices, the API level is 19.
  • Do not add the noHistory attribute to your manifest.

Running the Build

Now that the project is properly configured for VR, it’s time to install and run the application on the Android device.

Applications written for development are not launched through the Oculus Home menu system. Instead, build the application directly to your phone, and you will be prompted to insert your phone into the Gear VR headset to launch the application automatically.

To run the application in the future, remove your phone from the Gear VR headset, launch the application directly from the phone desktop or Apps folder, and insert the device into the Gear VR when prompted to do so.

  1. Copy an Oculus Signature File specific to your mobile device to the folder Project/Assets/Plugins/Android/assets/ or the application will not run. See the Application Signing section of the Mobile SDK documentation for more information.
  2. Be sure the project settings from the steps above are saved with File > Save Project.
  3. If you are not already connected to your phone via USB, connect now. Unlock the phone lock screen.
  4. From the File menu, select Build Settings…. While in the Build Settings menu, add the Main.scene to Scenes in Build. Next, verify that Android is selected as your Target Platform and select Build and Run. If asked, specify a name and location for the .apk.
    The .apk will be installed and launched on your Android device.
Loading…