Getting Started
Unity Package Types
Components
Economy
Scripting
Guidelines
Support
Getting Started
Getting up and running with the Creator Toolkit takes less than 10 minutes — let’s get started!
Prerequisite: Install Unity
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
.
- Install through Unity Hub
Starting a New Project
The easiest way to get started with Spatial is with a new Unity Project
1. Download the Starter Template
- 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:
2. Authenticate with Spatial
Now you will need to authenticate with Spatial. Under the main menu bar, select “Spatial SDK/Account”. Follow steps outlined in the window.
3. Test in your Sandbox Space
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.
4. Publish
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.
5. Build your own!
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 👽
Using an Existing Unity Project
Already have a Unity project? No problem! Follow these steps to convert your project to a Spatial project.
1. Download the Starter Template
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.
2. Export your project as a Unity package
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.
3. Close your project and open the Starter Template
In the next step, we’ll import your assets into the Spatial Starter Template.
4. Import your Unity package into the Starter Template
With the starter template project opened, select “Assets/Import Package/Custom Package” and select the file you saved earlier.
5. Setup your environment scene as a Spatial environment.
- Open the Spatial Configuration panel using the ⚙️ icon in the top right toolbar.
- Drag your unity scene into the Environment Variant slot.
6. Cleanup
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 →
- Getting Started
- Prerequisite: Install Unity
- Starting a New Project
- 1. Download the Starter Template
- 2. Authenticate with Spatial
- 3. Test in your Sandbox Space
- 4. Publish
- 5. Build your own!
- Using an Existing Unity Project
- 1. Download the Starter Template
- 2. Export your project as a Unity package
- 3. Close your project and open the Starter Template
- 4. Import your Unity package into the Starter Template
- 5. Setup your environment scene as a Spatial environment.
- 6. Cleanup