Skip to content

Latest commit

 

History

History
132 lines (102 loc) · 5.18 KB

README.md

File metadata and controls

132 lines (102 loc) · 5.18 KB
Raw

About

Vaporwave is a tool to manage, synchronize and backup ROMs and save files between different devices (computer, retro handhelds, smartphone, etc.) It's inspired in part from the e-books manager calibre.

Name is based on Steam (as the idea is to manage games and save files consistently between devices); the term vaporwave is also commonly associated with 80's/90's nostalgia, and therefore with retro gaming.

Features

  • Navigate local ROMs collection
  • Add device based on its SSH connection
  • Compare ROMs between computer and devices
  • Compare save files between computer and devices, and detect where the more recent save files are stored
  • Download/Upload ROMs files from/to devices
  • Download/Upload save files from/to devices
  • Tested on ArkOS with a RG351M device
  • Tested on RetroOZ with a PowKiddy RGB10Max device

Future Changes

  • Test/Add support for other devices and device OS (it's likely some OS store their ROMs differently)
  • Add/Remove ROMs from collection
  • Update local ROMs folder
  • Improve UI/UX (file transfer progress bars, warning when user override save files that seems more recent, etc.)
  • Improve save file comparison logic to better take into account cases where only the srm file was modified (the state file being the one actually containing the save states)
  • Manage PPSSPP save files
  • Save sync: Add a function that detects - for each ROM - the most recent save from all the locations, and uploads it to all locations. This could run in the background and sync on regular basis
  • Manage multiple ROMs folders
  • Manage save files and ROMs as 2 separate folders (to make it easier to backup save files on Dropbox, without uploading ROMs files )
  • Sync with local RetroArch installation
  • Add a nice app icon

How To

Run

  • Download the latest version on releases page.
    • vaporwave-win64-jre-<version>.zip contains the JAR (i.e. the executable), a JRE and an executable bat file. The bat file is a simple shortcut that launches the JAR file on the packaged JRE.
    • vaporwave-linux-<version>.zip contains the JAR and a sh file (which simply contains the command java -jar vaporwave.jar).
    • Both zip files are basically identical. The one containing the Windows JRE is just easier to use. You can download the vaporwave-linux-<version>.zip on Windows as well, as long as you know how to run the JAR.
  • Decompress somewhere on your computer (it can be moved later to any folder)
  • On Windows:
    • Run the bat file vaporwave.bat
    • On the Windows 10 warning message, click "More Info", then "Run anyway"
  • On Linux / macOS:
    • Run the JAR file on Java 8 using java -jar vaporwave.jar. Ensure default JRE is version 8.
    • On Linux, the following command allows you select the default Java:
    ➜  ~ sudo update-alternatives --config java                    
[sudo] password for benoit:          
There are 4 choices for the alternative java (providing /usr/bin/java).

Selection    Path                                            Priority   Status
------------------------------------------------------------
 0            /usr/lib/jvm/java-14-openjdk-amd64/bin/java      1411      auto mode
 1            /usr/lib/jvm/java-11-openjdk-amd64/bin/java      1111      manual mode
 2            /usr/lib/jvm/java-14-openjdk-amd64/bin/java      1411      manual mode
 3            /usr/lib/jvm/java-15-oracle/bin/java             1091      manual mode
 4            /usr/lib/jvm/java-8-openjdk-amd64/jre/bin/java   1081      manual mode
 
Press <enter> to keep the current choice[*], or type selection number: 4
  • From the code:
    • Import the project as a Gradle project in your IDE of choice, and run the Main.

Build

Build the project

./gradlew clean build

Package the zip files

The script assumes a copy of the Win64 JRE is located at ~/Dev/jre1.8.0_251. Change that line if necessary.

./dist.sh

Update dependencies

 ./gradlew dependencyUpdates --refresh-dependencies

Add a mock device

For test purpose, it's possible to add mock devices. Add the following to data/devices.json.

{
  "type": "be.encelade.vaporwave.model.devices.MockDevice",
  "name": "mock",
  "mockDataFileName": "ls-result-test-02",
  "mockDataMd5FileName": "md5-test-02"
}

Test files can be customized.

Change logs

Version alpha-1.1

  • Update Kotlin 1.5.30 to 1.5.31

Version alpha-1.0

  • Navigate local ROMs collection
  • Add device based on its SSH connection
  • Compare ROMs between computer and devices
  • Compare save files between computer and devices, and detect where the more recent save files are stored
  • Download/Upload ROMs files from/to devices
  • Download/Upload save files from/to devices
  • Tested on ArkOS with a RG351M device
  • Tested on RetroOZ with a PowKiddy RGB10Max device