Getting Started
Package Types
Scene Setup
Custom Collision, Layers, and Tags
Key Differences from Standard Unity3D development
Economy
Scripting
Components
Environment Settings Overrides
Render Pipeline Settings Overrides
Guidelines
Supported Features and Limitations
Support
Getting up and running with the Creator Toolkit takes less than 10 minutes — let’s get started!
The first thing you’ll need is to have Unity installed. You will need version 2021.3.21 to be able to test in your sandbox space. The minimum version that we support is 2021.3.8.
If you don’t yet have the Unity Hub installed, you will need to install it first. You can do so by following this link.
Installing Unity
2021.3.21 on this page.
The easiest way to get started with Spatial is with a new Unity Project
**Click here to download the starter template.**
Unzip the archive and open the project from Unity Hub.
Once the project is opened you may see an update dialog. Click yes to update to the latest version of the Spatial Unity SDK.
Then open the “Environment.unity” scene:
Now you will need to authenticate with Spatial. Under the main menu bar, select “Spatial SDK/Account”. Follow steps outlined in the window.
Now you are ready to test this package directly in Spatial. Click the “Test” button in the main unity toolbar.
When this process is completed, the environment will be loaded directly into your spatial Sandbox.
When you are ready to show your space to the world, select your package in the Spatial editor window (press the gear icon in the toolbar), then press “Publish”.
The publishing process packs up your project’s source assets, then queues a build process to prepare your space for all of our supported platforms. This typically takes less than 30 minutes, but in times of high-demand, it could take a few hours.
When the space is fully processed, you will receive an email notification. Open the app on your preferred platform and you should see your space show up under “Your Spaces” category.
You’re ready to build and publish on Spatial! Explore our Creator Toolkit features such as Interactables, Visual Scripting, Monetization, and so much more! Test your changes instantly in the Sandbox, and publish effortlessly to web, mobile, and VR. We can’t wait to see what you build 👽
Already have a Unity project? No problem! Follow these steps to convert your project to a Spatial project.
Click here to download the starter template. This project is already ready to go, and comes fully configured. Bringing your assets into this project is the easiest way to ensure your package will work correctly in Spatial.
<aside> ⚠️ Double check that you have a supported version of Unity installed, which you can find listed here. If you have a different version of Unity than what is listed, some things may or may not work properly.
</aside>
Open your project, and select all the assets under “Assets” in your Project panel. Once selected, click the “Export package…” under the “Assets” menu item in the main toolbar. Save this somewhere on your drive.
In the next step, we’ll import your assets into the Spatial Starter Template.
With the starter template project opened, select “Assets/Import Package/Custom Package” and select the file you saved earlier.
Open the Spatial Configuration panel using the ⚙️ icon in the top right toolbar.
Drag your unity scene into the Environment Variant slot.
You can keep the Starter Template asset in your project as reference, or you may delete all of it (except for the contents of the Assets/Spatial directory).
Next →