update details about the user directory

OatmealDome 2024-07-11 15:20:26 -04:00
parent 23a7b4e5ce
commit 6d32319eef
1 changed files with 7 additions and 9 deletions

@ -36,16 +36,12 @@ rules folder.
## User Folder Structure ## User Folder Structure
A number of user writeable directories are created for caching purposes or for A number of user writeable directories are created for caching purposes or for allowing the user to edit their contents. The current user folder can be opened by going to "File" -> "Open User Folder".
allowing the user to edit their contents. On macOS and Linux these folders are
stored in `~/Library/Application Support/Dolphin/` and `~/.dolphin-emu` On macOS and Linux, these folders are stored in `~/Library/Application Support/Dolphin/` and `~/.dolphin-emu` respectively, but can be overridden by setting the environment variable `DOLPHIN_EMU_USERPATH`.
respectively, but can be overwritten by setting the environment variable
`DOLPHIN_EMU_USERPATH`. On Windows the user directory is stored in the `My Documents` On Windows, the user directory is stored in the roaming `AppData` folder by default. Prior to [#10708](https://github.com/dolphin-emu/dolphin/pull/10708), the user directory was stored in the `My Documents` folder. If a user directory exists at the old location, Dolphin will continue to use it to preserve backwards compatibility. The user directory can also be overridden via registry keys:
folder by default, but there are various way to override this behavior:
* Creating a file called `portable.txt` next to the Dolphin executable will
store the user directory in a local directory called "User" next to the
Dolphin executable.
* If the registry string value `LocalUserConfig` exists in * If the registry string value `LocalUserConfig` exists in
`HKEY_CURRENT_USER/Software/Dolphin Emulator` and has the value **1**, `HKEY_CURRENT_USER/Software/Dolphin Emulator` and has the value **1**,
Dolphin will always start in portable mode. Dolphin will always start in portable mode.
@ -54,6 +50,8 @@ folder by default, but there are various way to override this behavior:
stored in the directory given by that string. The other two methods will be stored in the directory given by that string. The other two methods will be
prioritized over this setting. prioritized over this setting.
On Windows and macOS, creating a file called `portable.txt` next to the Dolphin executable / app will force Dolphin to run in portable mode. While in portable mode, the user directory will be stored in a local directory called `User` next to the Dolphin executable / app.
List of user folders: List of user folders:
* `Cache`: used to cache the ISO list * `Cache`: used to cache the ISO list