# Core

`v0.4.0-pre.7`   `30 Oct 2025`

The **MeshMap Core** package contains foundational systems, services, and data models for the MeshMap API, including account authentication and scan retrieval.

{% hint style="warning" %}
We do not yet recommend shipping this package in production or commercial projects. APIs may change without notice, and breaking changes are expected.
{% endhint %}

[**Changelog**](https://github.com/MeshMap/com.meshmap.sdk.core/blob/main/CHANGELOG.md)

***

## API Key

Create a [MeshMap account](https://app.meshmap.com/) and configure your [app API key](https://app.meshmap.com/apps) in the MeshMap Hub editor window (`MeshMap > MeshMap Hub`) to use the Auth, Scans, and Apps features.

***

## Features

* [**Auth**](https://docs.meshmap.com/unity-sdk/core/auth) — Login and token handling for MeshMap services.
* [**Scans**](https://docs.meshmap.com/unity-sdk/core/scans) — Retrieving and loading MeshMap scans.
* [**Apps**](https://docs.meshmap.com/unity-sdk/core/apps) — Tracking play sessions and scores across apps.

***

### Samples

To import a sample into your Unity project, go to `Windows > Package Manager > MeshMap Unity SDK > Samples`.

* **Auth and Scan Import** — Demonstrates how to set up a simple runtime user flow for account login/logout, persistent authentication, loading paginated lists of user scans and public scans, and importing one scan into the scene at a time. Optionally, you can generate NavMesh data for the scan to use it as a `NavMeshSurface` for agents.

***

### Tools

* [Flat Surface Identifier](https://docs.meshmap.com/unity-sdk/core/tools/flat-surface-identifier) — Editor tool for visualizing potential areas to place fiducial markers on site.
* [AR Marker Generator](https://docs.meshmap.com/unity-sdk/core/tools/ar-marker-generator) — Editor tool for creating custom fiducial markers (AprilTag, ArUco marker, QR code) that can be used to localize AR content.

To use a tool in your Unity project, go to `MeshMap > Tools > [tool name]`.

***

## Getting Started

### Requirements

* **Unity 2022.3.11 LTS** or later
  * Universal Render Pipeline (URP)

***

### Package Dependencies

* VContainer v1.16.8 (scoped registry)
* ZXing.NET v0.16.10 (already included)
* Unity Newtonsoft JSON v3.2.1 (already included)
* Unity AI Navigation v1.1.5
* Unity gltFast v6.8.0
* Unity TextMeshPro v3.0.7
  * Make sure to [Import TMP Essential Resources](https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/manual/index.html).

***

### Import

The [com.meshmap.sdk.core](https://github.com/MeshMap/com.meshmap.sdk.core) package can be added via Unity Package Manager (UPM) from Git. Follow the import [instructions](https://docs.meshmap.com/unity-sdk/overview/using-our-packages).