{"_id":"5ba1a04d4f89f700039d859b","category":{"_id":"5ba1a04d4f89f700039d8594","version":"5ba1a04d4f89f700039d85d0","project":"5a065a6134873d0010b396ab","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-10-25T23:36:45.975Z","from_sync":false,"order":0,"slug":"basics","title":"Getting Started"},"project":"5a065a6134873d0010b396ab","user":"57bb7e47afc18c0e00529cf3","parentDoc":null,"version":{"_id":"5ba1a04d4f89f700039d85d0","project":"5a065a6134873d0010b396ab","__v":0,"forked_from":"5b8469fbe0a7ea00039d96b8","createdAt":"2018-04-18T18:19:34.288Z","releaseDate":"2018-04-18T18:19:34.288Z","categories":["5ba1a04d4f89f700039d8594","5ba1a04d4f89f700039d8595","5ba1a04d4f89f700039d8596","5b05923ea5a2f9000357b452","5b05f793c2c86c0003cbe414","5ba1a04d4f89f700039d8597","5ba1a04d4f89f700039d8598","5ba1a04d4f89f700039d8599"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.11.0","version":"1.11.0"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-15T21:29:57.377Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"## Prerequisites\n\n1. An Android device that supports [Cardboard](https://vr.google.com/cardboard/), [Daydream](https://vr.google.com/daydream/), [Gear VR](https://developer.oculus.com/) or [ARCore](https://developers.google.com/ar/discover/#supported_devices)\n2. A compatible headset for Daydream or Gear VR\n\n## Android Studio\n\nDownload and install [Android Studio](https://developer.android.com/studio/index.html) for your operating system.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"For AR/ARCore:\",\n  \"body\": \"If you plan on using the AR features, ensure that you are installing [Android Studio](https://developer.android.com/studio/index.html) version 3.0 or higher with Android SDK Platform version 7.0 (API level 24) or higher.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Building AR/ARCore With Android Studio\",\n  \"body\": \"Because of [existing issues with AR Core](https://github.com/google-ar/arcore-android-sdk/issues/130), please ensure that you have [disabled instant run in Android Studio](https://stackoverflow.com/questions/35168753/instant-run-in-android-studio-2-0-how-to-turn-off) before building your application!\"\n}\n[/block]\n## Prepare your device for development\n\n1. [Enable Developer Mode](https://developer.android.com/studio/debug/dev-options.html#enable) on your Android device\n2. [Enable USB Debugging](https://developer.android.com/studio/debug/dev-options.html#debugging) within the Developer Menu\n3. Connect your device to your computer via USB. When a pop-up appears asking to \"Allow USB Debugging?\", select \"OK\".\n\n#### For ARCore\n\nFollow the instructions [here](https://developers.google.com/ar/develop/java/getting-started#prepare-device) to install the ARCore Service onto your device. For this version of Viro, we require the ARCore 1.4. \n\n # Download the Hello World Projects\n\nDownload and unzip the Hello World projects [here](https://s3-us-west-2.amazonaws.com/virocore/1_11_0/virocore-helloworld.zip).\n\n#### For Cardboard/Daydream\n\nEnsure your device has the latest Cardboard, Google VR Services and/or Daydream applications installed from the Play Store. Your device may not support all 3 applications, but update all of those your device does support.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"For GearVR\",\n  \"body\": \"If you're trying to use build for GearVR, follow the instructions [here](https://dashboard.oculus.com/tools/osig-generator/) to generate an OSIG file for your device. Once you have the OSIG file, place the file in your project's `<project_root>/app/src/main/asset` directory.\"\n}\n[/block]\n## Build and Run the Hello World App\n\n1. Open the project for the platform you're interested in. We provide one sample project for AR, one for VR (which supports both OVR and GVR), and one for ViroViewScene (used for making 3D applications without AR and VR).\n2. If you're asked about enabling Instant Run, select 'Don't remind me again for this project'\n3. Once the project initializes, run a Gradle sync\n4. Open the AndroidManifest.xml and place your Viro API key where it says \"API_KEY_HERE\".\n5. Run the application!\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Choosing your VR Platform\",\n  \"body\": \"If you're using the VR Hello World project, you can select between OVR and GVR by opening the Build Variants pane on the left.\"\n}\n[/block]","excerpt":"","slug":"getting-started","type":"basic","title":"Getting Started"}
## Prerequisites 1. An Android device that supports [Cardboard](https://vr.google.com/cardboard/), [Daydream](https://vr.google.com/daydream/), [Gear VR](https://developer.oculus.com/) or [ARCore](https://developers.google.com/ar/discover/#supported_devices) 2. A compatible headset for Daydream or Gear VR ## Android Studio Download and install [Android Studio](https://developer.android.com/studio/index.html) for your operating system. [block:callout] { "type": "info", "title": "For AR/ARCore:", "body": "If you plan on using the AR features, ensure that you are installing [Android Studio](https://developer.android.com/studio/index.html) version 3.0 or higher with Android SDK Platform version 7.0 (API level 24) or higher." } [/block] [block:callout] { "type": "warning", "title": "Building AR/ARCore With Android Studio", "body": "Because of [existing issues with AR Core](https://github.com/google-ar/arcore-android-sdk/issues/130), please ensure that you have [disabled instant run in Android Studio](https://stackoverflow.com/questions/35168753/instant-run-in-android-studio-2-0-how-to-turn-off) before building your application!" } [/block] ## Prepare your device for development 1. [Enable Developer Mode](https://developer.android.com/studio/debug/dev-options.html#enable) on your Android device 2. [Enable USB Debugging](https://developer.android.com/studio/debug/dev-options.html#debugging) within the Developer Menu 3. Connect your device to your computer via USB. When a pop-up appears asking to "Allow USB Debugging?", select "OK". #### For ARCore Follow the instructions [here](https://developers.google.com/ar/develop/java/getting-started#prepare-device) to install the ARCore Service onto your device. For this version of Viro, we require the ARCore 1.4. # Download the Hello World Projects Download and unzip the Hello World projects [here](https://s3-us-west-2.amazonaws.com/virocore/1_11_0/virocore-helloworld.zip). #### For Cardboard/Daydream Ensure your device has the latest Cardboard, Google VR Services and/or Daydream applications installed from the Play Store. Your device may not support all 3 applications, but update all of those your device does support. [block:callout] { "type": "info", "title": "For GearVR", "body": "If you're trying to use build for GearVR, follow the instructions [here](https://dashboard.oculus.com/tools/osig-generator/) to generate an OSIG file for your device. Once you have the OSIG file, place the file in your project's `<project_root>/app/src/main/asset` directory." } [/block] ## Build and Run the Hello World App 1. Open the project for the platform you're interested in. We provide one sample project for AR, one for VR (which supports both OVR and GVR), and one for ViroViewScene (used for making 3D applications without AR and VR). 2. If you're asked about enabling Instant Run, select 'Don't remind me again for this project' 3. Once the project initializes, run a Gradle sync 4. Open the AndroidManifest.xml and place your Viro API key where it says "API_KEY_HERE". 5. Run the application! [block:callout] { "type": "info", "title": "Choosing your VR Platform", "body": "If you're using the VR Hello World project, you can select between OVR and GVR by opening the Build Variants pane on the left." } [/block]