Unity Integration

You'll need to install our Unity plugin to import Shapes spaces into the Unity editor. This allows you to enhance your spaces with interactive elements, model replacements, particle systems, and more. However, please note that exporting spaces back to Shapes is currently not supported.

Installing the Unity Plugin

  1. Install Unity (go to the official Unity page and install Unity Hub by clicking the Download Unity Hub button). If you already have it installed - skip to the next step.

  2. Create a project

Open the Unity Hub and click the “New Project” button. Choose the “3D” template, set the project name and location, then click “Create”.

  1. Import Shapes Unity Integration Package.

Once Unity opens, go to Window -> TextMeshPro -> Import TMP Essential Resources.

Click Import in the opened window.

It's recommended (though not mandatory) to set the color space to Linear for accurate color representation upon importing. To do this, navigate to Edit -> Project Settings -> Player -> Other Settings, and then set the Color Space option to Linear. If you prefer to use the Gamma color space, you can skip this step.

Go to Assets -> Import Package -> Custom Package and select the ShapesXR Unity Integration package you’ve downloaded.

Click “Import” in the next window.

Unity plugin usage

To import your space you have to open the importer window by going to ShapesXR -> Importer. You can dock this window wherever you want (e.g. next to the Inspector tab).

In the importer window put your access code (8 characters) into the input field and click the “Import Space” button. Access is not case-sensitive.

After the space is imported, you will see a new game object on the scene representing your space

You can also expand the “Settings” panel in the importer window to change the imported data storage directory, material import mode, and material mapper. Material mapper allows you to use your custom shaders instead of the built-in ones. Open any material mapper asset in the inspector to see how you can map your own materials if needed. Built-in and URP material mappers are included in the package by default.

Space game object has all the stages and viewpoints inside it. It also has a “Space Descriptor” script that allows you to see the access code, quickly cycle through stages, and reimport (with a complete wipe) your space. You can safely remove this component in case you don’t need this functionality.

It’s still possible to use the plugin in Unity 2020 with .Net 4.x compatibility enabled in player settings.

GLB/GLTF formats support

Please note that we don’t support multiple textures per material yet and your models must comply with import recommendations for best results.

You can import GLB/GLTF models from your space to Unity.

Tutorial: Unity Plugin for ShapesXR

Last updated