GDK Tools Configuration

The GDK tools configuration specifies project-wide settings related to GDK tooling such as whether to override the Runtime version, where the code generator should generate files and what snapshot to use by default for local deployments.

Usage

You can open the configuration window by opening up your Project Settings using the Edit > Project Settings menu option. From the panel, select Spatial OS.

General

Setting
Description

Environment

The environment argument to provide to GDK tooling such as the spatial CLI and Deployment Launcher.

Runtime Version Override

Overrides the default runtime version used by the GDK for local and cloud deployments.

Code generator

The following settings affect the arguments provided to the code generator.

Setting
Description

Verbose logging

Toggles verbose logging of the code generator.

Log output directory

The directory, relative to the Unity project root, where code generator places its log files.

C# output directory

The directory, relative to the Unity project root, where the code generator should place non-Editor generated code.

C# Editor output directory

The directory, relative to the Unity project root, where the code generator should place Editor-specific generated code.

Descriptor directory

The directory, relative to the Unity project root, where the code generator should place the generated descriptor.

Schema sources

A list of directories, relative to the Unity project root, containing schema that are not already in a package. Note that the GDK automatically finds and provides paths to any .schema folder found inside a package.

Development authentication token

The following settings pertain to the generation of development authentication tokens.

Setting
Description

Token lifetime (days)

Sets the lifetime for requested development authentication tokens, between 1 and 90 days. Changes made to this setting do not affect existing tokens.

Save token to file

Sets whether to save the development authentication token to a file, instead of in player preferences.

Token directory

The directory, relative to the project's Assets/ folder, where development authentication tokens will be saved to if saving to file is enabled. The full path is displayed in the window for ease of use.

Snapshot

The following setting pertains to the snapshot used by local deployments.

Setting
Description

Selected snapshot path

The snapshot the GDK will use for local deployments.

Updated about a year ago


GDK Tools Configuration


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.