MapBox iOS SDK
Based on the Route-Me iOS map library (Alpstein fork) with MapBox customizations.
Requires iOS 5 and Xcode 4.3 or greater. Does not yet support ARC.
Major differences from Alpstein fork of Route-Me:
- Requires iOS 5.0 and above.
- MapBox & MBTiles tile source integration code.
- MapBox Markers support.
- UTFGrid interactivity.
- Improved network tile loading performance.
- A bulk, background map tile downloader for cache pre-population.
- Annotation callouts that behave like MapKit.
- Annotation convenience subclasses for points and shapes.
- Prepackaged binary framework.
- CocoaPods support.
- Removal of two-finger double-tap gesture for zoom out (to speed up two-finger single-tap recognition like MapKit).
- Different default starting location for maps.
- Built-in attribution view controller with button on map views & default OpenStreetMap attribution.
- Easy static map view support.
- Removal of included example projects in favor of separate examples on GitHub.
- A few added defaults for convenience.
- Improved documentation.
Route-Me is an open source map library that runs natively on iOS. It's designed to look and feel much like the built-in iOS map library, but it's entirely open, and works with any map source using a pluggable backend system.
There are three ways that you can install the SDK, depending upon your needs:
- Clone from GitHub and integrate as a dependent Xcode project.
- Use the binary framework. Use like regular frameworks, linking it in your project, adding
#import <MapBox/MapBox.h>, and additionally, including the
- Install via CocoaPods.
The two main branches of the GitHub repository are pretty self-explanatory:
develop. When we tag a release, we also merge
develop over to
release, except in the case of minor point releases (e.g.,
0.4.2), where we might just bring over a fix or two from
Then, update the submodules:
git submodule update --init
Some example apps showing usage of the SDK:
- MapBox iOS Example - online, offline, and interactive tile sources
- MapBox Me - user location services and terrain toggling
- Weekend Picks - markers and data
More documentation is available:
There are two subdirectories - MapView and Proj4. Proj4 is a support library used to do map projections. The MapView project contains only the Route-Me map library.
See License.txt for license details. In any app that uses this SDK, include the following text on your "preferences" or "about" screen: "Uses MapBox iOS SDK, (c) 2008-2012 MapBox and Route-Me Contributors". Your data provider will have additional attribution requirements.
News, Support and Contributing
The MapBox iOS SDK has a support resource where you can open cases and browse other developers' discussions about use of the SDK.
We have a basic technical overview along with the installation instructions.
MapBox has an IRC channel on
To report bugs and help fix them, please use the issue tracker.