MapLibreParticleLab/platform/android/README.md

MapLibre GL Native for Android

MapLibre GL Native for Android is a library for embedding interactive map views with scalable, customizable vector maps onto Android devices.

Getting Started

1. Add bintray Maven repositories to your build.gradle at project level so that you can access MapLibre packages for Android:

       allprojects {
           repositories {
               ...
               mavenCentral()                
           }
       }
   

   Note

   Bintray was turn off May 1st, 2021 so we migrated all packages to Maven central.

2. Add the library as a dependency into your module build.gradle

       dependencies {
           ...
           implementation 'org.maplibre.gl:android-sdk:<version>'
           ...
       }
   

3. Sync Gradle and rebuild your app.

Note

MapLibre by default ships with the proprietary Google Play Location Services. If you want to avoid pulling proprietary dependencies into your project, you can exclude Google Play Location Services as follows:

   implementation ('org.maplibre.gl:android-sdk:<version>') {
       exclude group: 'com.google.android.gms'
   }

Documentation

Visit https://maplibre.org/maplibre-gl-native/android/api/ to view the current API reference Javadoc files for MapLibre GL Native for Android.

Contributing

See DEVELOPING.md for instructions on how to get started working on the codebase.