Installation and downloads

Get installers, engine binaries, and SDK packages through the links below. Contact your FSL representative for package access credentials.

SpatialStudio

Get the signed installer from the SpatialStudio product page. The technical preview provides macOS Apple silicon and Windows x64 installers.

The installer includes Studio, a native SpatialEngine, Python, and the matching SDK. Projects can declare additional Python packages. Projects with a frontend build step also need its toolchain.

Preview releases can include an engine expiration date. Update the installation when that release expires. Check the release’s license and evaluation terms on the product website.

Run your first app.

Native SpatialEngine

Use the native binary supplied for your release and platform. Obtain standalone release artifacts and access credentials from your FSL representative.

Start the supplied SpatialEngine executable. It runs without a desktop window. Your application controls it through the statement API.

SpatialEngine

The engine also serves a web portal: a browser interface for viewing and interacting with the running engine. Open http://localhost:8080 to explore its available tools. Open http://localhost:8080/streaming to view the scene and control its camera before you build your own UI.

The default gRPC port is 50051. Read the startup output for the actual addresses. An unsupervised engine can use another port when a default is occupied.

Python SDK

Studio includes the Python SDK and installs it into each managed project environment. You can start a Studio app with import spatialengine without downloading a wheel separately.

For an application outside Studio, request the SDK wheel together with your standalone SpatialEngine binary from your FSL representative. The wheel and binary must come from the same release.

Use Python 3.10 or newer and install the supplied wheel into your application’s environment. Network clients need the grpc extra:

python -m pip install "./spatialengine-<version>-py3-none-any.whl[grpc]"

Replace <version> with the version on the supplied wheel.

Connect your Python application.

Browser SpatialEngine

Find @fslabs/spatialengine in the FSL package catalog. Sign in with an account that has access to the package.

Configure the scope in your project’s .npmrc:

@fslabs:registry=https://git.fsl.dev/api/packages/fslabs/npm/

Configure registry authentication with the credentials provided for your account. If you use an environment token, keep the reference in your user-level npm configuration:

//git.fsl.dev/api/packages/fslabs/npm/:_authToken=${FSL_NPM_TOKEN}

Set FSL_NPM_TOKEN in your local environment or CI secret store. Then install the release your app targets:

npm install @fslabs/spatialengine

The package includes the WebAssembly engine. Serve its runtime assets with your application. Pin the package version in your project’s lockfile.

Build a browser app.

SpatialDrive

Use the published image from the FSL package catalog:

docker login git.fsl.dev
docker pull git.fsl.dev/fslabs/spatialdrive:<release-tag>

Replace <release-tag> with the release selected for your deployment. Obtain registry access from FSL. Production deployments should pin a release tag or digest.

The image entrypoint is the server binary. It needs database, storage, and authentication configuration before it can serve projects.

Run the server or deploy with Terraform.