Inkweaver SDK
The Inkweaver SDK is the library your scripts and plugins use to work with Inkweaver. Import what you need from @inkweaverdev/inkweaver-sdk:
import { getState, onChange } from "@inkweaverdev/inkweaver-sdk";What’s in the SDK
Section titled “What’s in the SDK”| Page | What it covers |
|---|---|
| State and settings | Reading and changing state and settings, and setting their starting values |
| Events | Responding to state changes and screenplay labels |
| Commands and selectors | Calling and decorating commands and selectors |
| Navigation and bookmarks | Stepping through history, and saving and loading bookmarks |
| Assets and files | Finding built assets, and reading and writing files |
| View state and drawing | Beats, view state, and what a draw sends to the screen |
| Menu schema | The shape of a menu and its fields |
| Utilities | Stores, state guards, and the call stack mixin |
| Advanced | Low-level functions for committing state and processing screenplay content |