Reference
The reference pages answer "what are the exact rules?" They give each field's type, default value, allowed options and error messages. If a tutorial and these pages disagree, go with these pages.
The tutorials are in the earlier chapters: Create a world, Develop plugins, and Validate and distribute.
Worlds
| Page | Contents |
|---|---|
| World manifest field table | All fields of world.yaml |
| World data | Import rules for data files, content that can be seeded in advance, hidden data |
| World model | Data structures for characters, character attributes and the lorebook |
| Dynamic dimensions | World state that changes during play |
| World time | Calendars, phases, and time advancement |
| World package installation | Install, update and uninstall |
Plugins
| Page | Contents |
|---|---|
| Plugin contract | The fields of PLUGIN.md and RUNTIME.md, and an overview of the built-in plugins |
| Plugin manifest field table | All fields of the root manifest |
| Runtime manifest field table | All fields of a runtime unit |
| Tools | Built-in tools, proposal types, approval policy |
| Hooks | Lifecycle events, payloads, and what a handler can return |
| Extension points | Extension points the kernel opens up |
| Plugin extensions and communication | Services, events, and passing results between plugins |
| Prompt structure | Which sections make up one model request |
| Plugin catalogue and installation | Install, update, uninstall and trust |
Interface
| Page | Contents |
|---|---|
| Panels | Tabs and data sources of the right-side panels |
| Interface components | Components available to declarative interfaces |
| Theme packages | The format of theme packages |
| i18n | Multilingual rules for the interface, plugins and worlds |
Models and Media
| Page | Contents |
|---|---|
| Model roles | Roles, providers, protocols and fallback rules |
| Evaluation models | Models used for judging and classifying |
| Image generation | How image generation is connected |
| Media store | How images and audio are saved and referenced |
API and Storage
| Page | Contents |
|---|---|
| HTTP API | All endpoints of the backend |
| SSE protocol | Events pushed to the interface while a turn is running |
| Transactions | How the writes of a turn are committed |
| Settings store | The save format of interface settings, and conflict handling |
| Environment variables | All environment variables |
| Desktop configuration | The desktop app's configuration files and data folder |
| Glossary | The definition of each term used in the docs |