Using Our Packages

Choose the path that's right for you.

For Beginners and Newcomers

Read-only permission

1. Follow the Getting Started instructions to download the correct Unity version and MeshMap Example Project you want to remix.

2. Open the downloaded project via Unity Hub. The relevant packages, samples, and settings are already setup.

3. Remix it and share your creations!

---

For New/Existing Unity Projects

Read-only permission

1. Create or open your project via Unity Hub.

2. Add the VContainer scoped registry by including the information below via Edit > Project Settings > Package Manager > Scoped Registries or by directly editing the Packages/manifest.json file.

"scopedRegistries": [
   {
      "name": "package.openupm.com",
      "url": "https://package.openupm.com",
      "scopes": [
         "jp.hadashikick.vcontainer"
      ]
   }
],

1. Import any Package Dependencies that are listed for each MeshMap Unity package (Core, XR, ML2 Support, Building Blocks) you plan to use in your project.

2. Go to Window > Package Manager > Add Package from git URL... and paste the git URL, then click Add.

   1. For example, https://github.com/MeshMap/com.meshmap.sdk.xr.git

   2. If you want to import a specific version, include the release number. For example, https://github.com/MeshMap/com.meshmap.sdk.xr.git#v0.0.1

   3. If you are using Mac, use this path format instead [email protected]:MeshMap/com.meshmap.sdk.xr.git#v0.0.1

3. Accelerate your project development with real-world scans, cross-platform tooling, and various building blocks!

---

For Contributors

Read and write permissions

1. Follow steps 1 through 3 above.

2. Clone the package's Git repository (Core, XR, ML2 Support, Building Blocks) to your computer and create a new local branch.

3. In the Packages/manifest.json file, add a dependency reference to the cloned repository.

{
   "dependencies": {
      "com.meshmap.sdk.xr": "file:/path/to/com.meshmap.sdk.xr/"
   }
}

By adding the package this way, Unity will treat it as editable. You can reference the package this way across all your projects and the edits will be synced, reducing the chance of code conflicts.

1. Suggest new features, patch bugs, and support the open-source XR community!

---

Basic Usage

After import, the files will be available in the Packages section of the Project window in Unity Editor.

The files will not work outside the Packages section due to dependencies and assembly definitions that are specific to the Editor and Runtime, so be sure to import them correctly using one of the processes described above.

Editor

Any custom editor windows and tools can be accessed via the MeshMap section of the toolbar at the top of the Unity Editor.

Samples

Import any samples via Window > Package Manager > package-name > Samples.

For contributors, there are a few steps to ensure that changes to Samples are synced properly and asset GUIDs are not mismatched or overridden.

1) Close the project.

2) Rename the package's Samples~ folder to Samples.

3) Delete any of this package's already imported samples from your project's Assets folder.

4) Open the project.

5) Make your changes in the package's Samples folder.

6) Close the project.

7) Rename the package's folder to Samples~ and delete Samples.meta if it was created.

8) Commit changes in a branch and submit a pull request.