docs: explain how RetroArch settings are stored and saved - #7
Open
Helaas wants to merge 4 commits into
Open
Conversation
Leaf#48 reported settings not persisting and pointed at the per-launch retroarch-current-<pid>.cfg file, which is working as designed. Nothing documented the durable config, the working copy, when changes are written, or the settings Leaf deliberately owns on every launch. Adds a RetroArch settings page covering all of that, plus the removed Configuration File menu and what Reset RetroArch Config erases, and links it from playing, settings, and troubleshooting.
Review of #7 caught four places the page claimed more than the code does: - aspect ratio was the example of a setting shared across systems, but Leaf owns the aspect-ratio keys; use rewind, which really is shared - Power off and Restart only wait for a clean save on the app tile; a running game is stopped quickly and can lose settings changed that session - the on-screen save-failure error is app-tile only - Reset RetroArch Config replaces retroarch.cfg; per-core options and input remaps live in separate files and survive it
The page warned that a running game is stopped quickly, then reassured the reader that save data was unaffected. It is not: autosave_interval is "0", so RetroArch writes a game's save data when the game closes, and a game killed before it closes may not have written it. Drop the assurance and point at Save & Quit, which is the actual advice.
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
1 participant
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.
User-facing half of Leaf#48.
The reporter pointed at
retroarch-current-<pid>.cfgand concluded settings were not persisting. That file is a per-launch working copy, and a new number on every launch is expected. The durable configuration, save timing, and Leaf-owned settings were not documented, so normal behavior looked like a bug.Adds
guide/retroarch-settings.mdcovering:.umrk/mlp1/retroarch/retroarch.cfgand the per-launch working copy;The guide is linked from Playing games, Settings reference, Shaders, and Troubleshooting.
Depends on Jawaka#95 for the Configuration File menu being hidden. Hold this PR until that ships.
npm run buildpasses; the page renders at/guide/retroarch-settings/.