# Satie in Unity

Install the Satie package, bind sounds to your GameObjects, and mix while the game plays.

macOS editor tested; device validation varies

[Documentation](https://www.satie.world/docs/unity)

## 1. Install from your project



1. Connect your coding agent from Get started, then open the Unity project folder containing Assets and Packages. The install command requires Node.js 18 or newer.
2. Ask the agent to use satie_setup for unity, inspect the scene, compose and realize the audio, then call satie_export with engine set to unity.
3. Run the exact install command returned by the export from the Unity project root. It downloads the scene and recordings, installs Packages/world.satie.unity, and compiles the scene into Assets/Resources/SatieCore.
4. Return to Unity and let the assets import. Press Play. A Satie object starts automatically when the compiled scene is present; no manual audio-file assignment is required.

Ask your coding agent

```
Integrate Satie into this Unity project. Use the current Unity package and the existing GameObjects as hosts. Preserve the gameplay code and wire audio to its real events and signals. Export the scene, run the returned install command from the project root, and check playback in Play mode.
```

## 2. Connect the game to the sound

A sound authored at a host follows the GameObject with that name. Use Bind when the names differ. The event, signal, surface and state names below are examples: use the names declared by your scene.

C# · inside your gameplay callbacks

```
using Satie.Core;

SatieCore.Bind("door", door.transform);
SatieCore.Fire("door_open", door.transform.position);
SatieCore.SetHostSurface("player", "gravel");
SatieCore.HostEvent("player", "step");
SatieCore.Signal("engine_load", 0.7f);
SatieCore.State("combat");
```

- Publish continuous controls from the game. A loop following a signal at zero may correctly be silent until that signal changes.
- Set the surface before firing the contact event. Use actual contacts or animation events for footsteps, rather than an unrelated timer.
- Unity panning, or the spatializer selected in Project Settings → Audio, gives positioned voices their direction. Satie handles their distance level, declared room reverb and stated occlusion.

## 3. Mix, save, reload

Open Window → Satie → Mixer during Play mode. Adjust volume, mute and solo, audition events, and test the scene’s signals and states. Save changes, then run the installed command again, or leave watch mode running:

Terminal · Unity project root, after installation

```
npx -y https://www.satie.world/unity/0.1.1/satie-unity.tgz --watch
```

## What stays in your project



- Satie/ holds scene.satie, samples.json and scene.contract.json: the editable scene and its references.
- Assets/Resources/SatieCore holds the compiled scene. Packages/world.satie.unity holds the runtime, native libraries and editor mixer.
- The mixer writes changes to .satie/authoring/edits.jsonl. Watch mode applies them once, recompiles, and reloads a playing editor while keeping its signals and state.

## Platform support

Unity 6000.0 on macOS: package import and scene rendering checked.

Carries declared room reverb and stated occlusion. Per-voice DSP, authored movement paths, entities and geometric wall occlusion are not carried.

Packaged native libraries play synth voices as rendered takes; live synthesis requires the newer native ABI. Review notCarried in each export.

Not yet validated: Windows x64, Linux x64 and Android arm64 libraries are built and symbol-checked; target gameplay still needs testing.

Not yet validated: The package declares Unity 2021.3 as its minimum; older editor versions have not been validated here.

Not supported: iOS, Unity WebGL, Consoles.

[Unity package and verification details](/developers/reference/unity.md)
