Maps SDK, a Microsoft Garage project, is ending. As of February 22, 2024, the SDK is deprecated.
**The SDK will be available until June 30, 2024, and the service will shut down March 1, 2025.**
Our team learned a lot during this experiment, and we appreciate the community's involvement with this Microsoft Garage project.

-----------

<img src="https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/Banner.png">

| [![Getting Started](https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/Plates/GettingStarted.png)](https://github.com/microsoft/MapsSDK-Unity/wiki/Getting-Started) | [![Feature Guides](https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/Plates/FeatureGuides.png)](#Feature-Guides) | [![Sample Project](https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/Plates/SampleProject.png)](https://github.com/microsoft/MapsSDK-Unity/wiki/Sample-project) | [![API Reference](https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/Plates/APIReference.png)](https://github.com/microsoft/MapsSDK-Unity/wiki/API-Reference) |
|:-- |:-- |:-- | :-- |

# Overview
**Maps SDK, a Microsoft Garage project** provides the ability to visualize a 3D map within Unity-based projects. The SDK handles streaming and rendering of 3D terrain data with world-wide coverage.

Select cities and regions are rendered at a very high level of detail.

Maps SDK, a Microsoft Garage project has been optimized for mixed reality applications and devices including the HoloLens, HoloLens 2, Windows Immersive headsets, HTC Vive, and Oculus Rift.

The SDK also provides APIs for services like geocoding and utility classes for working with geospatial data.

See [Microsoft® Bing™ Map Platform APIs Terms of Use](https://www.microsoft.com/maps/product/terms.html) for information about the terms of use for the SDK.

# Feature Guides

| <a href="https://github.com/microsoft/MapsSDK-Unity/wiki/Configuring-the-MapRenderer"><img src="https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/FeatureGuides/WeatherCube.gif" width="280"></a> [Configuring the map](https://github.com/microsoft/MapsSDK-Unity/wiki/Configuring-the-MapRenderer) | <a href="https://github.com/microsoft/MapsSDK-Unity/wiki/Attaching-GameObjects-to-the-map"><img src="https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/FeatureGuides/MtFujiZoom.gif" width="280"></a> [Attaching GameObjects](https://github.com/microsoft/MapsSDK-Unity/wiki/Attaching-GameObjects-to-the-map) | <a href="https://github.com/microsoft/MapsSDK-Unity/wiki/Adding-labels-to-the-map"><img src="https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/FeatureGuides/MapLabels-NewYorkCity-English.png" width="280"></a> [Adding labels](https://github.com/microsoft/MapsSDK-Unity/wiki/Adding-labels-to-the-map) |
| :--- | :--- | :--- |
| <a href="https://github.com/microsoft/MapsSDK-Unity/wiki/Animating-with-MapScenes"><img src="https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/FeatureGuides/BarcelonaPlacesAnimation.gif" width="280"></a>  [**Animating the map**](https://github.com/microsoft/MapsSDK-Unity/wiki/Animating-with-MapScenes) | <a href="https://github.com/microsoft/MapsSDK-Unity/wiki/Raycasting-the-map"><img src="https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/FeatureGuides/RaycastPan.gif" width="280"></a> [**Raycasting the map**](https://github.com/microsoft/MapsSDK-Unity/wiki/Raycasting-the-map) | <a href="https://github.com/microsoft/MapsSDK-Unity/wiki/Customizing-copyrights-display"><img src="https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/FeatureGuides/CustomizeCopyright.png" width="280"></a> [**Displaying copyrights**](https://github.com/microsoft/MapsSDK-Unity/wiki/Customizing-copyrights-display) |
| <a href="https://github.com/microsoft/MapsSDK-Unity/wiki/Customizing-data-sources"><img src="https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/HttpTextureTileLayer-Weather.png" width="280"/></a> [**Customizing map data**](https://github.com/microsoft/MapsSDK-Unity/wiki/Customizing-data-sources) | <a href="https://github.com/microsoft/MapsSDK-Unity/wiki/Displaying-contour-lines"><img src="https://github.com/Microsoft/MapsSDK-Unity/wiki/Content/FeatureGuides/BoulderBalloon.gif" width="280"></a> [**Displaying contour lines**](https://github.com/microsoft/MapsSDK-Unity/wiki/Displaying-contour-lines) | |

# What is in this repo?

This repository includes **samples**, **documentation** and **supporting scripts**. The core source code for the SDK is not part of this repository.

The **supporting scripts** are Unity components and shaders that extend or build on-top of the SDK. Because of their usefulness, the supporting scripts are also included in the SDK package.

The version of the supporting scripts in the repository reflects the latest version of the SDK.

Contributions to the sample project, documentation, or supporting scripts are welcome, and where applicable, approved changes will be included in the next release of the SDK. Refer to the [Contribution Process](CONTRIBUTING.md) for more details.