retros

README

RetroS

RetroS is a tool to help you manage files with your retro gaming setup on remote or local machines.

Image by @robwillup

Status

Early development. There are many features to be added and there may be bugs in current versions.

Piracy

This project does NOT provide any game ROM files and does not encourage obtaining such files illegally.

Download

You can download the latest binary from releases or use one of the commands below:

For Windows, you may need to download using the command below. When downloading from the browser, Windows Defender may remove it as a virus.

Linux

# wget
wget https://github.com/robwillup/retros/releases/download/v1.0.5/retros \
&& chmod +x retros

# cURL
curl -L https://github.com/robwillup/retros/releases/download/v1.0.5/retros \
-o retros && chmod +x retros

Windows

iwr "https://github.com/robwillup/retros/releases/download/v1.0.5/retros.exe" -o "retros.exe"

macOS

curl -L https://github.com/robwillup/retros/releases/download/v1.0.5/osx-retros \
-o retros && chmod +x retros

Setup

RetroS will need the host (IP address) and the username of the remote machine where RetroPie is running. You can configure that by running:

retros cf

RetroS assumes your SSH private key is in the default path, i.e.: $HOME/.ssh/id_rsa.

Commands

These are the commands currently available.

Copy

Adding a single ROM file to RetroPie:

retros cp Game.md

The ROM file will be added to the corresponding folder in RetroPie based on the ROM file extension, in the case above megadrive.

Adding all ROM files in a directory:

retros cp /home/gamer/roms

All ROM files in the provided directory will be copied to their respective emulators in RetroPie based on the file extensions.

Specifying the emulator

If a ROM file has a different extension, you can copy it by specifying the emulator it should go into:

retros cp --emulator=atari2600 Game.bin

List

Lists the ROM files in RetroPie:

retros ls

To list ROM files for specific emulators:

retros ls -e=mastersystem

Check

The check command verifies the integrity of ROM files. The example below shows how to check all ROM files in the snes directory:

retros check ~/games/snes

Roadmap

The intent for RetroS is that it will be used to sync other files and assets with RetroPie besides ROMs.

Much is still under consideration, but some ideas are being added to the project here.