Controlling the Global User Directory: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
mNo edit summary
(Modernizing and adding in the portable.txt on linux information that passed us by! Removing the instructions for moving saves from old versions (important then but irrelevant now), and shortcut instructions (portable.txt was always better))
(36 intermediate revisions by 6 users not shown)
Line 1: Line 1:
= Windows =
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.
== Moving Saves from Older Versions ==
Moving saves from an older version of Dolphin to the {{revision|4.0}}-era builds is easy. The default location of the Global User Directory is <tt>C:/[your username]/My Documents/Dolphin Emulator</tt>. Just copy over the <tt>GC</tt> and <tt>Wii</tt> folders from your old builds User directory to the Global User Directory. You can even copy all of the content from your old User folder if you like, though the GameConfig folder will be ignored.


== Choose the Location of the Global User Directory ==
== Choose the Location of the Global User Directory ==
*Open the registry. Type "regedit" in the search bar of the Start Menu and hit enter.
===Windows===
*Expand <tt>HKEY_CURRENT_USER</tt>
*Open the registry. Simply type "regedit" in the search bar of the Start Menu and hit enter.
*Right click <tt>Software</tt> and select <tt>New > Key</tt>. Name the key "Dolphin Emulator"
*Expand <var>HKEY_CURRENT_USER</var>.
*Right click the new <tt>Dolphin Emulator</tt> key, and select <tt>New > String Value</tt>. Name the value "UserConfigPath"
*Right click <var>Software</var> and select <var>New &gt; Key</var>. Name the key <kbd>Dolphin Emulator</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 you include "User" in it, since it will assume whatever path it is directed to is the User folder. If you point it to the Desktop for example, you will have a very messy situation.
*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.


== Use a Shortcut to Use a Specific User Directory for a Specific Build ==
=== Linux and macOS ===
You can use a shortcut to tell a specific build to use a specific user directory.
On Linux and macOS, the Global User Directory's location can be changed with the command:
*Create a shortcut to the Dolphin build you want to use, say on the desktop
*Edit the target field. After the path to dolphin, add <tt>-U [Path to user folder]</tt>. When complete, the target field should look something like the following:


<pre>X:\Path\To\Dolphin\Build\Dolphin.exe -U X:\Path\To\User</pre>
<pre>/path/to/dolphin/build/dolphin-emu -u /path/to/user/directory</pre>


Anytime you want that build to use the specified user directory, just run the shortcut. If you run the EXE directly it will use the Global User Directory.
== 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.


== Restore the Old Behavior with "LocalUserConfig" registry key ==
This will work on Windows and Linux (as of {{revision|5.0-148}}). macOS and Android are not supported for this method.
If you just want nothing to do with this whole Global User Directory thing and want Dolphin to use an individual User directory in the same place as the EXE as it used to, then you can disable the Global User Directory system entirely with a registry key.
*Open the registry. Type "regedit" in the search bar of the Start Menu and hit enter.
*Expand <tt>HKEY_CURRENT_USER</tt>
*Right click <tt>Software</tt> and select <tt>New > Key</tt>. Name the key "Dolphin Emulator"
*Right click the new <tt>Dolphin Emulator</tt> key, and select <tt>New > String Value</tt>. Name the value "LocalUserConfig"
*Double click the "LocalUserConfig" value and an Edit String dialog appears. Under "Value Data", type the number <tt>1</tt>.
From now on, when you run a new Dolphin build it will create a User folder next to the EXE, just like it used to.


=== .reg Files ===
== Use Local User Directories on Windows ==
You can use .reg files to jump back and forth between Local User Directories and a Global User Directory. This is very handy for testing specific save files without messing with your personal saves in your Global User Directory.
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.


To create the LocalUserConfig registry key, open up notepad, paste the following in it and save it as a .reg file:
When done editing the Windows Registry, and before launching Dolphin, be sure to move the <var>\User\</var> folder along with Dolphin executable files (or check if it's placed correctly). Otherwise, Dolphin will create a new one instead.
<pre>[HKEY_CURRENT_USER\Software\Dolphin Emulator]
 
=== Manual Registry Editing ===
*Open the registry. Simply type "regedit" in the search bar of the Start Menu and hit enter.
*Expand <var>HKEY_CURRENT_USER</var>.
*Right click <var>Software</var> and select <var>New > Key</var>. Name the key <kbd>Dolphin Emulator</kbd>.
*Right click the new <var>Dolphin Emulator</var> key, and select <var>New > String Value</var>. Name the value <kbd>LocalUserConfig</kbd>.
*Double click the "LocalUserConfig" value and an Edit String dialog appears. Under "Value Data", type the number <var>1</var>.
 
=== 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:
<pre>Windows Registry Editor Version 5.00
[HKEY_CURRENT_USER\Software\Dolphin Emulator]
"LocalUserConfig"="1"</pre>
"LocalUserConfig"="1"</pre>


To remove the LocalUserConfig registry key and revert back to the Global User Config system, open up notepad, paste the following in it and save it as a .reg file:
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:
<pre>[HKEY_CURRENT_USER\Software\Dolphin Emulator]
<pre>Windows Registry Editor Version 5.00
[HKEY_CURRENT_USER\Software\Dolphin Emulator]
"LocalUserConfig"=-</pre>
"LocalUserConfig"=-</pre>


Simply run the first key when you want to use a Local User Directory and run the second key to 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.
 
= Linux and OSX =
Linux and OSX have always used a Global User Directory. With the Global User Directory changes in {{revision|4.0}} one can choose a custom directory with the command:
<pre>/path/to/dolphin/build/dolphin-emu -U /path/to/user/directory</pre>


[[Category:Tutorials]]
[[Category:Tutorials]]

Revision as of 07:17, 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.

Choose the Location of the Global User Directory

Windows

  • 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.

Linux and macOS

On Linux and macOS, the Global User Directory's location can be changed with the command:

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

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.

This will work on Windows and Linux (as of 5.0-148). macOS and Android are not supported for this method.

Use Local User Directories on Windows

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.