Skip to content

docs: streaming saves, memory cards, and new container config keys - #105

Merged
gantoine merged 6 commits into
rommapp:mainfrom
LoneAngelFayt:emulator-streaming-edit
Sep 9, 2026
Merged

docs: streaming saves, memory cards, and new container config keys#105
gantoine merged 6 commits into
rommapp:mainfrom
LoneAngelFayt:emulator-streaming-edit

Conversation

@LoneAngelFayt

Copy link
Copy Markdown
Contributor

Follow-up to #99. The streaming PR (rommapp/romm#3856) added memory card sync, save-state history, and a few new container config keys that the current docs don't cover yet. This fills those gaps.

What changed

docs/using/emulator-streaming.md

  • Corrected the emulator count in the work-in-progress note (three, not four; the fourth integration was dropped).
  • Rewrote the save states section as "Saves and save states": how manual and autosave slots work, how states are copied into the library on exit, the Resume from state panel, and STREAMING_STATE_HISTORY_LIMIT pruning.
  • Added a "Memory cards" section: opt-in memory_card_sync on PS2 and GameCube, the whole-card round trip, and the first-use Import this card / Start fresh prompt.
  • Added a warning that playing on the container directly (outside RomM) does not sync back, since a later RomM session loads the library copy over it.
  • Documented the new container keys in the setup section: memory_card_sync, library_path, emulator.

docs/reference/configuration-file.md

  • Added memory_card_sync, library_path, and emulator rows to the streaming.containers table, with a cross-link to the memory cards section.
  • Added a memory_card_sync line to the ps2 example.

Notes

  • Grounded against the streaming endpoint code (slot counts, card platforms, config keys, env vars) rather than paraphrasing the PR.
  • trunk fmt applied; prose kept in the existing mechanism-first voice.

AI assistance: drafted with the help of an AI coding assistant, then reviewed and verified against the source by me.

@gantoine
gantoine self-requested a review July 24, 2026 15:40
gantoine and others added 4 commits July 31, 2026 14:40
- broker_secret only applies when STREAMING_BROKER_SECRET is unset, the
  env var takes precedence upstream
- states are pulled to the library as they are written, not all at exit
- document the PCSX2 Folder card prerequisite for memory_card_sync
- state history limit is per user, ROM, and emulator, and 0 disables it
- card import stores a new version of the current card when one exists,
  and the default card is the most recently used one
- drop switch from the example slug list, no Switch emulator ships
- note that emulator is lowercased and survives label renames

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@gantoine
gantoine merged commit bd9dd9e into rommapp:main Sep 9, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants