|
|
@@ -1,3 +1,33 @@
|
|
|
# rclone_script
|
|
|
|
|
|
-Setup cloud synchronization for the save files on your RetroPie
|
|
|
+Setup cloud synchronization for the save files on your RetroPie
|
|
|
+
|
|
|
+## What does this do?
|
|
|
+
|
|
|
+This script will setup different things on your RetroPie in order to automatically sync save files to a cloud service supported by [rclone](https://rclone.org/)
|
|
|
+
|
|
|
+## What will you have to do?
|
|
|
+
|
|
|
+Just install this via
|
|
|
+```bash
|
|
|
+wget -N -P ~/scripts https://raw.githubusercontent.com/Jandalf81/rclone_script/master/rclone_script-install.sh
|
|
|
+chmod 755 ~/scripts/rclone_script-install.sh
|
|
|
+~/scripts/rclone_script-install.sh
|
|
|
+```
|
|
|
+
|
|
|
+I recommend reading this page completely before actually doing this!
|
|
|
+
|
|
|
+## Again, what does this do?
|
|
|
+
|
|
|
+Let me give you a rundown of the things this script will do:
|
|
|
+
|
|
|
+1. This script will install the _RCLONE_ binary. It will be downloaded directly from their website as the binary installable via _apt-get_ is quite old, sadly. _RCLONE_ actually is what allows us to use a number of different cloud services, see [their website](https://rclone.org/) for a complete list
|
|
|
+2. The script will then ask you to define a _remote_. That is the other side used for the synchronization. That remote **has** to be called _retropie_, the script will not continue without it
|
|
|
+3. Then, _PNGVIEW_ will be downloaded, compiled and installed. That will be used to show you notifications when up- and downloading save files.
|
|
|
+4. _IMAGEMAGICK_ will be installed via _apt-get_, this will be used to actually create images containing the notifications which are shown by _PNGVIEW_
|
|
|
+5. The other scripts you see here will now be downloaded. They are used to control _RCLONE_ whenever it needs to sync your save files. Notice that there's also a script to remove all of this from your RetroPie.
|
|
|
+6. Some scripts from RetroPie will be changed so they call one of the scripts from step 5 which then calls _RCLONE_... Sounds complicated but you don't have to do anything
|
|
|
+7. Right next to the _roms_ directory, a new directory _saves_ will be created, containing a subdirectoryfor each system
|
|
|
+8. Now, the setup script will ask you to enter a name for the remote base save directory. This is the directory where the save files will be synced to. You can enter any name you like, I recommend calling it _RetroArch_. After naming it, the setup script will create this directory and one subdirectory for each system RetroPie supports (if necessary)
|
|
|
+9. Your RetroPie will be configured so each system uses it's own directory for saves. Before, RetroPie looked for these files in the _roms_ directory (which made syncing them without accidentially uploading a ROM - ILLEGALLY - so much more difficult)
|
|
|
+10. That's it, setup is complete. If you already have some save files within the _roms_ directory you need to move them to their subdirectory within the _saves_ directory now.
|
Jandalf81