Skip to content

Commit c95a0b0

Browse files
authored
Merge pull request #80 from chrizzo-hb/main
A guide for major updates
2 parents ebf05b0 + a4ff9b1 commit c95a0b0

File tree

4 files changed

+57
-0
lines changed

4 files changed

+57
-0
lines changed

docs/guides/major-updates.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# :material-update: Major Updates
2+
3+
!!! warning "The safest way is a clean install"
4+
5+
The safest way to apply a major update is to **start over** with a clean install. It might take a little longer, but it will safely avoid all potential issues.
6+
7+
Minor KNULLI updates can be installed manually by simply exchanging the `boot/batocera` file, as explained in the [Update section](../../play/update). However, a **major** KNULLI update comes with significant changes which require a clean re-flash. Furthermore, a **major** update might also require to set all settings back to default since new settings might be introduced and existing settings might have been removed. However, it is possible to **salvage parts** of your previous installation and thereby **ease the process** of setting up KNULLI anew.
8+
9+
## Backing up your user data before re-flashing
10+
11+
If you run a dual SD card setup, all your user data is already stored on SD 2 anyway, so you do not need to back up anything.
12+
13+
However, if you run a single SD card setup, you might want to create a backup of your stuff before you re-flash KNULLI. Depending on the formatting of your SD card, you might be able to extract your user data either by plugging the SD card into a computer or by accessing your user data via [Network Transfer](../../play/add-games/network-transfer). In any case, you should be able to back up the entire content of your `/userdata` folder (also known as `\\KNULLI\share` folder or `SHARE` partition) to a different data storage, e.g., a computer hard drive.
14+
15+
## Re-flashing KNULLI
16+
17+
For a major update, it is **mandatory** to re-flash KNULLI entirely. Re-flashing basically means to go through the installation process step-by-step as if you were setting up KNULLI for the first time. During this process, all remaining data will be wiped off your SD card and all your settings will be set back to default.
18+
19+
## Cherry-picking
20+
21+
Depending on your SD card setup, you might be able to cherry-pick certain things from a previous installation **after** you finished installing the new version of KNULLI. Basically, you will be able to cherry-pick almost everything, all your games, saves, themes, scraped media, decorations, etc. **However, you will not be able to recover your previous settings.** A major update **requires** to return to **factory settings**.
22+
23+
!!! danger "Salvaging settings"
24+
25+
If you are **really** tech-savvy, you might be able to (partly) salvage single configuration files from within your `system` folder by comparing the respective files word-by-word and adopting single settings. However, this requires a deep understanding of what the files do and how they work, so we **strongly discourage** technically inept users from even trying.
26+
27+
You'd need to make sure only to adopt "harmless" settings and not to change any new technical defaults. In many cases, salvaging manually might take even longer than simply re-creating your settings from scratch. However, if you are **really** tech-savvy, it is theoretically possible.
28+
29+
### Cherry-picking data from a single SD card backup
30+
31+
If you prepared a backup of your previous installation, you can put some of the folders back after the installation process of the new KNULLI version is complete. **However, you should make sure not to adopt your previous `system` folder!** This folder might have dated settings and configurations which are now obsolete and/or incompatible with the new KNULLI version. Restoring an old `system` folder after re-flashing a major KNULLI update will lead to **unpredictable behavior**.
32+
33+
### Reset to factory settings on a dual SD card setup
34+
35+
If you ran a dual SD card setup before, all your user data is still stored safely on your SD 2. However, this SD 2 still has the old `system` folder which might have dated settings and configurations which are now obsolete and/or incompatible with the new KNULLI version. **You need to make sure to remove the `system` folder and let KNULLI create a new one!** Furthermore, we **strongly recommend** to **remove the `ports` folder from `roms`** to make KNULLI provide the *PortMaster* installer.
36+
37+
#### Reset to factory settings on an exFAT-formatted second SD card
38+
39+
If your SD 2 is formatted to **exFAT** (and therefore accessible from Windows), you can simply plug your SD 2 into your computer **before** you set it up as your data storage in KNULLI and **delete or rename the `system` folder** and **delete the `ports` folder from `roms`**. Afterwards, put SD 2 back in your device, switch *Storage* to *Any External* as explained in the [Dual-SD-Card setup section](../../play/add-games/second-sd-card) and reboot to apply the change. During the reboot, KNULLI will re-create the missing folders `system` and `roms/ports` with their default values.
40+
41+
You can now start to set up your device and install PortMaster with the PortMaster installer that will have re-appeared in the restored Ports section.
42+
43+
#### Reset to factory settings on an ext4-formatted second SD card
44+
45+
If your SD 2 is formatted to **ext4**, you will not be able to read it from Windows, so you will have to restore factory settings after you put your SD 2 back to work. First, put SD 2 back in your device, switch *Storage* to *Any External* as explained in the [Dual-SD-Card setup section](../../play/add-games/second-sd-card) and reboot to apply the change.
46+
47+
It is crucial now that you **do not change any settings** after rebooting. If you did change anything, please **reboot again**.
48+
49+
Now you need to **delete or rename the `system` folder** and **delete the `ports` folder from `roms`**, either by accessing your user data via [Network Transfer](../../play/add-games/network-transfer) or by using the built-in OD-Commander if you know how to use it. Afterwards, **reboot immediately** without changing any settings. During the reboot, KNULLI will re-create the missing folders `system` and `roms/ports` with their default values.
50+
51+
You can now start to set up your device and install PortMaster with the PortMaster installer that will have re-appeared in the restored Ports section.

