Quickstart

Install and sign in

Download SpatialStudio for your platform and install it. Open Studio and sign in through the system browser.

Studio sign-in authorizes Studio use. Connecting an app to a SpatialDrive deployment also requires that deployment’s identity and project access.

Start from a sample

Open Hello App from the sample collection. Save a copy into your own project folder, then run it.

Studio prepares the project’s Python environment, starts an engine, executes the entry file, and opens the live preview. Output and engine logs appear in the console.

The sample’s controls call Python handlers. Those handlers use the SpatialEngine SDK. The viewport receives the native engine’s rendered scene.

Change the application

Open main.py and change the message passed to client.std.print. Save and run the project again. Use the output to confirm that the saved file ran.

The engine connection is:

import spatialengine

client = spatialengine.connect()
client.std.print(message="My first Studio app")

Studio supplies the connection address. You do not need to start an engine separately or hardcode a port.

Stop and restart

Stop ends the engine and Python process for that run. Starting another run creates a new engine. Save project data explicitly if it must survive a restart.

Project state and the project API describe saved data. Temporary scene shapes do not persist.

Build a frontend

For Hello React, install the frontend toolchain and use the sample’s build command before viewing its page. Frontend builds produce ordinary files that the Python app serves.

Custom UI explains how this differs from a browser-only WebAssembly app.