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

Using an Existing Unity Project

Already have a Unity project? No problem! Follow these steps to convert your project to work with Spatial.

1. Download the Starter Template

Click here to download it. 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>

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.

Untitled

Screen Shot 2022-11-07 at 5.16.40 PM.png

3. Close your project and open the 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.

  1. Open the Spatial Configuration panel using the ⚙️ icon in the top right toolbar.

  2. Drag your unity scene into the Environment Variant slot.

    Untitled

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

← Previous

Getting Started

Next →

Samples & Examples