neuralpain / mapbox-navigation-android

Mapbox Navigation SDK for Android

When your users want to get from one location to another, don’t push them out of your application into a generic map application. Instead, keep them engaged with your application 100% of the time with in-app turn-by-turn navigation.

The Mapbox Navigation SDK for Android is built on top of the Mapbox Directions API and the Mapbox Maps SDK to provide tools needed to build a complete navigation experience.

The Mapbox Navigation SDK is a precise and flexible platform which enables your users to explore the world's streets. We are designing new maps specifically for navigation that highlight traffic conditions and helpful landmarks. The calculations are based on the user's current location and compare it to the current route that the user's traversing to provide critical information at any given moment. You control the entire experience, from the time your user chooses a destination to when they arrive.

Getting Started

Refer to the full documentation pages for installation and usage instructions.

For the latest version and changelog visit CHANGELOG or releases pages.

Along with the full documentation, this migration guide can help you transition your project from version v1 of the Navigation SDK to v2 or higher.

Getting Help

• Need help with your code?: Look for previous questions on the #mapbox tag — or ask a new question.
• Have a bug to report? Open an issue. If possible, include the version of Mapbox Services, a full log, and a project that shows the issue.
• Have a feature request? Open an issue. Tell us what the feature should do and why you want the feature.

Using Snapshots

You can use a -SNAPSHOT release if you want to test recent bug fixes or features that have not been packaged in an official release yet.

1.0.0+ versions of the Navigation SDK:

To access SNAPSHOT builds follow the installation instructions and then:

1. Provide the below additional snapshot repository reference, next to the existing release repository reference:

maven {
    url 'https://api.mapbox.com/downloads/v2/snapshots/maven'
    authentication {
        basic(BasicAuthentication)
    }
    credentials {
        username = "mapbox"
        password = "{secret Mapbox token with DOWNLOADS:READ scope, the same as the token used for the release repository}"
    }
}

2. Append -SNAPSHOT to the target version:

dependencies {
  implementation "com.mapbox.navigation:android:X.Y.Z-SNAPSHOT"
}

You can find the latest snapshot version reference in gradle.properties.

Sample code

Examples for Mapbox Navigation Android SDK are now available on their own separate repo, available here.

The QA application is available here.

General documentation for Mapbox Navigation Android SDK is available here.

Contributing

We welcome feedback, translations, and code contributions! Please see CONTRIBUTING.md for details.