⚠️ Packages with precompiled DLLs are not supported.
All C# code must be in your Creator Toolkit Space’s C# assembly.
Packages must not use any of the APIs banned by the Spatial C# Scripting Runtime.
To port a third-party package:
- Copy the package’s source into your Creator Toolkit Space’s C# assembly folder.
- If the package has any runtime assemblies of its own (i.e. .asmdef), those need to be removed and any missing references must be resolved. Assemblies in an Editor folder do not need to be removed.
- Check for errors or warnings about banned APIs.
- If there are banned APIs in editor-only code, ensure that the code is in a Editor folder, or that you use a #if UNITY_EDITOR directive.
- For banned API usage in runtime code, remove the code if possible and replace with alternate APIs. See also our guide to allowed and banned APIs as well as the rest of this document for guidance.
- In practice, we’ve found that many packages can be adapted with a moderate amount of effort. ⚠️ However, some packages cannot be supported if they have a hard dependency on banned APIs.

You can find a list of third-party packages with porting instructions here, including packages such as tweening and car control packages.

Camera

Spatial does not provide access to Camera.Main; instead i provides its own camera API. For more details on this, and on using Cinemachine, see the Camera documentation.

PlayerPrefs, Save Data, and the Data Store

Spatial does not support PlayerPrefs. Instead we have a cloud-save system we call the DataStore.

Saving to the DataStore creates a server request so we rate limit writes. This means inside your game-loop you should be reading/writing your save data to an intermediary C# object which you periodically write to the DataStore.

For more information view the DataStore API Reference.

Resources

A common technique for referencing assets in Unity is to drop them all inside a /Resources folder then load them at runtime with Resources.Load(.... Unfortunately, Unity3D does not allow Asset Bundles to add contents to Resources, so Spatial does not allow Creator Toolkit projects to use Resources.

Strategies for Referencing Assets

Instead, you can re-create the Resources.Load workflow with ScriptableObjects. Create an object that holds a collection of UnityEngine.Objects and then add the assets you want to reference to it.

[CreateAssetMenu(fileName = "NewAssetCollection", menuName = "AssetCollection")]
public class AssetCollection : ScriptableObject
{
    public UnityEngine.Object[] assets;
}

You can then search through the AssetCollection.assets by object name similar to Resources.Load.

<aside> <img src="/icons/light-bulb_red.svg" alt="/icons/light-bulb_red.svg" width="40px" /> Remember that packages uploaded only contains the dependencies of a scene. If your AssetCollection is not directly referenced by a GameObject in the scene it will not be included.

</aside>

Scene Management

A key limitation of Spatial Creator Toolkit projects is they can only have one scene. This means that if you’re used to creating several scenes for different levels, or even reloading the same scene to reset the game, you’ll have to design around this limitation.