The Mapbox Maps SDK for Unity is a set of tools to build Unity applications from real map data. It consists of a robust API for interfacing with Mapbox web services and converting map resources into game objects as well as a robust graphical user interface built on top of the Unity platform. This guide provides an overview of how the Mapbox Maps SDK for Unity works, how to use it, and how to get started building applications.
How the Mapbox Maps SDK for Unity works
The Mapbox Maps SDK for Unity is designed to help Unity developers add dynamic map data to their games and applications by providing a straightforward programmatic and graphical interface to Mapbox’s web services APIs, including the Mapbox Maps API, Geocoding API, and Directions API.
While some map-centric Unity plugins are designed to help developers build static game environments from map data, the Mapbox Maps SDK for Unity is designed to request and render map data at runtime. This means that applications built with the Maps SDK for Unity will always display the most recent version of spatial data. It also means that games and applications only ever request the subset of data that corresponds with the area the user is viewing, keeping games and applications lightweight.
The Mapbox Maps SDK for Unity provides the ability to generate meshes to create 2D or 3D maps, with satellite imagery, custom map styles, terrain data, and points of interest. See the mesh generation tutorial to get started.
The Mapbox Maps SDK for Unity provides support for augmented reality, whether you’re making a tabletop AR app or the next PokemonGo.
Using the Mapbox Maps SDK for Unity
The Mapbox Maps SDK for Unity is used with the Unity desktop application.
Installing the Mapbox Maps SDK for Unity
Creating game objects
The Mapbox Maps SDK for Unity can be used to build rich environments from a variety of different types of data, including terrain data, raster map tiles, and vector map tiles, among others.
The Mapbox terrain-rgb tileset is designed for high resolution elevation visualizations and it is especially well-suited to creating 3D meshes with Unity. See the Mesh generation basics example for more information.
Features from vector tiles
Whether you’re using a Mapbox tileset or a custom tileset you created via the Mapbox Uploads API, the Mapbox Maps SDK for Unity can request vector tiles, convert them into game objects or meshes, and render them alongside the rest of your game data. See the Slippy map example for more information.
Accessing Mapbox web services
The Mapbox Maps SDK for Unity can connect your game or application to many of Mapbox’s web services APIs, including the Mapbox Maps API, Geocoding API, and Directions API. See the various Playground examples for more information on interacting with Mapbox APIs.
The Mapbox Maps SDK for Unity works anywhere Unity works, including, desktop, and mobile and coming soon to the web.
Mobile applications built with our Maps SDK for Unity track usage with monthly active users (MAU). This means each device using your app within a month counts as a single MAU. All other apps built with Unity are charged by map views. All types of applications are metered for usage of the Mapbox APIs, like Geocoding and Directions, when they surpass what’s included with the free plan.