Relocating and deleting Resonite directories: Difference between revisions

From Resonite Wiki
Add translation tags / Add suffix in category to categorize in per-language categories. https://meta.wikimedia.org/wiki/Meta:Internationalization_guidelines#Categorization // via Wikitext Extension for VSCode
m Yosh moved page Relocating and deleting Resonite folders to Relocating and deleting Resonite directories: sorry : ( this is more consistent and I only realized after the fact : (
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{:Resonite_Data_Folders}}
<languages/>


<translate>
<translate>
If you have a unique drive setup, or want more control about where these files are stored, then this guide is for you.
<!--T:1-->
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>
<!--T:21-->
One can also delete these directories without relocating them. There are a few reasons why one would want to delete the cache and data directories:
</translate>


The following steps have the '''potential for data loss''' so please be careful.
* <translate><!--T:22--> A general desire to save some space if the cache has gotten unexpectedly large.</translate>
* <translate><!--T:23--> Speeding up the [[local database]], as it will get slow if extremely large.</translate>
* <translate><!--T:24--> To solve some unexpected problem. If this is the reason for deletion, there is most likely an underlying issue that should be looked into instead, but sometimes deleting the database is a last resort potential solution.</translate>


== Preparations ==  
<translate>
== Precautions == <!--T:2-->
</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>
<!--T:3-->
The data and cache paths are intertwined, and the [[local database]] uses absolute paths to reference the cache in places. <strong>Even if you only wish to delete the cache, both directories should be deleted to prevent dead database links</strong>. Deleting the data path will have a few side effects:
</translate>
</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><!--T:4--> 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>Take a note of your settings, in the settings tab. Some of these will reset.</translate>
# <translate><!--T:5--> Your [[Local Home]] will be cleared. Ensure that everything in there that you wish to save is backed up to the cloud.</translate>
# <translate>Make sure you have your username and password to hand, you will be logged out.</translate>
# <translate><!--T:6--> Any local unsynced records will be deleted. If you are having sync issues and do not want to lose potential progress, see the [[sync errors]] page for help on resolving it before continuing.</translate>
# <translate>If you use [[2FA]] for logging in, make sure you have your device handy, you'll need it to login.</translate>
# <translate><!--T:29--> Your [[machine ID]] will be reset</translate>
# <translate><!--T:30--> You will have to do the tutorial again. This can be skipped using the <code>-SkipIntroTutorial</code> [[command line argument]].</translate>


<translate>
<translate>
== Adding command line arguments == <!--T:5-->
== Deleting cache & data paths == <!--T:25-->
</translate>


To relocate these folders to another location:
<translate>
<!--T:26-->
Deleting your cache and data paths is a simple process:
</translate>
</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><!--T:27--> Locate your cache and data paths. Information on how to find them is found on the [[data and cache directories]] page.</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><!--T:28--> Delete the two folders.</translate>
# <translate>Leave these in the command line arguments, permanently or Resonite will go back to using the default locations</translate>


<translate>
<translate>
Entering these command line arguments differs depending on your platform.
== Relocating cache & data paths == <!--T:7-->
</translate>


=== For the Steam build ===
<translate>
<!--T:8-->
[[<tvar name="SteamArgs">File:Steam_launch_options.png|thumb|right</tvar>|An example of custom launch options where the cache path is relocated to <code>D:\Temporary files\ResoniteCache</code>.]]
</translate>
</translate>
{{SteamCommandLineArguments}}
 
<translate>
<translate>
== Examples ==
<!--T:9-->
For the Steam build, the relocation process is as follows:
</translate>
 
# <translate><!--T:10--> Navigate to Resonite in your Steam library</translate>
# <translate><!--T:11--> Click the gear icon to the right underneath the banner, then choose "Properties..."</translate>
# <translate><!--T:12--> In the "Launch options" section, there is a text box for custom launch options.</translate>
#* <translate><!--T:13--> To change the data path, add the text <code>-DataPath C:\Path\To\New\Data\Folder</code></translate>
#* <translate><!--T:14--> To change the cache path, add the text <code>-CachePath C:\Path\To\New\Cache\Folder</code></translate>
#* <translate><!--T:15--> If the path contains a space, it must be surrounded by double quotes, such as <code>-DataPath "D:\Example Path\With Spaces"</code></translate>
#* <translate><!--T:16--> Both options can be specified in the same textbox so long as they are separated by a space.</translate>
# <translate><!--T:17--> Close the window to save changes.</translate>
# <translate><!--T:18--> Delete the old cache and data directories. To find where these directories are, see the [[data and cache directories]] page.</translate>


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>
<!--T:19-->
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.
</translate>
</translate>
<code>-DataPath D:\Resonite\Data -CachePath D:\Resonite\Cache</code>


<translate>
<translate>
== Cleaning Up ==
<!--T:20-->
 
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>
</translate>


[[Category:Troubleshooting{{#translation:}}]]
[[Category:Troubleshooting{{#translation:}}]]

Latest revision as of 17:10, 25 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.

One can also delete these directories without relocating them. There are a few reasons why one would want to delete the cache and data directories:

  • A general desire to save some space if the cache has gotten unexpectedly large.
  • Speeding up the local database, as it will get slow if extremely large.
  • To solve some unexpected problem. If this is the reason for deletion, there is most likely an underlying issue that should be looked into instead, but sometimes deleting the database is a last resort potential solution.

Precautions

The data and cache paths are intertwined, and the local database uses absolute paths to reference the cache in places. Even if you only wish to delete the cache, both directories should be deleted to prevent dead database links. Deleting the data path will have a few side effects:

  1. You will be logged out. Ensure that you know your password and, if applicable, your two-factor authentication device is on hand.
  2. Your Local Home will be cleared. Ensure that everything in there that you wish to save is backed up to the cloud.
  3. Any local unsynced records will be deleted. If you are having sync issues and do not want to lose potential progress, see the sync errors page for help on resolving it before continuing.
  4. Your machine ID will be reset
  5. You will have to do the tutorial again. This can be skipped using the -SkipIntroTutorial command line argument.

Deleting cache & data paths

Deleting your cache and data paths is a simple process:

  1. Locate your cache and data paths. Information on how to find them is found on the data and cache directories page.
  2. Delete the two folders.

Relocating cache & data paths

An example of custom launch options where the cache path is relocated to D:\Temporary files\ResoniteCache.

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

  1. Navigate to Resonite in your Steam library
  2. Click the gear icon to the right underneath the banner, then choose "Properties..."
  3. 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
    • If the path contains a space, it must be surrounded by double quotes, such as -DataPath "D:\Example Path\With Spaces"
    • Both options can be specified in the same textbox so long as they are separated by a space.
  4. Close the window to save changes.
  5. 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.