Relocating and deleting Resonite directories: Difference between revisions

From Resonite Wiki
Removed irrelevant section
 
m Formatting and consistancy tweaks
Line 18: Line 18:
== Adding command line arguments == <!--T:5-->
== Adding command line arguments == <!--T:5-->
To relocate these folders to another location:
To relocate these folders to another location:
# Add either of the following command line flags to Resonite(following the instructions below) to relocate the folders:
# Add either of the following command line flags to Resonite (following the instructions below) to relocate the folders:
#* <code>-DataPath path_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.
#* <code>-DataPath 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.
#* <code>-CachePath 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.
#* <code>-CachePath 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.
# Leave these in the command line arguments, permanently or Resonite will go back to using the default locations
# Leave these in the command line arguments, permanently or Resonite will go back to using the default locations


<!--T:6-->
<!--T:6-->
Entering these command line arguments, differs depending on your platform.  
Entering these command line arguments differs depending on your platform.  


=== For the Steam build === <!--T:7-->
=== For the Steam build === <!--T:7-->

Revision as of 07:07, 1 March 2024

Resonite has two directories outside of the main installation directory which store files and folders that help it run. These directories are the cache path and data path.

Cache path

The cache path contains the Resonite cache, or copies of assets downloaded or generated while Resonite is open. This allows for quick retrieval of previously seen assets without the need to re-download or re-generate them.

Data path

The data path mainly houses the local database, the key used to unlock the local database, and a miscellaneous asset cache.

Location of folders

The location of the cache and data paths on any specific machine can always be found in the first few lines of the Resonite log file:

ℹ️11:23:46 PM.388 (FPS: 0):	AppPath: /home/user/.local/share/Steam/steamapps/common/Resonite
DataPath: /home/user/.local/share/Yellow Dog Man Studios/Data
CachePath: /home/user/.cache/Yellow Dog Man Studios/Cache
LocalePath: /home/user/.local/share/Steam/steamapps/common/Resonite/Locale

Default locations

Cache path

On Windows, the default cache directory is %USERPROFILE%\AppData\Local\Temp\Yellow Dog Man Studios\Resonite. To get to this path easily:

  1. Push Windows Key + R
  2. Enter %USERPROFILE%\AppData\Local\Temp\Yellow Dog Man Studios\Resonite into the Run box that appears
  3. Press Enter or the Ok button

On Linux, the default cache directory is $XDG_CACHE_HOME/Yellow Dog Man Studios/Cache. If XDG_CACHE_HOME is not defined, it will default to $HOME/.cache. If Resonite is launched through Flatpak Steam, then XDG_CACHE_HOME will be $HOME/.var/app/com.valvesoftware.Steam/cache.

Data path

On Windows, the default data directory is %USERPROFILE%\AppData\LocalLow\Yellow Dog Man Studios\Resonite. To get to this path easily:

  1. Push Windows Key + R
  2. Enter %USERPROFILE%\AppData\LocalLow\Yellow Dog Man Studios\Resonite into the Run box that appears
  3. Press Enter or the Ok button

On Linux, the default data directory is $XDG_DATA_HOME/Yellow Dog Man Studios/Data. If XDG_DATA_HOME is not defined, it will default to $HOME/.local/share. If Resonite is launched through Flatpak Steam, then XDG_DATA_HOME will be $HOME/.var/app/com.valvesoftware.Steam/data.

Deletion and relocation

Sometimes, it may be desired or required to relocate or delete these directories. Relocation is done with a command line argument, and deletion is done manually. More information on relocation and deletion can be found on the relocating and deleting Resonite directories page.

See also

  • Log files for another directory used by resonite that can be specified by the user.

If you have a unique drive setup, or want more control about where these files are stored, then this guide is for you.

Relocating these folders

The following steps have the potential for data loss so please be careful.

Preparations

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:

  1. Ensure that your Resonite reports "All Synced" at the top centre of your dash.
  2. If you have anything saved in your Local Home, make sure it is backed up to your cloud home.
  3. Take a note of your settings, in the settings tab. Some of these will reset.
  4. Make sure you have your username and password to hand, you will be logged out.
  5. If you use 2FA for logging in, make sure you have your device handy, you'll need it to login.

Adding command line arguments

To relocate these folders to another location:

  1. Add either of the following command line flags to Resonite (following the instructions below) to relocate the folders:
    • -DataPath Insert_filepath_here - 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.
    • -CachePath Insert_filepath_here - 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.
  2. Leave these in the command line arguments, permanently or Resonite will go back to using the default locations

Entering these command line arguments differs depending on your platform.

For the Steam build

  1. Open Steam
  2. Right click on Resonite in your library
  3. Select "Properties" and then "Set Launch Options".
  4. Enter the command you need to use, exactly as it appears above and Run Resonite.

Setting custom launch options via Steam

Now, if Resonite is launched via Steam, the custom command line arguments will take effect.

Commands entered via this method will not take effect if Resonite is launched any other way, such as directly launching the Resonite.exe.

Cleaning Up

You can delete the old location's folders once the new locations are in use.