Overview

Maps SDK for Unity

Current version: v2.0.0 View changelog

  • Vector map of the world
  • Cloudless satellite base map
  • Global digital elevation model
  • Custom data

The Maps SDK for Unity is a collection of tools for building Unity applications from real map data. It enables Unity developers to interact with Mapbox web services APIs (including the Maps, Geocoding and Directions APIs) and create game objects via a C#-based API and graphical user interface.

Getting started

To install the Maps SDK for Unity, follow the instructions in the installation guide. Once installed, you can start exploring some of our existing examples in the SDK or read our step-by-step tutorials.

Example scenes

The Maps SDK for Unity comes with several example scenes to showcase various features and possibilities of the SDK. You can find these scenes by navigating to Mapbox > Setup, or by looking at the Examples folder in the Project window and double-clicking on a Scene file to open it. Look at the installation guide for more information.

Explore the map editor

The Map Editor is a modular, tree-like node editor designed to help developers create their custom map visualizations. It can be found under Mapbox > Map Editor in the Unity top bar. While it is not necessary to use, it is a valuable tool for navigating and understanding the underlying structure of a map.

Each node is a ScriptableObject in the mesh generation structure, and corresponds directly to a file in the project. Click on a node to see its settings in the Inspector panel.

The Map Editor also includes checkboxes next to the vector factory's layer visualizers, which allows you to toggle them on and off. This allows for quick customizations of which layers to show.

Use this documentation

Examples

The Examples section contains detailed explanations of the example scenes contained in the Maps SDK for Unity

Help

The Help section contains tutorials, troubleshooting guides, and other resources to help you get started.

API reference

In the API reference, you can view the complete reference documentation for the Maps SDK for Unity.