Microsoft Maps SDK for Unity 使用教程

1. 项目目录结构及介绍

MapsSDK-Unity/
├── SampleProject/
│   ├── Assets/
│   │   ├── MapsSDK/
│   │   ├── MRTK/
│   │   ├── Scenes/
│   │   └── ...
│   ├── Packages/
│   │   └── manifest.json
│   └── ...
├── SupportingScripts/
│   ├── Shaders/
│   ├── Scripts/
│   └── ...
├── UPM/
│   ├── package.json
│   └── ...
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
└── SECURITY.md

目录结构说明

• SampleProject/: 包含示例项目的所有资源，包括场景、脚本、材质等。
  • Assets/: 存放项目的主要资源文件。
    • MapsSDK/: 包含 Maps SDK 的核心资源和脚本。
    • MRTK/: 包含 Mixed Reality Toolkit 的相关资源。
    • Scenes/: 存放项目的场景文件。
  • Packages/: 包含项目的包管理文件 manifest.json。
• SupportingScripts/: 包含扩展或构建在 SDK 之上的 Unity 组件和着色器。
  • Shaders/: 存放自定义着色器文件。
  • Scripts/: 存放自定义脚本文件。
• UPM/: 包含 Unity Package Manager 的相关文件。
  • package.json: 定义包的元数据和依赖关系。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• CHANGELOG.md: 记录项目的变更日志。
• CODE_OF_CONDUCT.md: 定义项目的行为准则。
• CONTRIBUTING.md: 提供贡献指南。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍和使用说明。
• SECURITY.md: 提供项目的安全指南。

2. 项目启动文件介绍

启动文件

• SampleProject/Assets/Scenes/SampleScene.unity: 这是项目的默认启动场景，包含了 Maps SDK 的基本使用示例。

启动流程

1. 打开 Unity Hub。
2. 选择 SampleProject 文件夹并打开项目。
3. 在 Unity 编辑器中，打开 SampleScene.unity 场景。
4. 点击 Unity 编辑器顶部的 Play 按钮，启动场景。

3. 项目的配置文件介绍

配置文件

• SampleProject/Packages/manifest.json: 这是 Unity 项目的包管理文件，定义了项目的依赖关系和包的版本。

{
  "scopedRegistries": [
    {
      "name": "Maps SDK for Unity",
      "url": "https://unity.virtualearth.net/npm/registry/",
      "scopes": [
        "com.microsoft.maps"
      ]
    }
  ],
  "dependencies": {
    "com.microsoft.maps.unity": "0.11.2",
    "com.microsoft.mixedreality.toolkit.foundation": "2.5.1",
    "com.unity.textmeshpro": "3.0.1"
  }
}

配置说明

• scopedRegistries: 定义了 Maps SDK 的包注册表。
• dependencies: 列出了项目依赖的包及其版本。
  • com.microsoft.maps.unity: Maps SDK 的包。
  • com.microsoft.mixedreality.toolkit.foundation: Mixed Reality Toolkit 的包。
  • com.unity.textmeshpro: TextMesh Pro 的包，用于文本渲染。

通过这些配置文件，开发者可以轻松管理项目的依赖关系，并确保项目在不同环境下的一致性。