A WebGL JavaScript interactive maps library that can render Mapbox Vector Tiles.

Using mapbox-gl-js

Include the source via HTML tags:

<script src='https://api.tiles.mapbox.com/mapbox-gl-js/v0.12.4/mapbox-gl.js'></script>
<link href='https://api.tiles.mapbox.com/mapbox-gl-js/v0.12.4/mapbox-gl.css' rel='stylesheet' />

For more information, see the API documentation and examples.

Alternatively, you can npm install mapbox-gl and use it as a bundled dependency with browserify.

Developing mapbox-gl-js

The following tools are required on any platform to develop mapbox-gl-js. Mac users are advised to use Homebrew unless they want to build these packages manually. APT install steps are relevant to Ubuntu Linux users.

• git
  • OSX: brew install git
  • APT: sudo apt-get install git
• node.js
• GNU Make
• imagemagick
  • OSX: brew install imagemagick
  • APT: sudo apt-get install imagemagick

On Linux, libglew-dev is required in order to run rendering tests:

$ sudo apt-get install libglew-dev

To install dependencies and build the source files:

$ npm install

To serve the debug page:

$ npm start &
$ open "http://localhost:9966/debug/?access_token="`echo $MapboxAccessToken`

This assumes you have the MapboxAccessToken environment variable set to a Mapbox API token from https://www.mapbox.com/account/apps/. This command uses mattdesl/budo to watch source files, rebuild the browserify bundle, and trigger LiveReload updates.

Running Tests

There are two test suites associated with Mapbox GL JS

• npm test runs quick unit tests
• npm run test-suite runs slower rendering tests from the mapbox-gl-test-suite repository

Running Benchmarks

The FPS benchmarking page compares the performance of your local copy of GL JS against previously released versions. Benchmarking configuration is within bench/fps/site.js.

To serve the FPS benchmark page:

$ npm start &
$ open "http://localhost:9966/bench/fps/?access_token="`echo $MapboxAccessToken`

Writing Documentation

See docs/README.md.

Releasing

To prepare a release:

• Run git checkout master && git merge origin/mb-pages to merge mb-pages into master
• Update CHANGELOG.md with all changes since the last release. A list of commits is available on the GitHub Releases page through a link that says "X commits to master since this release"
• Update the version number in package.json, README.md, bench/fps/site.js, _config.yml, and _config.mb-pages.yml
• Run git commit -a -m "vX.Y.Z" to commit changes
• Run git tag vX.Y.Z to tag the release
• Run git push origin && git push origin --tags to push the new commit and tag to GitHub
• Create a GitHub release using the tag you just pushed and the text in CHANGELOG.md
• The CI server will automatically publish tagged builds to the Mapbox CDN. Wait for this build to finish successfully before proceeding.
• Run git checkout mb-pages && git merge master && git push origin mb-pages to merge master into mb-pages and publish documentation. Wait for the examples to publish successfully before proceeding (this can take a few minutes).
• Run git checkout master && npm publish to publish the release to npm.

Style Reference

Recommended Reading

Learning WebGL

• Greggman's WebGL articles
• WebGL reference card

GL performance

• Debugging and Optimizing WebGL applications
• Graphics Pipeline Performance

Misc

• drawing antialiased lines
• drawing text with signed distance fields
• label placement
• distance fields