Installation

To start developing your application using the Mapbox Java SDK, you'll need to first decide which installation method works for you. The SDK is fully compatible with Android using Gradle and can also be included in a generic Java project using either Gradle or Maven. You can find all dependencies given below on MavenCentral.

Gradle

  1. Start Android Studio.
  2. Open up your application's app-level build.gradle file.
  3. Make sure that your project's minSdkVersion is set to API 14 or higher.
  4. In the dependencies block, add a new implementation dependency for the Java SDK package(s) you want in your project.
  5. Click Sync Project with Gradle Files near the toolbar in Android Studio.
Proguard

If your project is close or exceeds the 65k method count limit, you can mitigate this problem by specifying only the specific Mapbox Android Service APIs. See the selectively compiling APIs section below.

repositories {
    google()
}

dependencies {
    // Replace `DESIRED_JAVA_SDK_PACKAGE` with the
    // name of one of the packages listed at the top of this page.

    implementation 'com.mapbox.mapboxsdk:DESIRED_JAVA_SDK_PACKAGE:5.6.0'

    implementation 'androidx.annotation:annotation:1.0.0'
}

Maven

If your project is using Maven instead of Gradle, you can add the dependency inside your project's POM.xml file.

<dependency>
    <groupId>com.mapbox.mapboxsdk</groupId>
    <!-- Replace `DESIRED_JAVA_SDK_PACKAGE` with the name of one of the packages listed in the next section-->
    <artifactId>DESIRED_JAVA_SDK_PACKAGE</artifactId>
    <version>5.6.0</version>
</dependency>