Skip to content

Latest commit

 

History

History
 
 

android

README.md

Mapbox Android SDK

Circle CI build status

A library based on Mapbox GL Native for embedding interactive map views with scalable, customizable vector maps into Java applications on Android devices.

Getting Started

Alright. So, actually, you may be in the wrong place. From here on in, this README is going to be for people who are interested in working on and improving on Mapbox GL Native for Android.

To view our current API documentation, see our JavaDoc.

To install and use the Mapbox Android SDK in an application, see the Mapbox Android SDK website.

Setup environment

These instructions are for developers interested in making code-level contributions to the SDK itself. If you instead want to use the SDK in your app, see above.

Getting the source

Clone the git repository

git clone https://github.com/mapbox/mapbox-gl-native.git
cd mapbox-gl-native

Installing dependencies

These dependencies are required for all operating systems and all platform targets.

  • Latest stable Android Studio

  • Update Android SDK with latest

    • Android SDK Build-Tools
    • Android Platform-Tools
    • Android SDK Tools
    • CMake
    • NDK
    • LLDB

  • Modern C++ compiler that supports -std=c++14*

    • clang++ 3.5 or later or
    • g++-4.9 or later

  • cURL (for build only)

  • Node.js or later (for build only)

  • pkg-config (for build only)

Note: We partially support C++14 because GCC 4.9 does not fully implement the final draft of the C++14 standard. More information in DEVELOPING.md.

Additional Dependencies for Linux

These instructions were tested on Ubuntu 16.04 LTS (aka Xenial Xerus).

$ sudo apt-get install -y build-essential curl lib32stdc++6 lib32z1 pkg-config python
Additional Dependencies for macOS

Open project in Android Studio

macOS

Execute the following to generate the required build files and open the project with Android Studio:

make aproj
linux

Open Android Studio project in /platform/android, run make android-configuration in the root folder of the project.

Setup Checkstyle

Mapbox uses specific IDE settings related to code and check style. See checkstyle guide for configuration details.

Setting Mapbox Access Token

The test application (used for development purposes) uses Mapbox vector tiles, which require a Mapbox account and API access token. Obtain a free access token on the Mapbox account page.

With the first gradle invocation, gradle will take the value of the MAPBOX_ACCESS_TOKEN environment variable and save it to MapboxGLAndroidSDKTestApp/src/main/res/values/developer-config.xml. If the environement variable wasn't set, you can edit developer-config.xml manually and add your access token to the mapbox_access_token resource.

Running project

Run the configuration for the MapboxGLAndroidSDKTestApp module and select a device or emulator to deploy on. Based on the selected device, the c++ code will be compiled for the related processor architecture. You can see the project compiling in the View > Tool Windows > Gradle Console.

More information about building and distributing this project in [DISTRIBUTE.md][https://github.com/mapbox/mapbox-gl-native/blob/master/platform/android/DISTRIBUTE.md].

Symbolicating native crashes

When hitting native crashes you can use ndk-stack to symbolicate crashes. More information in this guide.