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

Supported Features and Limitations

Supported Unity Features

See this page for a full list of supported components:

Supported Scene Components

Limitations

C# Scripting

[November 2023] Support for custom C# scripting is coming soon! We will be rolling out support for C# scripts slowly over the coming months.

Learn More about C# Scripting here.

Shaders

You can write your own shaders to customize the look of your environment!

Any shader that works in WebGL, should work across all platforms on Spatial. WebGL has some limitations, like not having the ability to run Compute Shaders and other advanced GPU features.

Current WebGL uses OpenGL ES3.0: https://registry.khronos.org/webgl/specs/latest/2.0/ https://docs.unity.cn/2022.1/Documentation/Manual/EditorCommandLineArguments.html

Tips for Working With Shaders and Textures

Video Player

The Unity built-in video player does not support Web currently. Embedding videos into environments is possible, but they only work on non-web platforms (mobile, headset).

Support for video player on web is something we will support in the future.

← Previous

Synced Object

Next →

Performance Guidelines