markdown-body entry-content container-lg" itemprop="text">

Important

Effective June 24th, 2025, the Microsoft Mesh toolkit has been retired, and Microsoft Mesh will evolve.

As part of our ongoing commitment to deliver the best possible experience to our Microsoft Mesh customers, we are evolving how users interact with customization tools and scripting features. The Mesh Toolkit and Mesh’s customization capabilities will undergo significant changes in the near future to streamline operations and prepare for future enhancements. We plan to transition all customization to our in-app, no-code customization experience.

As we transition to this new way to create Mesh experiences, we will change the current implementation and availability of creator tools. Effective June 24, 2025, publishing new environments to Mesh with the Mesh toolkit will not be supported. Existing environments published before June 24, 2025, may still continue to function as expected but cannot be edited with the Mesh toolkit. As no-code customization tools become available, organizations will be able to more easily create and maintain similar immersive experiences. We will publish guidance on best practices for rebuilding your experiences as the tools become available and will also ensure that we give creators sufficient time to recreate experiences using these new tools before the previous iterations become unavailable.

Mesh Toolkit for Unity

The Mesh Toolkit enables creators and developers to build custom 3D environments and experiences to meet specific business needs: new employee onboarding, training, guided tours, social gatherings, and more.This repo contains tutorial and sample projects that you can use as a starting point for building your custom 3D experiences.

Getting started

For detailed instructions on getting started with development for Microsoft Mesh, visit our documentation at learn.microsoft.com.

You can begin creating a custom 3D environment from one of our tutorials or samples. Or, install the Mesh Toolkit in your own Unity project.

Installing the Mesh Toolkit

To add the Mesh toolkit package to your Unity project:

Open your Unity project, and then on the menu bar, select Edit > Project Settings > Package Manager.
Add a scoped registry with the following details:
- Name: Mesh Toolkit
- URL: https://registry.npmjs.org
- Scopes(s): com.microsoft
Click the Save button.
Close the Project Settings window, and then, on the menu bar, go to Window > Package Manager.
In the toolbar, click the Packages dropdown and then select My Registries.
In the list, you'll see the current build of the Microsoft Mesh Toolkit.

Select Microsoft Mesh Toolkit (the full package name should be com.microsoft.mesh.toolkit, as highlighted in the image below) and then click the Install button.

When the spinner animation next to the package list stops, the package has finished downloading.

Tutorials

If you're new to Mesh and like the idea of learning through a step-by-step tutorial, we recommend that you try one of our tutorials.


Mesh 101: Start here to learn about foundational features in the Mesh Toolkit.	Mesh 201: Explore more of the Mesh Toolkit. Learn how to pull external data sources into Mesh.

Samples

You can start with a sample project to quickly get inspired about what you can build with Mesh. These projects are already set up with the Mesh toolkit.


Pavilion: A minimalist, modular, and high-performance environment for Mesh creators to explore interactive activities and assets created with the Mesh Toolkit.	Physics showcase projects: Get things moving with physics in three example projects: a physics effects gallery, a science building, or a dart room.

Packages

Many of the tutorials and samples are built using reusable packages. You are encouraged to use these building blocks in your own projects to kickstart development.


Toybox Package: Add games and other engaging activities to your Mesh experiences.	Control Samples Package: Provides common in-world user interface controls.

NOTICE: The tutorials, samples, and packages in this project are governed by the MIT license as shown in the LICENSE.txt file. However, the samples functionality is dependent on the Mesh Toolkit, which is governed by a separate license.

Contributing

Mesh is a new product from Microsoft, and at this time we are not accepting code contributions to our repo. If you have any feedback or if you run into any issues with the samples or the Mesh Toolkit, you can let us know in the following two ways:

In a Unity project that has the Mesh Toolkit package installed, select Mesh Toolkit -> Give feedback to Microsoft and then use the feedback link in the Mesh Toolkit to let us know.
Connect with us and the community by joining the Microsoft Mesh Creator discussion space!

Trademarks

Trademarks This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.

License

microsoft/Mesh-Toolkit-Unity

ErrorLooks like something went wrong!

About

Resources

License

Code of conduct

Security policy

Uh oh!

Stars

Watchers

Forks

Releases 37

Packages 0

Uh oh!

Contributors 3

Uh oh!

Languages

Error
Looks like something went wrong!

Packages