Relocate Resonite Folders: Difference between revisions

From Resonite Wiki
m Formatting and consistancy tweaks
Spell check, added links.
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<!--T:1-->
 
{{:Resonite_Data_Folders}}
{{:Resonite_Data_Folders}}


<!--T:2-->
If you have a unique drive setup, or want more control about where these files are stored, then this guide is for you.
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 = <!--T:3-->
= Relocating these folders =
The following steps have the '''potential for data loss''' so please be careful.
The following steps have the '''potential for data loss''' so please be careful.


== Preparations == <!--T:4-->
== 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''':
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''':
# Ensure that your Resonite reports "All Synced" at the top centre of your dash.  
# Ensure that your [[Resonite]] reports "All Synced" at the top center of your [[Dash|dash]].  
# If you have anything saved in your '''Local Home''', make sure it is backed up to your cloud home.
# If you have anything saved in your '''[[Local Home]]''', make sure it is backed up to your cloud home.
# Take a note of your settings, in the settings tab. Some of these will reset.
# Take a note of your settings, in the settings tab. Some of these will reset.
# Make sure you have your username and password to hand, you will be logged out.
# Make sure you have your username and password to hand, you will be logged out.
Line 18: Line 17:
== 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 Arguments|command line flags]] to Resonite (following the instructions below) to relocate the folders:
#* <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>-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.
#* <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> 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.
# 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


Line 29: Line 28:
{{SteamCommandLineArguments}}
{{SteamCommandLineArguments}}


== Cleaning Up == <!--T:9-->
== <translate>Examples</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!
 
<code>-DataPath D:\Resonite\Data -CachePath D:\Resonite\Cache</code>
== Cleaning Up ==
You can delete the old location's folders once the new locations are in use.
You can delete the old location's folders once the new locations are in use.


<!--T:10-->
<!--T:10-->
[[Category:Troubleshooting]]
[[Category:Troubleshooting]]

Latest revision as of 08:46, 29 May 2024

Resonite has two locations, outside of the main installation directory which store files and folders that help Resonite run:

  1. Cache - Store's temporary copies of assets and other items that are downloaded or generated while you are using Resonite.
  2. Database/Data - Stores a local copy of your items and things that you are working on, your login status and settings.

Folder Default Locations

Cache

By default the cache can be found in: %USERPROFILE%\AppData\Local\Temp\Yellow Dog Man Studios\Resonite

To get there easily:

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

Database/Data

By default the data folder can be found in: %USERPROFILE%\AppData\LocalLow\Yellow Dog Man Studios\

To get there easily:

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

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 center 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 or -data 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 or -cache 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.

Examples

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!

-DataPath D:\Resonite\Data -CachePath D:\Resonite\Cache

Cleaning Up

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