Requirements
The Unity version, the one required package, what is optional, and which platforms the sync tool has actually been run on.
All documentation — Start here
Start here
Concepts
Authoring for a game
Playing a story
The generated code
The plugin and sync
Unity
Unity 2021.3 or newer. That is the floor the package declares, and it is also the language ceiling:
the plugin is compiled at C# 9 against netstandard2.1, which is Unity’s own limit rather than a
preference of ours. Generated code is emitted at the same level, so it compiles in any project that
meets the floor.
Required packages
Newtonsoft Json (com.unity.nuget.newtonsoft-json). The payload reader and the save codec both
use it. It is the plugin’s only package dependency.
Optional packages
Addressables. If the package is present, the plugin can load media through it, and the sync can
mark synced media assets addressable for you. Without it, media loads from a Resources folder
instead. Neither route is required to get a story playing — a project with no media at all needs
neither.
Platforms
The sync tool is a native binary that runs in the editor, not in your game, so this constrains the machine a developer syncs from — not the platforms a built game ships to.
Windows is the supported platform. The tool builds for macOS and Linux as well, and neither has
ever been run: no sync has been performed on either, and no --version call either. Treat those two
as unsupported until that changes, rather than as “probably fine”.
Nothing about the runtime is platform-specific. The engine, the expression evaluator and the save codec are portable C# with no native code, and they are exercised headlessly on every build.
What is not here yet
This site has no install page yet. The route itself exists and is written down — the package is
added by Git URL through Unity’s Package Manager, and the sync tool is a release asset — but it
lives in the package’s own README.md and in the Unity integration guide rather than here. A page
that walks it belongs in this section and is the next thing to land.