docs/index.de.md

+2
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ In jedem Fall wünschen wir dir viel Spaß beim Spielen mit KNULLI!
3333

3434
Diese Version von KNULLI bringt eine große Menge Veränderungen mit sich, die es **zwingend nötig** machen, dass du KNULLI **neu flashst**.
3535

36+
Wir **raten eindringlich dazu**, eine komplett neue Installation von KNULLI aufzusetzen. Wenn du allerdings unbedingt versuchen möchtest, deine Benutzerdaten einer vorherigen Installation zu übernehmen, wirf bitte einen Blick in den Abschnitt [Umfangreiche Updates](../guides/major-updates).
37+
3638
## Über KNULLI
3739

3840
KNULLI ist eine unabhängige Custom-Firmware (CFW) für Retro-Gaming-Konsolen (Handhelds, Bartops, etc.). Knulli wird als Fork von [Batocera](https://batocera.org) entwickelt und verfolgt das Ziel, Geräte zu unterstützen, die unter mindestens eine dieser Kategorien fallen:

docs/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ In any case: We hope you enjoy playing your games with KNULLI!
3232
!!! warning "Major Update"
3333

3434
This version of KNULLI comes with a lot of new features which **require** to re-flash the firmware.
35+
36+
We **strongly recommend** to simply start over with a clean install. However, if you want to try migrating your user data from a previous installation to the new installation, please have a look at the [Major Updates guide](../guides/major-updates).
3537

3638
## About KNULLI
3739

mkdocs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ plugins:
157157
Dual SD Card Migration: Zu Dual-SD-Card-Setup wechseln
158158
PortMaster and exFAT: PortMaster und exFAT
159159
Power Management: Energieeinstellungen
160+
Major Updates: Umfangreiche Updates
160161
- locale: pl
161162
name: Polski
162163
build: true
@@ -303,6 +304,7 @@ nav:
303304
- Guides:
304305
- Dual SD Card Migration: guides/dual-sd-card-migration.md
305306
- PortMaster and exFAT: guides/portmaster-and-exfat.md
307+
- Major Updates: guides/major-updates.md
306308
- Community:
307309
- Contribute: community/contribute.md
308310
- Devices:

0 commit comments

Comments
 (0)