Unity Integration
Install our Unity plugin to import ShapesXR 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 ShapesXR is currently not supported.
Installing the Unity Plugin
Please note that we highly recommend using Unity 6, as it ensures a smoother experience without additional setup.
If you've already installed an old version of the Unity plugin, please remove it and install it again by following the steps below.
Install Unity (go to the official Unity page and install Unity Hub by clicking the Download button). If you already have it installed, skip to the next step.
Open the Unity Hub and click the “New Project” button.
Choose the Editor Version (we recommend version 6), “Universal 3D” template, set the project name and location, and then click “Create project”.
Go to Edit -> Project Settings -> Package Manager and add the following dependencies:
Alternatively, you can open the YOUR_PROJECT/Packages directory in the file manager, find the manifest.json file there, open it, add this block on top, before the “dependencies” line, and save changes:
"scopedRegistries": [
{
"name": "package.openupm.com",
"url": "https://package.openupm.com",
"scopes": [
"com.neuecc.messagepack"
]
}
],Please note how it should look in the manifest.json file:
Open the YOUR_PROJECT/Packages directory in the file manager, and unpack the downloaded zip into it.
Return to your Unity project and wait until the import process is complete and all scripts have finished compiling. Once done, the ShapesXR tab will appear in the main menu — your plugin is now ready to use.
Unity plugin usage
Go to the ShapesXR tab and select Importer. The plugin window will open, and you can dock it anywhere you prefer — for example, next to the Inspector tab.
In the ShapesXR Importer window, enter the code of the space you want to import (learn how to find the Space code here) in the input field, then click Import Space.
If prompted by Unity during the first space import, please import the TMP Essentials package.
After the space is imported, a new game object will appear in the scene, representing your space along with all its scenes and viewpoints.
Select your space in the Hierarchy. In the Inspector tab, you’ll see the Space Descriptor script enabled. This script lets you view the space code, quickly cycle through scenes using a slider, and reimport your space. You can safely remove this component if you don’t need these functions.
You can also expand the Settings panel in the Importer window to adjust the imported data storage directory, material import mode, and material mapper. The Material Mapper allows you to use your own shaders instead of the built-in ones. Open any material mapper asset in the Inspector to see how materials can be mapped if needed. URP and Built-in material mappers are included in the package by default.
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.
To import them into Unity, you need to install a GLB/GLTF plugin. We recommend glTFast (GitHub - atteneder/glTFast: Efficient glTF 3D import / export package for Unity)
In case you’re using another plugin, you should add a name for the shader property for your main texture, since every plugin might generate and use different materials/shaders.
Join our Discord server to ask any questions regarding the Unity plugin and share your creativity with us. Or email us with any questions at [email protected].
Last updated