README.md

MapLibre GL Native - Open-Source Mapbox GL Native

SDK for iOS, Android and other platforms

MapLibre GL Native is a community led fork derived from mapbox-gl-native prior to their switch to a non-OSS license. The fork also includes Maps SDK for iOS and MacOS (forked from mapbox-gl-native-ios) and Android SDK (forked from mapbox-gl-native-android). These platform-specific SDKs were merged under platform directory and they reference mapbox-gl-native directly, not as a submodule.

Beside merging in platform specific SDKs, the following changes were made compared to original mapbox projects:

• The code was upgraded so that it can be built using latest clang compiler / Xcode 12.
• CI/CD was migrated from CircleCI to GitHub Actions.
• Along with GitHub releases, binaries are distributed as follows:
  • The iOS binaries distribution was upgraded from fat packages to Swift package containing XCFramework.
  • The Android binaries are distributed to GitHub maven package repository.

The mapbox-gl-native was forked from d60fd30 - mgbl 1.6.0, mapbox-gl-native-ios from a139216 and mapbox-gl-native-android from 4c12fb2

Build Status

SDK	Build	Build status
Maps SDK for iOS	CI
Maps SDK for iOS	Release
Maps SDK for Android	CI
Maps SDK for Android	Release

Sponsors

We thank everyone who supported us financially in the past and special thanks to the people and organizations who support us with recurring donations!

Read more about the MapLibre Sponsorship Program at https://maplibre.org/sponsors/.

Platinum:

Silver:

Stone:

MIERUNE Inc.

Backers and Supporters:

Documentation

The Android API documentation is available at https://maplibre.org/maplibre-gl-native/android/api/

The iOS API documentation is available at https://maplibre.org/maplibre-gl-native/ios/api/

Architecture: https://maplibre.org/maplibre-gl-native/docs/book/

Installation

Android

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'
    }

iOS

1. To add a package dependency to your Xcode project, select File > Swift Packages > Add Package Dependency and enter its repository URL. You can also navigate to your target’s General pane, and in the “Frameworks, Libraries, and Embedded Content” section, click the + button, select Add Other, and choose Add Package Dependency.

2. Either add MapLibre GitHub distribution URL (https://github.com/maplibre/maplibre-gl-native-distribution) or search for maplibre-gl-native package.

3. Choose "next". Xcode should clone the distribution repository and download the binaries.

Alternative installation

You can also download pre-build from releases in this repository.

How to create your own build

Source code checkout

git clone --recurse-submodules https://github.com/maplibre/maplibre-gl-native.git

Build

MapLibre uses tags for its Android & iOS releases based on SemVer versioning. This is useful for checking out a particular released version for feature enhancments or debugging.

You can list available tags by issuing the command git tag, then use the result

# 1. Obtain a list of tags, which matches to release versions
git tag

# 2.  Set a convenience variable with the desired TAG
# TAG=android-v9.4.2
# TAG=android-v9.5.2
TAG=ios-v5.12.0
# TAG=ios-v5.12.0-pre.1

# 3.  Check out a particular TAG
git checkout tags/$TAG -b $TAG

# 4. build, debug or enhance features based on the tag
# clean, if you need to troubleshoot build dependencies by using `make clean`

Build using Bazel

Bazel is also supported as a build option for getting a packaged release of the xcframework compiled for either static or dynamic linking.

Firstly you will have to ensure that Bazel is installed

brew install baselisk

From there you can use the script in platform/ios/platform/ios/scripts/package-bazel.sh

There are 4 options:

cd platform/ios/platform/ios/scripts

Static xcframework compiled for release (this is default if no parameters are provided): ./bazel-package.sh --static --release

Static xcframework compiled for debug: ./bazel-package.sh --static --debug

Dynamic xcframework compiled for release: ./bazel-package.sh --dynamic --release

Dynamic xcframework compiled for debug: ./bazel-package.sh --dynamic --debug

All compiled frameworks will end up in the bazel-bin/platform/ios/ path from the root of the repo.

Also you can use the link option to ensure that the framework is able to link.

./bazel-package.sh --link

Bazel build files are placed in a few places throughout the project:

BUILD.bazel

• Covering the base cpp in the root src directory.

vendor/BUILD.bazel

• Covering the submodule dependencies of Maplibre.

platform/default/BUILD.bazel

• Covering the cpp dependencies in default.

platform/darwin/BUILD.bazel

• Covering the cpp source in platform/default.

platform/ios/platform/ios/vendor/

• Covering the iOS specific dependencies.

platform/ios/BUILD.bazel

• Covering the source in platform/ios/platform/ios/src and platform/ios/platform/darwin/src as well as defining all the other BUILD.bazel files and defining the xcframework targets.

There are also some other areas that make bazel work:

WORKSPACE

• Defines the "repo" and the different modules that are loaded in order to compile for Apple.

.bazelversion

• Defines the version of bazel used, important for specific support for Apple targets.

bazel/flags.bzl

• Defines some compilation flags that are used between the different build files.

Android

---

macOS Build Environment: Android Studio + NDK

• Environment: Android Studio + NDK
  • JAVA_HOME=/Applications/Android Studio.app/Contents/jre/Contents/Home
  • ANDROID_SDK_ROOT=~/Library/Android/sdk
  • ~/Library/Android/sdk/tools/bin/sdkmanager --install ndk;major.minor.build

cd platform/android
BUILDTYPE=Debug make apackage
#BUILDTYPE=Release make apackage

Binaries are produced in platform/android/MapboxGLAndroidSDK/build/outputs/aar/MapboxGLAndroidSDK-<BUILDTYPE>.aar Please refer to Mapbox Maps SDK for Android for detailed instructions.

iOS

You can run automated test on a Simulator or Device by changing to the Scheme iosapp and choosing Product > Test (or use ⌘-U). Use ⌘-9 to navigate to Reports to see results and browse through screenshots. This method of testing should work well with CI tools such as GitHub Actions, Xcode Server Bots, & AWS Device Farm.

cd platform/ios

# make and open the Xcode workspace
make iproj

# make Xcode workspace, but run in headless mode
make iproj CI=1

# Make Frameworks
make xcframework BUILDTYPE=Release

# test
make ios-test

# UITests
#   You can review uitest results:  $(IOS_OUTPUT_PATH)/Logs/Test
 make ios-uitest

The packaging script will produce a Mapbox.xcframework in the platform/ios/build/ios/pkg/dynamic folder. Please refer to Mapbox Maps SDK for iOS for detailed instructions.

MacOS

cd platform/ios
# open macOS project in Xcode
make xproj

# build or test from the command line
make xpackage
make macos-test

This produces a Mapbox.framework in the platform/ios/build/macos/pkg/ folder. Please refer to Mapbox Maps SDK for macos for detailed instructions.

Linux

See the Linux platform build section for instructions.