Agents
The SDK
The Unity package your game code uses with Satura Space, how the app installs it, and how to add it by hand.
The SDK is the public Unity package that Satura Space adds to your project for your game code. The app installs and updates it for you, so you normally don't touch it directly.
What it holds
| API | For |
|---|---|
[SaturaHandle] | Marking the methods agents call. See Handles and reports. |
SaturaLog | Tagged log files that agents read back. |
Inp | Input snapshots. |
SaturaStaging | Staging prefabs and their scenarios. See Staging prefabs. |
It compiles in any Unity 6 project, with or without the app.
Installed by the app
When the app opens a project, it adds one line to Packages/manifest.json. That line points Unity at the SDK in the Satura Space repository, at the git tag of the app's version. It's the one change Satura Space makes that stays in your git history. See What changes in your project.
Add it by hand
To add the SDK yourself, use the git URL with the tag of your app version:
https://github.com/saturadev/satura-space.git?path=/packages/saturaspace-sdk#vX.Y.ZFor example, for version 3.0.0:
https://github.com/saturadev/satura-space.git?path=/packages/saturaspace-sdk#v3.0.0Versioning
The app, the engine and the SDK carry the same version and are bumped together when a release is cut. Keep the SDK tag in your manifest the same as your app version. The SDK's release notes are in the changelog.
In shipped players
SaturaLog stays out of shipped players: a built player writes log files only when Satura Space launched it (SaturaLaunch.Managed, SaturaLog.Enabled). A log file that reaches 64 MB is cleared and starts over.
Source and license
The SDK lives in the Satura Space repository at packages/saturaspace-sdk and is licensed under Apache-2.0, the same as the app and the engine.