mapbox-gl-native

Building & Developing Mapbox GL Native from Source

Just trying to use Mapbox GL Native? You don’t need to read this stuff! We provide easy-to-install, prebuilt versions of the Mapbox SDKs for iOS and Android that you can download instantly and get started with fast.

Still with us? These are the instructions you’ll need to build Mapbox GL Native from source on a variety of platforms and set up a development environment.

Your journey will start with getting the source code, then installing the dependencies, and then setting up a development environment, which varies depending on your operating system and what platform you want to develop for.

1: Getting the Source

Mapbox GL Native uses git submodules, so you’ll need to initialize and update them after cloning the source from Git.

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

Default styles in the Mapbox GL Style Spec format are included at ./styles as a submodule. See the styles project to report problems or to contribute to these styles.

2: Installing Dependencies

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

Depending on your operating system and target, you’ll need additional dependencies:

Additional Dependencies for Linux

Additional Dependencies for OS X

3: Setting up a development environment & building

See the relevant SDK documentation for next steps: