Difference between revisions of "Controlling the Global User Directory"

From Dolphin Emulator Wiki
Jump to: navigation, search
m (restored something)
(Restoring deleted instructions. Portable.txt especially must not be removed, and operating system instructions should remain as well as it differs significantly between OSes.)
Line 1: Line 1:
 
The '''Global User Directory''' was brought to Windows in {{revision|3.5-2381}} and release {{revision|4.0}}. Now, like Linux and macOS before it, Windows builds have a central location where saves, settings, screenshots, themes, etc are kept. All builds will have the same settings and saves, and updating from one revision to another will be much easier.
 
The '''Global User Directory''' was brought to Windows in {{revision|3.5-2381}} and release {{revision|4.0}}. Now, like Linux and macOS before it, Windows builds have a central location where saves, settings, screenshots, themes, etc are kept. All builds will have the same settings and saves, and updating from one revision to another will be much easier.
  
 +
= Windows =
 
== Moving Saves and Settings from Older Versions ==
 
== Moving Saves and Settings from Older Versions ==
 
Moving saves and settings from an older version of Dolphin to {{revision|4.0}}-era builds is easy. The default location of the Global User Directory is <var>%userprofile%\My Documents\Dolphin Emulator\</var>. To preserve game saves, copy over the <var>\GC\</var> and <var>\Wii\</var> folders which are under the old build's <var>\User\</var> folder to the directory currently specified by Global User Directory. The same can be done for settings by copying over the <var>\Config\</var> folder.
 
Moving saves and settings from an older version of Dolphin to {{revision|4.0}}-era builds is easy. The default location of the Global User Directory is <var>%userprofile%\My Documents\Dolphin Emulator\</var>. To preserve game saves, copy over the <var>\GC\</var> and <var>\Wii\</var> folders which are under the old build's <var>\User\</var> folder to the directory currently specified by Global User Directory. The same can be done for settings by copying over the <var>\Config\</var> folder.
Line 11: Line 12:
 
*Right click the new <var>Dolphin Emulator</var> key, and select <var>New &gt; String Value</var>. Name the value <kbd>UserConfigPath</kbd>.
 
*Right click the new <var>Dolphin Emulator</var> key, and select <var>New &gt; String Value</var>. Name the value <kbd>UserConfigPath</kbd>.
 
*Double click the "UserConfigPath" value and an Edit String dialog appears. Under "Value Data", enter the path to the custom User directory. Make sure that the "User" folder is explicitly specified, since Dolphin will assume whatever path it is directed to is the <var>\User\</var> folder. If it is pointed to Desktop for example, the Desktop will be flooded with folders unnecessarily.
 
*Double click the "UserConfigPath" value and an Edit String dialog appears. Under "Value Data", enter the path to the custom User directory. Make sure that the "User" folder is explicitly specified, since Dolphin will assume whatever path it is directed to is the <var>\User\</var> folder. If it is pointed to Desktop for example, the Desktop will be flooded with folders unnecessarily.
 +
 +
== Disable the Global User Directory for a Specific Build with "portable.txt" ==
 +
To make a build use a local user directory, create a text file named "portable" next to the executable files of the build. With the extension it should be named "portable.txt". Dolphin will check if that file exists in the same directory, then it will not use the global user directory, instead it will create and use the local user directory in the same directory.
  
 
== Local User Directory for Any Build with "LocalUserConfig" registry key ==
 
== Local User Directory for Any Build with "LocalUserConfig" registry key ==
Line 38: Line 42:
  
 
The first key will set all Dolphin builds to use a Local User Directory, whereas the second will remove the Local User config and return to the Global User Directory system.
 
The first key will set all Dolphin builds to use a Local User Directory, whereas the second will remove the Local User config and return to the Global User Directory system.
 +
 +
== Use a Shortcut to Use a Specific User Directory for a Specific Build ==
 +
A shortcut can be customized to tell a specific build to use a specific user directory. This also overrides the portable.txt file.
 +
*Create a shortcut to the Dolphin build you want to use.
 +
*Open the shortcut's properties and edit the target field. After the path to dolphin, add an argument <var>-u</var> (case sensitive) then add the desired path to user folder. As such example:
 +
 +
<pre>Dolphin.exe -u "%userprofile%\Documents\Dolphin Emulator 2"</pre>
 +
 +
Anytime you want that build to use the specified user directory, just run the custom shortcut. If you launch Dolphin without the custom shortcut it will use the Global User Directory or portable.txt, as normal.
 +
 +
= Linux and macOS =
 +
Linux and macOS always use a Global User Directory. One can choose the directory's location with the command:
 +
 +
<pre>/path/to/dolphin/build/dolphin-emu -u /path/to/user/directory</pre>
  
 
[[Category:Tutorials]]
 
[[Category:Tutorials]]

Revision as of 06:53, 26 February 2018

The Global User Directory was brought to Windows in 3.5-2381 and release 4.0. Now, like Linux and macOS before it, Windows builds have a central location where saves, settings, screenshots, themes, etc are kept. All builds will have the same settings and saves, and updating from one revision to another will be much easier.

Windows

Moving Saves and Settings from Older Versions

Moving saves and settings from an older version of Dolphin to 4.0-era builds is easy. The default location of the Global User Directory is %userprofile%\My Documents\Dolphin Emulator\. To preserve game saves, copy over the \GC\ and \Wii\ folders which are under the old build's \User\ folder to the directory currently specified by Global User Directory. The same can be done for settings by copying over the \Config\ folder.

  • It may be more convenient to copy all of the content from the old \User\ folder to the Dolphin Emulator folder, however the \GameConfig\ folder will be ignored.

Choose the Default Location of the Dolphin Profile

  • Open the registry. Simply type "regedit" in the search bar of the Start Menu and hit enter.
  • Expand HKEY_CURRENT_USER.
  • Right click Software and select New > Key. Name the key Dolphin Emulator.
  • Right click the new Dolphin Emulator key, and select New > String Value. Name the value UserConfigPath.
  • Double click the "UserConfigPath" value and an Edit String dialog appears. Under "Value Data", enter the path to the custom User directory. Make sure that the "User" folder is explicitly specified, since Dolphin will assume whatever path it is directed to is the \User\ folder. If it is pointed to Desktop for example, the Desktop will be flooded with folders unnecessarily.

Disable the Global User Directory for a Specific Build with "portable.txt"

To make a build use a local user directory, create a text file named "portable" next to the executable files of the build. With the extension it should be named "portable.txt". Dolphin will check if that file exists in the same directory, then it will not use the global user directory, instead it will create and use the local user directory in the same directory.

Local User Directory for Any Build with "LocalUserConfig" registry key

The Global User Directory system can be disabled entirely with a registry key. The key is global, so it is a "once and for all" change.

When done editing the Windows Registry, and before launching Dolphin, be sure to move the \User\ folder along with Dolphin executable files (or check if it's placed correctly). Otherwise, Dolphin will create a new one instead.

Manual Registry Editing

  • Open the registry. Simply type "regedit" in the search bar of the Start Menu and hit enter.
  • Expand HKEY_CURRENT_USER.
  • Right click Software and select New > Key. Name the key Dolphin Emulator.
  • Right click the new Dolphin Emulator key, and select New > String Value. Name the value LocalUserConfig.
  • Double click the "LocalUserConfig" value and an Edit String dialog appears. Under "Value Data", type the number 1.

Automatic Process with .REG Files

These registry keys can be created and removed with .reg files to make the process easier.

To create the LocalUserConfig registry key, open notepad, paste the following in it and save it as a .reg file:

Windows Registry Editor Version 5.00
[HKEY_CURRENT_USER\Software\Dolphin Emulator]
"LocalUserConfig"="1"

To remove the LocalUserConfig registry key and revert back to the Global User Directory system, open notepad, paste the following in it and save it as a .reg file:

Windows Registry Editor Version 5.00
[HKEY_CURRENT_USER\Software\Dolphin Emulator]
"LocalUserConfig"=-

The first key will set all Dolphin builds to use a Local User Directory, whereas the second will remove the Local User config and return to the Global User Directory system.

Use a Shortcut to Use a Specific User Directory for a Specific Build

A shortcut can be customized to tell a specific build to use a specific user directory. This also overrides the portable.txt file.

  • Create a shortcut to the Dolphin build you want to use.
  • Open the shortcut's properties and edit the target field. After the path to dolphin, add an argument -u (case sensitive) then add the desired path to user folder. As such example:
Dolphin.exe -u "%userprofile%\Documents\Dolphin Emulator 2"

Anytime you want that build to use the specified user directory, just run the custom shortcut. If you launch Dolphin without the custom shortcut it will use the Global User Directory or portable.txt, as normal.

Linux and macOS

Linux and macOS always use a Global User Directory. One can choose the directory's location with the command:

/path/to/dolphin/build/dolphin-emu -u /path/to/user/directory