docs: document save slots and auto-sync being on by default - #144
Merged
Merged
Conversation
`emulatorjs.auto_save_sync` defaults to true since 5.3.0, and the player now polls the emulator's save memory rather than waiting for save-and-quit, so the opt-in framing was backwards. Save slots and the in-emulator "Load save or state" picker were undocumented. Bumps the pinned romm ref to 5.3.0-beta.1 so the generated env-var table picks up MAX_SAVES_PER_SLOT. The other generated snippets are unchanged. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The saves documentation described
emulatorjs.auto_save_syncas an opt-in that uploads on save-and-quit unless you turn it on. Since 5.3.0 it defaults totrue(config_manager.py) and the player polls the emulator's save memory every second, so a save reaches the server seconds after the game writes it. Following that thread, two more things shipped with no docs at all.docs/using/saves-and-states.mdautosavevs named slots, version history and theLatesttag, andMAX_SAVES_PER_SLOTretention.docs/reference/configuration-file.md:emulatorjs.auto_save_syncdefault corrected totrue, with the sample showing the opt-out.scripts/sources.toml: pinned romm ref bumped from839605eto5.3.0-beta.1so the generated env-var table picks upMAX_SAVES_PER_SLOT.Source
Behaviour verified against
5.3.0-beta.1rather than PR descriptions:truebackend/config/config_manager.py:762frontend/src/views/Player/EmulatorJS/utils.ts:378(SAVE_SYNC_POLL_MS)Player.vue,flushPendingSaveononBeforeRouteLeavefrontend/src/services/pending-asset.tsbackend/endpoints/saves.py:128-133,:369-371Player.vue:344-351Relevant PRs: rommapp/romm#4378, rommapp/romm#4517, rommapp/romm#4540, rommapp/romm#4558, rommapp/romm#4600, rommapp/romm#4615
Generated snippets
Re-ran all four generators after the ref bump. Only
env-vars.mdchanged, and only by two rows:MAX_SAVES_PER_SLOTadded, andWEB_SERVER_KEEPALIVEpicking up its new65default.platform-aliases.md,scheduled-tasks.mdandsupported-platforms.mdcame back byte-identical.Testing
uv run mkdocs buildis clean, no link or anchor warnings.--strictaborts locally on an unrelated missinglibcairofor social-card rendering, which is an environment issue rather than anything in this change.trunk checkpasses on the edited files.AI assistance
Written with Claude Code. The prose is model-written; every behavioural claim was checked against the code in the table above by the model, and the whole diff was reviewed by me before opening.
🤖 Generated with Claude Code