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

cs_header.png


<aside> πŸ’Ž The Creator Toolkit also supports Visual Scripting. Learn more here.

</aside>

Spatial C# Scripting Overview

Spatial Creator Toolkit supports C#, giving you access to a powerful programming language to build interactivity in your projects. C# scripting integrates seamlessly with Unity3D as well as the Spatial Creator Toolkit, perfect for unleashing your creativity.

<aside> πŸ¦‰ To get started immediately, visit the C# - Getting Started page.

</aside>

Unity C# Scripting Support

Most of the C# scripting supported in the Creator Toolkit is out-of-the-box C# scripting in Unity. This means that if you're familiar with scripting in Unity, you'll feel right at home in Spatial.

There are some key differences from standard Unity development:

Having access to Unity’s APIs in your project gives you amazing creative possibilities.

<aside> πŸ—’οΈ If you're new to C# scripting in Unity or need a refresher, Unity's comprehensive documentation is an excellent resource.

</aside>

<aside> <img src="/icons/warning_red.svg" alt="/icons/warning_red.svg" width="40px" /> Spatial supports a subset of Unity C# APIs for security reasons. These limitations are enforced for you through the editor; learn more on our C# Scripting API Limitations page.

</aside>

Spatial C# Scripting API Reference

Spatial offers access to custom services for controlling camera, avatars, synced objects, quests, and more.

<aside> πŸ“œ For full API documentation, see: Spatial Creator Toolkit Scripting API

</aside>

For samples, see:

Third-Party Packages

Spatial maintains a list of some examples of Third-Party Unity packages with porting instructions.

Questions, Feedback, or Need to Use ___ API But It’s Not Supported?

<aside> <img src="/icons/thought-dialogue_gray.svg" alt="/icons/thought-dialogue_gray.svg" width="40px" /> If you need functionality of a certain API that is not supported let us know! We might be able to expand our supported APIs or write similar functionality in a Spatial-unique API.

Additionally, we want your feedback regarding our documentation. Is something missing, not clear, or maybe we need to up our code sample game?

The best place to give this kind of feedback directly to the team is the Creator Toolkit section of the Spatial Discord.

</aside>

<aside> πŸ—’οΈ C# support went into public beta as of February 9th, 2024.

</aside>


← Previous

Selling Items

Next β†’

Key Differences