Retrosync is a Python script to sync Retroarch playlists and ROMs from your desktop computer to your Steam Deck or iOS based devices.
- Synchronize via SSH RetroArch playlists, favorites from Desktop to Steam Deck
- Synchronize via SSH ROMs, Bios files and thumbnail
- Synchronize RetroArch playlists, favorites from Desktop to local folder
- Synchronize ROMs, Bios files and thumbnail to local folder
- Due to to missing SSH support on iOS device prepared files need to be synced with the Finder, iCloud Sync or 3rd party solutions like LocalSend
- Update and recreate local playlists by scanning local folders
- Create local m3u files using detection and normalizing regular expressions
- Support for XML DAT archives
- Configure your local and remote cores according to each system
Retrosync functions with macOS, Linux, and Windows, relying on previously installed tools such as Secure Shell (SSH) and Rsync, or utilizing pure Python Secure Shell implementations. This means that you need to enable SSH on your Steam Deck if you have not done so already; you can follow this guide for instructions.
The primary distinction between the two target device groups lies in the fact that the Steam Deck can be synchronized directly via the SSH protocol, while iOS devices require the use of Finder or iCloud Sync for data transfer. Consequently, all RetroArch-related files are prepared locally, with paths and configurations altered to suit the target system, but stored within a local folder intended for later transfer to the designated devices. This local sync feature offers an optimal solution for syncing onto SD cards or external disks, facilitating the transfer of larger collections to the Steam Deck without incurring slower network traffic.
Install the dependencies using the included Makefile, that utilize UV to install the dependencies into a virtualenv.
make installBy default, the steamdeck.toml configuration file is employed. You can alter the configuration file by utilizing the command switch --config-file to specify an alternate filename.
In this sample configuration, a setup is provided for your local desktop's Retroarch-related files and your local ROM locations, as well as for the remote side on your Steam Deck. The appearance of these details may vary slightly on your Steam Deck, depending on how you installed Retroarch. For instance, in this scenario, Retroarch was installed through Emudeck (https://www.emudeck.com/) using Flatpak (https://flatpak.org/)).
[default]
# Explain the method for copying data, whether it's local or remote.
target = "remote"
hostname = "192.168.1.100"
username = "deck"
password = "<password>"
src_playlists = "~/Library/Application Support/RetroArch/playlists"
src_bios = "~/Library/Application Support/RetroArch/system"
src_config = "~/Library/Application Support/RetroArch/config/"
src_roms = "~/Documents/Roms"
src_roms_alt = "~/Library/CloudStorage/Dropbox/Software/Roms"
src_cores = "~/Library/Application Support/RetroArch/cores"
src_thumbnails = "~/Library/Application Support/RetroArch/thumbnails"
src_cores_suffix = ".dylib"
# Provide the specific location where to sync data to
dest_playlists = "/home/deck/.var/app/org.libretro.RetroArch/config/retroarch/playlists"
dest_bios = "/home/deck/Emulation/bios"
dest_roms = "/home/deck/Emulation/roms"
dest_thumbnails = "/home/deck/.var/app/org.libretro.RetroArch/config/retroarch/thumbnails"
# Actual Destinations on the Target Device
target_roms = "/home/deck/Emulation/roms"
target_cores = "/home/deck/.var/app/org.libretro.RetroArch/config/retroarch/cores"
target_cores_suffix = ".so"
[[playlists]]
name = "Atari - 2600.lpl"
src_folder = "Atari - 2600"
dest_folder = "atari2600"
src_core_path = "stella_libretro"
src_core_name = "Atari - 2600 (Stella)"
dest_core_path = "stella_libretro"
dest_core_name = "Atari - 2600 (Stella)"
[[playlists]]
name = "Atari - 7800.lpl"
src_folder = "Atari - 7800"
dest_folder = "atari7800"
src_core_path = "prosystem_libretro"
src_core_name = "Atari - 7800 (ProSystem)"
dest_core_path = "prosystem_libretro"
dest_core_name = "Atari - 7800 (ProSystem)"
[[playlists]]
name = "Sharp - X68000.lpl"
src_folder = "Sharp - X68000"
# Make sure to include all zip files matching the "FD" pattern
src_whitelist = '.*FD.*\.zip$'
# Exclude all files that hint hard disk images
src_blacklist = '.*HD.*\.zip$'
dest_folder = "x68000"
src_core_path = "px68k_libretro"
src_core_name = "Sharp - X68000 (PX68k)"
dest_core_path = "px68k_libretro"
dest_core_name = "Sharp - X68000 (PX68k)"
disabled = false
[[playlists]]
name = "Commodore - Amiga.lpl"
src_folder = "Commodore - Amiga"
# Make sure to include all m3u list
src_whitelist = '\.m3u$'
# Don't add single adf images
src_blacklist = '\.adf$'
# Create fresh m3u files while updating playlists
src_create_m3u = true
# Only include adf images in m3u files
src_m3u_whitelist = '\.adf$'
# Normalizing pattern for files like "Agony (Disk 1 of 3).adf"
src_m3u_pattern = '(.*)(\(Disk \d of \d\)).*\.adf'
dest_folder = "amiga"
src_core_path = "puae_libretro"
src_core_name = "Commodore - Amiga (PUAE)"
dest_core_path = "puae_libretro"
dest_core_name = "Commodore - Amiga (PUAE)"
disabled = false
To synchronize all your playlists (as defined in your TOML configuration file) and ROMs onto your Steam Deck, simply execute the following command:
python retrosync.py --sync-roms --sync-playlistsTo view extensive information regarding current operations, include --debug in your command to generate detailed logs within a debug.log file.
python retrosync.py --sync-roms --sync-playlists --debugTo synchronize all local resources such as playlists, game ROMs, BIOS files, and thumbnails to your Steam Deck:
python retrosync.py --allPlaylist and ROM actions can be limited to a single system, as follows:
python retrosync.py --debug --sync-roms --sync-playlists --name "psx"
Do you want to continue with playlists 'Sony - PlayStation.lpl'? [y/N]:You have the option to include --yes in order to bypass the prompt.
python retrosync.py --debug --sync-roms --sync-playlists --name "psx" --yesTo refresh and recreate a local playlist by scanning your ROM folder:
python retrosync.py --debug --update-playlists --name "psx"Forcibly use the Windows Transport Module to avoid relying on locally installed shell commands such as 'scp' and 'rsync'.
python retrosync.py --debug --sync-playlists --name "psx" --transport-windowsTo install Retrosync, follow these steps (detailed steps are also available in the setup.sh for Unix-based systems and setup.bat for Windows systems):
-
Clone the Repository: First, clone the Retrosync repository to your local machine.
git clone https://github.com/optixx/retrosync.git cd retrosync -
Set Up Virtual Environment: It's recommended to use a virtual environment to manage dependencies. You can create and activate a virtual environment using the following commands:
python3 -m venv venv source venv/bin/activate # On Windows use `venv\Scripts\activate`
-
Install Dependencies: Install the dependencies using the included Makefile, which utilizes UV to install the dependencies into the virtual environment.
pip install --no-deps -r requirements.txt
-
Configuration: By default, the
steamdeck.tomlconfiguration file is employed. You can alter the configuration file by utilizing the command switch--config-fileto specify an alternate filename.
After completing these steps, Retrosync should be installed and ready to use.
For users who cannot set up a Python environment, bundled binaries of the script are available for download in the GitHub releases.