libretro / libretro/RetroArch

Update "Save Main Configuration" sub-label (bypasses custom save directory)

Open Beginner friendly
#19,211 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
14.1k
Forks
2.2k
Avg merge
7h 35m
Merged PRs (30d)
51

Description

Summary

The "Save Main Configuration" is the only menu item under Main Menu → Configuration File that does not save to the Settings → Directory → Configuration files directory.

Steps to Reproduce
  1. Save Initial Configuration: Navigate to Settings → Directory → Configuration files and select Save Main Configuration. This creates a global configuration file in the default directory (e.g., /home/blues/.var/app/org.libretro.RetroArch/config/retroarch/retroarch.cfg for the Flathub build).
Image
  1. Update Path: Change the Configuration File setting within Settings → Directory to a new destination, such as /home/x/Desktop/.
  2. Attempt to Re-save: Navigate back to Settings → Directory → Configuration files and perform the Save Main Configuration action again.
  3. Issue: Observe that the retroarch.cfg file is not created or updated at the specified custom path (/home/x/Desktop/retroarch.cfg).
Proposed Change

Current sub-label:

Save the current configuration as main configuration.

Proposed:

Saves the current configuration as the global settings file in the application's configuration root.

  • Avoids: The alternative phrase ("default settings file") can easily confuse users into thinking it resets everything back to factory installation defaults, rather than saving their current customized state as the primary configuration file.
Why this is needed
  • Prevent Misconfiguration: Users currently have no indication that this action bypasses the directory defined in Settings → Directory → Configuration files. Explicitly stating this behavior prevents users from accidentally losing track of their configuration files.
  • Technical Accuracy: Clearly defining that this saves to the "application's configuration root" provides necessary transparency regarding file system impact.
  • Consistency: Addressing this discrepancy helps maintain a predictable UX, especially for users who expect all configuration-related actions within the Main Menu to respect their custom directory settings.
Optional Improvements for menu consistency

To improve consistency across the menu, the following sub-labels could optionally be updated to explicitly reference the Configuration files directory. These may not strictly need to be updated, as their behavior is generally understood, but including them here provides full clarity regarding the directory structure:

Update Main Menu → Configuration File → Load Configuration

Update:

Load Configuration
Load existing configuration and replace current values.

To:

Load Configuration
Load existing configuration and replace current values from the 'Configuration files' directory.

Update Main Menu → Configuration File → Save Current Configuration

Update:

Save Current Configuration
Overwrite current configuration file.

To:

Save Current Configuration
Overwrite current configuration file to the 'Configuration files' directory.

Update Main Menu → Configuration File → Save New Configuration

Update:

Save New Configuration
Save current configuration to separate file.

To:

Save New Configuration
Saves the current configuration to the 'Configuration files' directory.

Update Main Menu → Configuration File → Save Configuration As

Update:

Save Configuration As
Save current configuration as custom configuration file.

To:

Save Configuration As
Saves the current configuration to the 'Configuration files' directory with a custom filename.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at Main Menu → Configuration File and locate the definitions for the “Save Main Configuration” sub-label and the other configuration actions listed in the issue. Update the primary wording to explain that it saves in the application’s configuration root; consider the optional labels only if their scope is confirmed, and verify that the displayed menu text matches the requested behavior.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.