Skip to content

Improve save/load docs and VT slot preview flow #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
han4wluc wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve save/load docs and VT slot preview flow #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions docs/RouteEngine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,9 +406,21 @@ Seen-line semantics:

### Save System Actions

| Action | Payload | Description |
| ----------------- | --------------------------------- | ----------------- |
| `replaceSaveSlot` | `{ slotKey, date, image, state }` | Save game to slot |
| Action | Payload | Description |
| -------------- | --------------------------------- | -------------------------- |
| `saveSaveSlot` | `{ slot, thumbnailImage? }` | Save game to a slot |
| `loadSaveSlot` | `{ slot }` | Load game from a slot |

Save/load design, requirements, and storage boundaries are documented in [SaveLoad.md](./SaveLoad.md).

Notes:

- `slot` is the authoritative action field; storage normalizes it to string `slotKey`
- save/load UIs can bind `slot` directly from layout templates such as `${slot.slotNumber}`
- if slot identity comes from event data, use `_event.*` bindings such as `slot: "_event.slot"`
- example save/load UI copy should stay terse; prefer short labels like `Save`, `Load`, `Page 1`, `Saved`, `Empty`, and `Image`
- `thumbnailImage` is integration-provided; the engine does not capture screenshots by itself
- if a save action appears inside a multi-action event payload, the host should prepare/augment the `actions` object and still call `handleActions(...)` once for the whole batch

### Effect Actions

Expand Down
Loading
Loading