Skip to main content

Maps SDK for Unity

Current version: v2.1.1View changelog

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

The Mapbox 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

Install the Maps SDK for Unity

To install the Maps SDK for Unity, follow the instructions in the installation guide. Once installed, you can start exploring some of the examples in the SDK. Also, you can read the Help section for tutorials, troubleshooting guides, and other resources to get you started. If you're interested in working with the API, you can find the documentation in the API reference section.

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.

Editor preview

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.

While you build your map you’ll see the Enable Preview button on the AbstractMap.cs script. Clicking this button displays the map with all current settings.

Map editor

The map editor is a modular, tree-like node editor designed to help developers create their custom map visualizations. Find it 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 the layers on and off. This allows for quick customizations of which style layers to show.

Was this page helpful?