Please read the general build guide for information on building other platform. Only Android specific instructions are found in this file.
Building is currently supported on OSX, Windows and Linux platforms, but developers intending to do work on the library dependencies are strongly urged to use 64 bit Linux as a build platform
You will need the following tools to build Android targets.
Install gradle version 4.1 or higher. Following the instructions to install via SDKMAN! is recommended.
Download the Android Studio installer and run it. Once installed, at the welcome screen, click configure in the lower right corner and select SDK manager
From the SDK Platforms tab, select API levels 24 and 26.
From the SDK Tools tab select the following
- Android SDK Build-Tools
- GPU Debugging Tools
- CMake (even if you have a separate CMake installation)
- LLDB
- Android SDK Platform-Tools
- Android SDK Tools
- NDK (even if you have the NDK installed separately)
Setting up the environment for android builds requires some additional steps
Create a gradle.properties file in $HOME/.gradle. Edit the file to contain the following
HIFI_ANDROID_PRECOMPILED=<your_home_directory>/Android/hifi_externals
Note, do not use $HOME for the path. It must be a fully qualified path name.
Clone the repository
git clone https://github.com/highfidelity/hifi.git
Enter the repository android directory
cd hifi/android
Execute a gradle pre-build setup. This step should only need to be done once
gradle setupDependencies
- Open Android Studio
- Choose Open Existing Android Studio Project
- Navigate to the
hifirepository and choose theandroidfolder and select OK - If Android Studio asks you if you want to use the Gradle wrapper, select cancel and tell it where your local gradle installation is. If you used SDKMAN to install gradle it will be located in
$HOME/.sdkman/candidates/gradle/current/ - From the Build menu select Make Project
- Once the build completes, from the Run menu select Run App