Getting Started
Package Types
Scene Setup
Economy
Scripting
Components
Guidelines
Support
Installation
Prerequisites: Install Unity
Unity is required to use the Spatial Creator Toolkit. You can install Unity from their official site. Be sure to install one of the supported versions:
- Recommended: 2021.3.21f
- Minimum: 2021.3.8f
- Coming Soon: 2022.3.16 LTS
You must also include the WebGL Build Support module to be able to test in your sandbox space via your web browser. You can leave all other modules unchecked.
Starter Template
To build an experience on Spatial with the Creator Toolkit you will need the Starter Template. This Unity project contains all the components, APIs, and packages you will need to publish to Spatial.
The Starter Templates also includes a number of sample assets to help you get started (find them under Assets > Examples), including:
- Game: Hyper Jump (built with Visual Scripting)
- Space: Feature Demo
- Space: Spatial Island
- Space: Golf Cart Driving
- Vehicle: Golf Cart
- Custom Avatar: Spatian Astronaut
- Avatar Attachment: Space Gun
- Animation: Standing Arguing Reaction
- Prefab Object: Boombox
Opening the Starter Template
- Download the Starter Template at the link at the top of this page.
- Unzip the .ZIP 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 Creator Toolkit.
- Find all the above samples under Assets > Examples
- To check out the Feature Demo scene, head to Assets > Examples > Space_FeatureDemo > Scenes, then open FeatureDemo.unity
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).
- Installation
- Prerequisites: Install Unity
- Starter Template
- Opening the Starter Template
- 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