Reference
Engine API
For teams embedding the engine in their own code.
Studio is built on a reusable engine, published as a package for teams who want to run engine content in their own web app. Most creators never need it; the editor and the play page cover the whole workflow.
Runtime
<GameRuntime mapDocument config mode projection />
Renders a map document as a scene, in edit or play mode, in 2D or 3D.
deriveMapData(doc: MapDocument): MapRuntimeData
Resolves walkable space, spawns and collision from a map. The same derivation runs in the editor and in published games.
<FirstPersonController config mapData callbacks />
Pointer-locked first-person movement against derived map data.
Registries
registerObjects(definitions: ObjectDefinition[]): void
Adds object types. Registered objects appear in the editor palette with an inspector built from their parameter schema.
NEUTRAL_BIPED_DEFINITION: CharacterDefinition
The stock rigged biped and its 45 clips.
Entry points
| Import | Contents |
|---|---|
| @sstk/build-kit | Runtime, registries, editor overlay, audio, core assets |
| @sstk/build-kit/2d | Tilemap and sprite scenes |
| @sstk/build-kit/logic | The shared Logic rule runtime |
| @sstk/build-kit/scripting | HollowScript capabilities and runtime |
The shape of a project\'s saved data is in Content schema.