Relocating and deleting Resonite directories: Difference between revisions

Revision as of 19:49, 23 August 2025

It is possible to relocate the data and cache directories to directories outside of their default location. This may be done for organizational purposes or for saving space on one filesystem by relocating them to a different filesystem.

Precautions

The data and cache paths are intertwined, and the local database uses absolute paths to reference the cache in places. As such, to avoid conflict and potential database bloat, this process involves deleting both the data and cache directories. They will not be moved to the new location. This will have the following side effects:

You will be logged out. Ensure that you know your password and, if applicable, your two-factor authentication device is on hand.
Your Local Home will be cleared. Ensure that everything in there that you wish to save is backed up to the cloud.
Any local unsynced records will be deleted. If you are having sync issues and do not want to lose potential progress, see the sync conflict page for help on resolving it before continuing.

Relocating

For the Steam build, the relocation process is as follows:

Navigate to Resonite in your Steam library
Click the gear icon to the right underneath the banner, then choose "Properties..."
In the "Launch options" section, there is a text box for custom launch options.

- To change the data path, add the text -DataPath C:\Path\To\New\Data\Folder
- To change the cache path, add the text -CachePath C:\Path\To\New\Cache\Folder
- Both options can be specified at the same timeTemplate:Emone after anotherTemplate:Emso long as they are separated by a space.

Close the window to save changes.
Delete the old cache and data directories. To find where these directories are, see the data and cache directories page.

If launching Resonite outside of Steam, then these options are appended to the command line of the Resonite.exe executable that you run.

These arguments must be present at all times or else Resonite will revert back to the default directories.

@@ Line 1: / Line 1: @@
-{{:Resonite_Data_Folders}}
+<languages/>
 <translate>
-If you have a unique drive setup, or want more control about where these files are stored, then this guide is for you.
+It is possible to relocate the [[data and cache directories]] to directories outside of their default location. This may be done for organizational purposes or for saving space on one filesystem by relocating them to a different filesystem.
+</translate>
-= Relocating these folders =
+<translate>
+== Precautions ==
+</translate>
-The following steps have the '''potential for data loss''' so please be careful.
+<translate>
+The data and cache paths are intertwined, and the [[local database]] uses absolute paths to reference the cache in places. As such, to avoid conflict and potential database bloat, this process involves deleting both the data and cache directories. They will not be moved to the new location. This will have the following side effects:
+</translate>
-== Preparations ==
+# <translate>You will be logged out. Ensure that you know your password and, if applicable, your [[2FA|two-factor authentication]] device is on hand.</translate>
+# <translate>Your [[Local Home]] will be cleared. Ensure that everything in there that you wish to save is backed up to the cloud.</translate>
+# <translate>Any local unsynced records will be deleted. If you are having sync issues and do not want to lose potential progress, see the [[sync conflict]] page for help on resolving it before continuing.</translate>
-As these folders refer to each other in some places, it is best to start fresh with '''no existing contents''' when relocating these folders. This will result in a smoother experience but '''will result in some data loss unless these preparations are followed''':
+<translate>
+== Relocating ==
 </translate>
-# <translate>Ensure that your [[Resonite]] reports "All Synced" at the top center of your [[Dash|dash]].</translate>
-# <translate>If you have anything saved in your '''[[Local Home]]''', make sure it is backed up to your cloud home.</translate>
-# <translate>Take a note of your settings, in the settings tab. Some of these will reset.</translate>
-# <translate>Make sure you have your username and password to hand, you will be logged out.</translate>
-# <translate>If you use [[2FA]] for logging in, make sure you have your device handy, you'll need it to login.</translate>
 <translate>
-== Adding command line arguments == <!--T:5-->
+[[<tvar name="SteamArgs">File:Steam_launch_options.png|thumb|right</tvar>|An example of custom launch options where the data path is relocated to <code>D:\Temporary files\ResoniteCache</code>.]]
+</translate>
-To relocate these folders to another location:
+<translate>
+For the Steam build, the relocation process is as follows:
 </translate>
-# <translate>Add either of the following [[Command Line Arguments|command line flags]] to Resonite (following the instructions below) to relocate the folders:</translate>
-#* <translate><code>-DataPath Insert_filepath_here</code> or <code>-data Insert_filepath_here</code> - Instructs Resonite to use the location you specify for the '''Data''' folder. Any absolute path syntax supported by the underlying platform's file system libraries can be used here, such as DOS-style or UNC paths.</translate>
-#* <translate><code>-CachePath Insert_filepath_here</code> or <code>-cache Insert_filepath_here</code> - Instructs Resonite to use the location you specify for the '''Cache''' folder. Any absolute path syntax supported by the underlying platform's file system libraries can be used here, such as DOS-style or UNC paths.</translate>
-# <translate>Leave these in the command line arguments, permanently or Resonite will go back to using the default locations</translate>
-<translate>
+# <translate>Navigate to Resonite in your Steam library</translate>
-Entering these command line arguments differs depending on your platform.
+# <translate>Click the gear icon to the right underneath the banner, then choose "Properties..."</translate>
+# <translate>In the "Launch options" section, there is a text box for custom launch options.</translate>
+** <translate>To change the data path, add the text <code>-DataPath C:\Path\To\New\Data\Folder</code></translate>
+** <translate>To change the cache path, add the text <code>-CachePath C:\Path\To\New\Cache\Folder</code></translate>
+** <translate>Both options can be specified at the same time{{em}}one after another{{em}}so long as they are separated by a space.</translate>
+# <translate>Close the window to save changes.</translate>
+# <translate>Delete the old cache and data directories. To find where these directories are, see the [[data and cache directories]] page.</translate>
-=== For the Steam build ===
-</translate>
-{{SteamCommandLineArguments}}
 <translate>
-== Examples ==
+If launching Resonite outside of Steam, then these options are appended to the command line of the <code>Resonite.exe</code> executable that you run.
-For brevity, here's the complete set of arguments needed to move the folders to a new location. You can paste these into the locations mentioned above for easy editing!
 </translate>
-<code>-DataPath D:\Resonite\Data -CachePath D:\Resonite\Cache</code>
 <translate>
-== Cleaning Up ==
+These arguments must be present at all times or else Resonite will revert back to the default directories.
-You can delete the old location's folders once the new locations are in use.
 </translate>
 [[Category:Troubleshooting{{#translation:}}]]