Getting Started

Introduction

Installation

Project Configuration

Testing in Your Sandbox

Samples & Examples

Core Concepts & Glossary

Package Types

Spaces & Space Templates

Custom Avatars

Custom Avatar Animations

Avatar Attachments

Custom Prefab Objects

Embedded Packages

Drivable Vehicles

Scene Setup

Testing In Unity vs Sandbox

Controlling the Camera

Custom Collision, Layers, and Tags

Audio Mixers and Groups

Key Differences from Standard Unity3D development

Economy

Quests and Rewards

Economy Overview

Monetization

Items

Consumable Items

Rewarding Items

World Currency

Selling Items

Scripting

Components

Entrance Point

Camera Passthrough

Interactable

Trigger Event

Point Of Interest

Environment Settings Overrides

Render Pipeline Settings Overrides

Movement Materials

Climbable

Avatar Teleporter

Empty Frame

Projector Surface

Seat Hotspot

Guidelines

Supported Features and Limitations

Performance Guidelines

Lighting

Publishing to Spatial

Finding Published Packages

Support

FAQs

Help and Support

Release Notes

Asset Import Settings

Getting Started

https://youtu.be/7POS5WNbBYM

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.

Starting a New Project

The easiest way to get started with Spatial is with a new Unity Project

1. Download the Starter Template

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.

Screen Shot 2022-11-17 at 5.13.11 PM.png

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.

Screen Shot 2022-11-07 at 10.27.55 AM.png

When this process is completed, the environment will be loaded directly into your spatial Sandbox.

Untitled

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”.

Untitled

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.