02. Updating to the Latest Release - spruceUI/spruceOS GitHub Wiki

Update meme

Updating to the Latest Release:

Updating will allow you to carry over any Save, ROM and BIOS files you have already written onto your microSD card vastly shortening the time required versus a full fresh installation. This entire process will only take a few minutes.

OTA Update Downloader for spruce versions 3.1.0 and above

Starting with spruce v3.1.0 an on board update download and install app is included. This will check our releases to determine if a newer version is available. If there is it will ask if you'd like to download it, after finishing the download it'll prompt if you'd like to install it. With our system if you decline the install, the EZUpdater app will be shown in apps and you can install at any time from your already downloaded file.

Automatic update checker

Included is the capabilities for spruce to check if an update is available. This setting is on by default and can be turned off. Spruce will check once in a 24 hour window after a normal start up and if connected to wifi. If an update is found spruce will show the Spruce Updater app and it will say "Update Available" in your app section. If you don't run the update after one is found Spruce will display a notification in the main menu, this will only happen once. After that it's up to you when you install the update.

Manually check for updates

If you'd like to manually check for updates, it's super easy. Spruce Updater app is hidden by default and shown by automatic update checker if needed. But if you'd like to check it yourself, just go to the Advanced Settings app, and navigate to the App Visibility tab, and scroll down to Spruce Updater and hit show. Save & Exit. Afterwards you should have an app in apps saying "Check for Updates". Give that a run, and if one is found it'll let you know.

EZ Updater for spruce versions 3.0.0 and above

  1. Download the "spruceVx.x.x.7z" from the Latest Release.
  2. Copy/paste this file directly onto the root of your microSD card. DO NOT EXTRACT THIS FILE
  3. Turn on your A30.
  4. Go to the "Apps" section and find the "spruce Updater" app and click on it.

It will go through the update process automatically! After it runs and a successful backup of your data it will update and shutdown your device. All you need to do is turn it back on and you're on the latest version of Spruce. It is as EZ as that!

EZ Updater for spruce versions 2.3.0 and below

We now have an auto updater package available with the 3.0.0 release. This will update you to the latest version and keep all your user data.

  1. Download the "EZ.Updater.spruceVx.x.x.zip" from the Latest Release.
  2. Place files onto the card:
  • Windows users should extract the .zip directly onto your microSD card allowing files to overwrite when prompted.
  • Mac users should copy the contents of the .zip onto the root of the microSD card and merge files when prompted.
  1. Turn on your A30.
  2. Go to the `"Apps" section and find the "EZ Updater" app and click on it.

It will go through the update process automatically! After it runs and a successful backup of your data it will update and shutdown your device. All you need to do is turn it back on and you're on the latest version of Spruce. It is as EZ as that!

For more detailed information, error explanations, and FAQs you can check the readme.txt on the AutoUpdater repository.

Manual Update Instructions

If you wish to manually update or something went horrifically wrong with your auto update process these steps can be followed to manually update.

There are too many possible configuration changes possible to have this process preserve custom settings for advanced users.

Spruce is intended to be simple and accessible to beginners, advanced users with lots of changes should proceed with caution or just accept that you might need to redo your custom settings.

Windows

If you're on 2.3.0 or higher Spruce includes a Spruce backup app to backup everything for you. On some versions this app is hidden by default so show it in Advanced Settings. If you use Spruce Backup you don't need to worry about backing up anything locally, just be sure not to delete your /Saves folder as that's where Spruce saves and looks for the backup file.

  1. Download the latest spruce release.

(optional) Copy and save back ups of a few things if not using Spruce Backup, see below.

  1. On your microSD card DELETE EVERYTHING EXCEPT "Roms, Saves, and BIOS".

  2. Open File Explorer and navigate to the latest release .zip.

  3. Right-click it and select "extract all".

  4. Extract the .zip directly onto the microSD card.

  5. When prompted, allow the new files to replace the existing ones.

(optional). Paste your locally saved files back in.

  1. After this has finished you can eject the microSD card from your computer an insert it into your device.

(optional) If you have a backup file, run the Spruce Restore app to have spruce automatically set it up. (App is hidden by default, set it to show in App Visibility in Advanced Settings.) replace

Mac

If you're on 2.3.0 or higher Spruce includes a Spruce backup app to backup everything for you. On some versions this app is hidden by default so show it in Advanced Settings. If you use Spruce Backup you don't need to worry about backing up anything locally, just be sure not to delete your /Saves folder as that's where Spruce saves and looks for the backup file.

  1. Download the latest spruce release.

  2. Insert your microSD card into your computer.

(optional) Copy and save back ups of a few things if not using Spruce Backup, see below.

  1. On your microSD card DELETE EVERYTHING EXCEPT Roms, Saves, and BIOS".

  2. SHOW HIDDEN FILES by pressing Command + Shift + . (Period).

  3. Navigate to the spruceVX.X.zip and double-click it (it will extract it automatically).

  4. Copy/paste the ENTIRE CONTENTS of the extracted spruce release onto your microSD card. You will get a few prompts, always select "Merge"

(optional). Save a copy of the Syncthing launch.sh. Paste your backup files in. Paste in the new launch.sh.

  1. Use an App like CleanEject (https://www.javawa.nl/cleaneject_en.html) to eject and clean the junk .dot files from your microSD card.

Important Note:

The .config and .temp_Update files might be hidden. YOU MUST SHOW HIDDEN FILES.

Files to Back Up if you want

PPSSPP Saves and configs:

.config/ppsspp/PSP/SAVEDATA

.config/ppsspp/PSP/SYSTEM

Syncthing configuration:

App/Syncthing/confg

NDS Saves:

Emu/NDS/backup

Emu/NDS/savestates

RetroArch config:

RetroArch/retroarch.cfg