misc docs and minor config corrections/additions (#327)

CODE_OF_CONDUCT.md

@@ -131,4 +131,3 @@ at [https://www.contributor-covenant.org/translations][translations].
 [Mozilla CoC]: https://github.com/mozilla/diversity
 [FAQ]: https://www.contributor-covenant.org/faq
 [translations]: https://www.contributor-covenant.org/translations
-

README.md

@@ -32,8 +32,8 @@
 > [!IMPORTANT]
 > Unlocking the bootloader will erase all data on your device!
 > This also includes your DRM keys, which are stored in the Trim Area partition (also called TA) in case your device is fairly recent and supports DRM L1. Those devices will be downgraded to DRM L3. Devices on DRM L3 by default will not be affected.
+> Depending on your device you might be able to back up the TA partition using exploits and gaining temporary root access. On Sony Xperia 1/5 series phones DRM L1 will return once the bootloader is relocked.
 > Before proceeding, ensure the data you would like to retain is backed up to your PC and/or your Google account, or equivalent. Please note that OEM backup solutions like Samsung and Motorola backup may not be accessible from LineageOS once installed.
-> If you wish to backup the TA partition first, you can find tutorials related to your device on the internet.
 
 ## Usage
 
@@ -130,7 +130,7 @@ Sony | Xperia 10 Plus | [mermaid](https://wiki.lineageos.org/devices/mermaid) |
 Sony | Xperia XA2 | [pioneer](https://wiki.lineageos.org/devices/pioneer) | | tested
 Sony | Xperia XZ2 | [akari](https://wiki.lineageos.org/devices/akari) | | tested
 Sony | Xperia XZ3 | [akatsuki](https://wiki.lineageos.org/devices/akatsuki) | | tested
-Sony | Xperia ZX | kagura | | planned
+Sony | Xperia XZ | kagura | | planned
 
 </details>
 
@@ -148,12 +148,12 @@ Fairphone | Fairphone 4 | [FP4](https://wiki.lineageos.org/devices/FP4) | | test
 
 Vendor | Device Name | CodeName | Models | Status
 ---|---|---|---|---
+Motorola | edge | [racer](https://wiki.lineageos.org/devices/racer) | | tested
 Motorola | moto g5 | [cedric](https://wiki.lineageos.org/devices/cedric) | | tested
 Motorola | moto g6 plus | [evert](https://wiki.lineageos.org/devices/evert) | | tested
 Motorola | moto g7 power | [ocean](https://wiki.lineageos.org/devices/ocean) | | tested
 Motorola | moto g 5G plus / one 5G | [nairo](https://wiki.lineageos.org/devices/nairo) | | tested
 Motorola | moto g 5G / one 5G ace | [kiev](https://wiki.lineageos.org/devices/kiev) | | tested
-Motorola | edge | [racer](https://wiki.lineageos.org/devices/racer) | | tested
 Motorola | moto z | [griffin](https://wiki.lineageos.org/devices/griffin) | | tested
 
 </details>
@@ -203,13 +203,13 @@ And more to come!
 ## Contributing
 
 All kinds of contributions are welcome. These include:
-- Fix and improve texts in configs and in the application.
-- Test the tool for a supported device.
-- Create a config for a new device.
-- Test the application on your computer and/or device.
-- Contribute an application build for a new platform.
-- Add features and/or improve the code base.
-- Report bugs.
+- Fixes and improvements to the texts in configs and in the application.
+- Testing the tool for a supported device.
+- Creating a config for a new device.
+- Testing the application on your computer and/or device.
+- Contributing an application build for a new platform.
+- Adding features and/or improve the code base.
+- Reporting bugs.
 
 [How to contribute your own installation configurations](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/docs/how_to_contribute_your_own_installation_configurations.md)
 

docs/building_the_application_for_your_platform.md

@@ -6,9 +6,8 @@ If you build the application for your platform and want to contribute the build,
 
 ## Run OpenAndroidInstaller for development
 
-Currently development is only supported on Ubuntu Linux. MacOS and Windows should also work fine. You might need to install additional USB-drivers on Windows.
+Currently development is only supported on Ubuntu Linux. MacOS, Windows as well as other Linux distributions supporting flatpak should also work fine. You might need to install additional USB-drivers on Windows.
 
 1. Clone the main branch of this repository
 2. Run `make poetry` and `make install` to install poetry to manage python and install the required dependencies like adb, fastboot and heimdall.
 3. Run `make app` to start the desktop app from the source.
-

docs/how_to_contribute_your_own_installation_configurations.md

@@ -40,4 +40,3 @@ Every step in the config file corresponds to one view in the application. These
 - `allow_skip`: [OPTIONAL] boolean; If a skip button should be displayed to allow skipping this step. Can be useful when the bootloader is already unlocked.
 
 **Please try to retain this order of these fields in your config to ensure consistency.**
-

docs/unlocking_the_bootloader.md

@@ -10,6 +10,7 @@ For some devices, it is necessary to unlock the bootloader manually. You usually
 Other phone manufacturers no longer allow you to unlock the bootloader. Nothing can be done if you have not unlocked your device in time. These manufacturers include *Huawei, Honor, LG and ASUS*. Support for these manufacturers will always be very limited.
 
 ## Here is a brief overview of the bootloader policies of some of the most popular brands (may be incomplete/inaccurate)
+## Note: Some oems on the list may offer carrier locked or region specific models, which also affect the unlock ability (Sony, Google, Motorola, etc.)
 
 | Brand | Flashing tool | Unlocking Method | Loss of guarantee\* | Supported models |
 |---|---|---|---|---|

openandroidinstaller/assets/configs/Mi439.yaml

@@ -28,25 +28,25 @@ steps:
     - type: link_button_with_confirm
       content: >
         - Create a Mi account on Xiaomi’s website. Beware that one account is only allowed to unlock one unique device every 30 days.
-        
+
         - Add a phone number to your Mi account, insert a SIM into your phone.
-        
+
         - Enable developer options in `Settings` > `About Phone` by repeatedly tapping MIUI Version.
-        
+
         - Link the device to your Mi account in `Settings` > `Additional settings` > `Developer options` > `Mi Unlock status`.
-        
+
         - Download the Mi Unlock app with the link bellow (Windows is required to run the app), and follow the instructions provided by the app. It may tell you that you have to wait, usually 7 days. If it does so, please wait the quoted amount of time before continuing to the next step!
-        
+
         - After device and Mi account are successfully verified, the bootloader should be unlocked.
-        
+
         - Since the device resets completely, you will need to re-enable USB debugging to continue : `Settings` > `Additional settings` > `Developer options` > `USB debugging`
       link: https://en.miui.com/unlock/download_en.html
   boot_recovery:
     - type: call_button
       content: >
         Now you need to install a custom recovery system on the phone. A recovery is a small subsystem on your phone,
         that manages updating, adapting and repairing of the operating system.
-        
+
         Once the device is fully booted, you need to reboot into the bootloader again by pressing 'Confirm and run' here. Then continue.
       command: adb_reboot_bootloader
     - type: call_button
@@ -59,4 +59,4 @@ steps:
         Reboot to recovery by pressing 'Confirm and run', and hold the Vol+ button of your phone UNTIL you see the recovery.
         If MiUI starts, you have to start the process again, since MiUI delete the recovery you just flashed.
         Once it's done continue.
-      command: fastboot_reboot_recovery
+      command: fastboot_reboot_recovery

openandroidinstaller/assets/configs/a7y17lte.yaml

@@ -6,6 +6,7 @@ metadata:
   supported_device_codes:
     - a7y17lte
     - a7y17ltexx
+  untested: true
 steps:
   unlock_bootloader:
   boot_recovery:

openandroidinstaller/assets/configs/begonia.yaml

@@ -21,17 +21,17 @@ steps:
     - type: link_button_with_confirm
       content: >
         - Create a Mi account on Xiaomi’s website. Beware that one account is only allowed to unlock one unique device every 30 days.
-        
+
         - Add a phone number to your Mi account, insert a SIM into your phone.
-        
+
         - Enable developer options in `Settings` > `About Phone` by repeatedly tapping MIUI Version.
-        
+
         - Link the device to your Mi account in `Settings` > `Additional settings` > `Developer options` > `Mi Unlock status`.
-        
+
         - Download the Mi Unlock app with the link bellow (Windows is required to run the app), and follow the instructions provided by the app. It may tell you that you have to wait, usually 7 days. If it does so, please wait the quoted amount of time before continuing to the next step!
-        
+
         - After device and Mi account are successfully verified, the bootloader should be unlocked.
-        
+
         - Since the device resets completely, you will need to re-enable USB debugging to continue : `Settings` > `Additional settings` > `Developer options` > `USB debugging`
       link: https://en.miui.com/unlock/download_en.html
   boot_recovery:
@@ -53,4 +53,4 @@ steps:
         Reboot to recovery by pressing 'Confirm and run', and hold the Vol+ button of your phone UNTIL you see the recovery.
         If MiUI starts, you have to start the process again, since MiUI delete the recovery you just flashed.
         Once it's done continue.
-      command: fastboot_reboot_recovery
+      command: fastboot_reboot_recovery

openandroidinstaller/assets/configs/cheeseburger.yaml

@@ -7,6 +7,8 @@ metadata:
     - cheeseburger
     - OnePlus5
   twrp-link: cheeseburger_dumpling
+requirements:
+  android: 10
 steps:
   unlock_bootloader:
     - type: call_button
@@ -21,7 +23,7 @@ steps:
         Once it's done, press continue here.
       command: fastboot_oem_unlock
     - type: confirm_button
-      content: > 
+      content: >
         The bootloader is now unlocked. Since the device resets completely, you will need to re-enable Developer Options and USB debugging to continue.
   boot_recovery:
     - type: call_button
@@ -34,4 +36,4 @@ steps:
       img: twrp-start.jpeg
       content: >
         Boot a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
-      command: fastboot_boot_recovery
+      command: fastboot_boot_recovery

openandroidinstaller/assets/configs/cupid.yaml

@@ -22,25 +22,25 @@ steps:
     - type: link_button_with_confirm
       content: >
         - Create a Mi account on Xiaomi’s website. Beware that one account is only allowed to unlock one unique device every 30 days.
-        
+
         - Add a phone number to your Mi account, insert a SIM into your phone.
-        
+
         - Enable developer options in `Settings` > `About Phone` by repeatedly tapping MIUI Version.
-        
+
         - Link the device to your Mi account in `Settings` > `Additional settings` > `Developer options` > `Mi Unlock status`.
-        
+
         - Download the Mi Unlock app with the link bellow (Windows is required to run the app), and follow the instructions provided by the app. It may tell you that you have to wait, usually 7 days. If it does so, please wait the quoted amount of time before continuing to the next step!
-        
+
         - After device and Mi account are successfully verified, the bootloader should be unlocked.
-        
+
         - Since the device resets completely, you will need to re-enable USB debugging to continue : `Settings` > `Additional settings` > `Developer options` > `USB debugging`
       link: https://en.miui.com/unlock/download_en.html
   boot_recovery:
     - type: call_button
       content: >
         Now you need to install a custom recovery system on the phone. A recovery is a small subsystem on your phone,
         that manages updating, adapting and repairing of the operating system.
-        
+
         Once the device is fully booted, you need to reboot into the bootloader again by pressing 'Confirm and run' here. Then continue.
       command: adb_reboot_bootloader
     - type: call_button

openandroidinstaller/assets/configs/davinci.yaml

@@ -17,17 +17,17 @@ steps:
     - type: link_button_with_confirm
       content: >
         - Create a Mi account on Xiaomi’s website. Beware that one account is only allowed to unlock one unique device every 30 days.
-        
+
         - Add a phone number to your Mi account, insert a SIM into your phone.
-        
+
         - Enable developer options in `Settings` > `About Phone` by repeatedly tapping MIUI Version.
-        
+
         - Link the device to your Mi account in `Settings` > `Additional settings` > `Developer options` > `Mi Unlock status`.
-        
+
         - Download the Mi Unlock app with the link bellow (Windows is required to run the app), and follow the instructions provided by the app. It may tell you that you have to wait, usually 7 days. If it does so, please wait the quoted amount of time before continuing to the next step!
-        
+
         - After device and Mi account are successfully verified, the bootloader should be unlocked.
-        
+
         - Since the device resets completely, you will need to re-enable USB debugging to continue : `Settings` > `Additional settings` > `Developer options` > `USB debugging`
       link: https://en.miui.com/unlock/download_en.html
   boot_recovery:

openandroidinstaller/assets/configs/dumpling.yaml

@@ -7,6 +7,8 @@ metadata:
     - dumpling
     - OnePlus5T
   twrp-link: cheeseburger_dumpling
+requirements:
+  android: 10
 steps:
   unlock_bootloader:
     - type: call_button
@@ -21,7 +23,7 @@ steps:
         Once it's done, press continue here.
       command: fastboot_oem_unlock
     - type: confirm_button
-      content: > 
+      content: >
         The bootloader is now unlocked. Since the device resets completely, you will need to re-enable Developer Options and USB debugging to continue.
   boot_recovery:
     - type: call_button
@@ -34,4 +36,4 @@ steps:
       img: twrp-start.jpeg
       content: >
         Boot a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
-      command: fastboot_boot_recovery
+      command: fastboot_boot_recovery

openandroidinstaller/assets/configs/fajita.yaml

@@ -2,7 +2,7 @@ metadata:
   maintainer: Tobias Sterbak (tsterbak)
   device_name: OnePlus 6T
   is_ab_device: true
-  device_code: fajita 
+  device_code: fajita
   supported_device_codes:
     - fajita
     - OnePlus6T
@@ -23,7 +23,7 @@ steps:
         Once it's done, press continue here.
       command: fastboot_oem_unlock
     - type: confirm_button
-      content: > 
+      content: >
         The bootloader is now unlocked. Since the device resets completely, you will need to re-enable Developer Options and USB debugging to continue.
   boot_recovery:
     - type: call_button
@@ -46,4 +46,4 @@ steps:
       img: twrp-start.jpeg
       content: >
         Now we need to boot into recovery again. Press run and when you see the TWRP screen you can continue.
-      command: fastboot_boot_recovery
+      command: fastboot_boot_recovery

openandroidinstaller/assets/configs/garden.yaml

@@ -22,17 +22,17 @@ steps:
     - type: link_button_with_confirm
       content: >
         - Create a Mi account on Xiaomi’s website. Beware that one account is only allowed to unlock one unique device every 30 days.
-        
+
         - Add a phone number to your Mi account, insert a SIM into your phone.
-        
+
         - Enable developer options in `Settings` > `About Phone` by repeatedly tapping MIUI Version.
-        
+
         - Link the device to your Mi account in `Settings` > `Additional settings` > `Developer options` > `Mi Unlock status`.
-        
+
         - Download the Mi Unlock app with the link bellow (Windows is required to run the app), and follow the instructions provided by the app. It may tell you that you have to wait, usually 7 days. If it does so, please wait the quoted amount of time before continuing to the next step!
-        
+
         - After device and Mi account are successfully verified, the bootloader should be unlocked.
-        
+
         - Since the device resets completely, you will need to re-enable USB debugging to continue : `Settings` > `Additional settings` > `Developer options` > `USB debugging`
       link: https://en.miui.com/unlock/download_en.html
   boot_recovery:
@@ -54,4 +54,4 @@ steps:
         Reboot to recovery by pressing 'Confirm and run', and hold the Vol+ button of your phone UNTIL you see the recovery.
         If MiUI starts, you have to start the process again, since MiUI delete the recovery you just flashed.
         Once it's done continue.
-      command: fastboot_reboot_recovery
+      command: fastboot_reboot_recovery

openandroidinstaller/assets/configs/ginkgo.yaml

@@ -21,17 +21,17 @@ steps:
     - type: link_button_with_confirm
       content: >
         - Create a Mi account on Xiaomi’s website. Beware that one account is only allowed to unlock one unique device every 30 days.
-        
+
         - Add a phone number to your Mi account, insert a SIM into your phone.
-        
+
         - Enable developer options in `Settings` > `About Phone` by repeatedly tapping MIUI Version.
-        
+
         - Link the device to your Mi account in `Settings` > `Additional settings` > `Developer options` > `Mi Unlock status`.
-        
+
         - Download the Mi Unlock app with the link bellow (Windows is required to run the app), and follow the instructions provided by the app. It may tell you that you have to wait, usually 7 days. If it does so, please wait the quoted amount of time before continuing to the next step!
-        
+
         - After device and Mi account are successfully verified, the bootloader should be unlocked.
-        
+
         - Since the device resets completely, you will need to re-enable USB debugging to continue : `Settings` > `Additional settings` > `Developer options` > `USB debugging`
       link: https://en.miui.com/unlock/download_en.html
   boot_recovery:
@@ -53,4 +53,4 @@ steps:
         Reboot to recovery by pressing 'Confirm and run', and hold the Vol+ button of your phone UNTIL you see the recovery.
         If MiUI starts, you have to start the process again, since MiUI delete the recovery you just flashed.
         Once it's done continue.
-      command: fastboot_reboot_recovery
+      command: fastboot_reboot_recovery

openandroidinstaller/assets/configs/guacamole.yaml

@@ -2,7 +2,7 @@ metadata:
   maintainer: Tobias Sterbak (tsterbak)
   device_name: OnePlus 7 Pro
   is_ab_device: true
-  device_code: guacamole 
+  device_code: guacamole
   supported_device_codes:
     - guacamole
     - OnePlus7Pro
@@ -25,7 +25,7 @@ steps:
         Once it's done, press continue here.
       command: fastboot_oem_unlock
     - type: confirm_button
-      content: > 
+      content: >
         The bootloader is now unlocked. Since the device resets completely, you will need to re-enable Developer Options and USB debugging to continue.
   boot_recovery:
     - type: call_button
@@ -38,4 +38,4 @@ steps:
       img: twrp-start.jpeg
       content: >
         Boot a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue.
-      command: fastboot_boot_recovery
+      command: fastboot_boot_recovery