gbe_fork/tools/migrate_gse/README.md
otavepto 0e694f1e86 * write dlc to [app:dlcs] inside .ini
* fix a mistake when mixing output from generate_emu_config tool
* ensure output from generate_emu_config tool is written as soon as possible in case another stage threw an exception
* fix a bug when writing .ini, ensure everything is a string
* new readme for the migration tool
2024-04-20 17:30:04 +02:00

2.4 KiB

Save & Settings folder migration tool

This tool allows you to migrate your steam_settings folder, or your global settings folder from the old format, to the new .ini oriented format.

Where is the global settings folder?

On Windows this folder is located at %appdata%\Goldberg SteamEmu Saves\settings\
On Linux this folder is located at:

  • if env var XDG_DATA_HOME is defined:
    $XDG_DATA_HOME/Goldberg SteamEmu Saves/settings/
  • Otherwise, if env var HOME is defined:
    $HOME/.local/share/Goldberg SteamEmu Saves/settings/

How to migrate the global settings folder

Simply open the terminal/cmd in the folder of the tool and run it without any arguments.

  • On Windows:
    migrate_gse.exe
    
  • On Linux:
    chmod 777 migrate_gse
    ./migrate_gse
    

The tool will generate a new folder in the current directory called steam_settings, copy the content inside this folder (a bunch of .ini files) and paste them here:

  • On Windows: %appdata%\GSE Saves\settings\
  • On Linux:
    • if env var XDG_DATA_HOME is defined:
      $XDG_DATA_HOME/GSE Saves/settings/
    • Otherwise, if env var HOME is defined:
      $HOME/.local/share/GSE Saves/settings/

Notice the new name of the global saves folder GSE Saves, not to be confused with the old one Goldberg SteamEmu Saves

How to migrate a local steam_settings folder you already have

Open the terminal/cmd in the folder of the tool and run it with only one argument, which is the path to the target steam_settings folder.

  • On Windows:
    migrate_gse.exe "D:\my games\some game\steam_settings"
    
  • On Linux (notice how the tilde character is outside the quotes to allow it to expand):
    chmod 777 migrate_gse
    ./migrate_gse ~/"some game/steam_settings"
    

The tool will generate a new folder in the current directory called steam_settings, copy the content inside this folder (a bunch of .ini files) and paste them inside the target/old steam_settings folder

General notes

  • In all cases, the tool will not copy the achievements images, overlay fonts/sounds, and all the extra stuff, it will just generate the corresponding .ini files

  • Some configuration files are still using the same old format, that includes all the .json files, depots.txt, subscribed_groups_xxx.txt, etc...
    So don't just remove everything from the old steam_settings folder