You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@
20
20
</p>
21
21
</div>
22
22
23
-
> **Warning**: This application is currently in alpha state, so use at your own risk! I take no responsibility for bricked devices or dead SD cards.
23
+
> **Warning**: This application is currently in early alpha state, so use at your own risk! I take no responsibility for bricked devices or dead SD cards.
24
24
25
25
> **Note**: Unlocking the bootloader will erase all data on your device!
26
26
This also includes your DRM keys, which are stored in the Trim Area partition (also called TA).
@@ -33,9 +33,11 @@ Vendor | Device Name | CodeName | Models | Status
Samsung | Galaxy A5 2016 | a5xelte | | under development
35
35
Google | Pixel 3a | sargo | sargo | tested
36
-
Sony | Xperia Z | yuga | | tested
36
+
Sony | Xperia Z | yuga | C6603 | tested
37
+
Sony | Xperia Z3 | z3 | | under development
37
38
38
39
## Installation
40
+
Currently, only linux is supported.
39
41
40
42
1. Download the AppImage, .exe or appropriate file for your OS.
41
43
2. Install `adb` and `fastboot` by running `sudo apt install android-tools-adb android-tools-fastboot`
@@ -54,8 +56,9 @@ Start the desktop app and follow the instructions.
54
56
## Run OpenAndroidInstaller for development
55
57
56
58
1. Clone the main branch of this repository
57
-
2. Run `make poetry` and `make install` to setup poetry and the relevant requirements
58
-
3. Clone this Run `make app` to start the desktop app from the source code.
59
+
2. Follow the steps 2. and 3. from 'Installation' above.
60
+
3. Run `make poetry` and `make install` to setup poetry and the relevant requirements
61
+
4. Run `make app` to start the desktop app from the source.
59
62
60
63
## Contribute your own installation configurations
61
64
@@ -73,6 +76,7 @@ Every step in the config file corresponds to one view in the application. These
73
76
-`<image>`: The path of the image file.
74
77
-`<recovery>`: The path of the recovery file.
75
78
-`<inputtext>`: Text from the user input from `call_button_with_input` views.
79
+
-`img`: Display an image on the left pane of the step view. Images are loaded from `openandroidinstaller/assets/imgs/`.
76
80
-`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.
77
81
78
82
After you created a config file, you can open a pull request to make the file available to other users. The file should be named after device name output by `adb shell dumpsys bluetooth_manager | grep 'name:' | cut -c9-` when the devices is connected to the computer. Please also add the device to the supported devices table above.
content: "Turn on your device and wait until its fully booted."
4
+
content: "As a first step, you need to unlock the bootloader. A bootloader is the piece of software, that tells your phone who to start and run an operating system (like Android). Your device should be turned on."
5
5
- title: "Unlock the bootloader"
6
6
type: call_button
7
-
content: "Reboot into bootloader"
7
+
content: "Press 'Confirm and run' to reboot into the bootloader."
8
8
command: "adb reboot bootloader"
9
9
- title: "Unlock the bootloader"
10
10
type: confirm_button
11
-
content: "Select 'Restart bootloader' on your smartphone screen. Then confirm"
11
+
content: "Select 'Restart bootloader' on your smartphone screen by pressing the volume button and the confirm by pushing the power button. Then press 'Confirm and continue' here."
12
12
- title: "Unlock the bootloader"
13
13
type: call_button
14
-
content: "Unlock the bootloader now:"
14
+
content: "In this step you actually unlock the bootloader. Just press 'Confirm and run' here. Once it's done, press continue here."
15
15
command: "fastboot flashing unlock"
16
16
allow_skip: True
17
17
- title: "Unlock the bootloader"
18
18
type: confirm_button
19
19
content: "At this point the device may display on-screen prompts which will require interaction to continue the process of unlocking the bootloader. Please take whatever actions the device asks you to to proceed."
20
20
- title: "Unlock the bootloader"
21
21
type: call_button
22
-
content: "Reboot the phone"
22
+
content: "To finish the unlocking, the phone needs to reboot. Just press 'Confirm and run' here to reboot. Then continue."
23
23
command: "fastboot reboot"
24
24
- title: "Unlock the bootloader"
25
25
type: confirm_button
26
26
content: "The bootloader is now unlocked. Since the device resets completely, you will need to re-enable USB debugging to continue."
27
-
- title: "Flash custom recovery"
27
+
- title: "Flash a custom recovery"
28
+
type: confirm_button
29
+
content: "Now you need to flash 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."
30
+
- title: "Flash a custom recovery"
28
31
type: call_button
29
-
content: "Once the device is fully booted, reboot into bootloader"
32
+
content: "Once the device is fully booted, you need to reboot into the bootloader again by pressing 'Confirm and run' here. Then continue."
30
33
command: "adb reboot bootloader"
31
-
- title: "Flash custom recovery"
34
+
- title: "Flash a custom recovery"
32
35
type: confirm_button
33
-
content: "Select 'Restart bootloader' on your smartphone screen. Then confirm"
34
-
- title: "Flash custom recovery"
36
+
content: "Select 'Restart bootloader' on your smartphone screen. Then confirm to continue."
37
+
- title: "Flash a custom recovery"
35
38
type: call_button
36
-
content: "Flash custom recovery (temporarily)"
39
+
content: "Flash a custom recovery (temporarily) by pressing 'Confirm and run'. Once it's done continue."
37
40
command: "fastboot flash boot <recovery>"
41
+
- title: "Flash LineageOS"
42
+
type: confirm_button
43
+
content: "In this step, you finally flash LineageOS. Confirm to continue."
38
44
- title: "Flash LineageOS"
39
45
type: confirm_button
40
-
content: "Select 'Recovery Mode' on your smartphone screen. Then confirm"
46
+
content: "Select 'Recovery Mode' on your smartphone screen and press the Start-Button to confirm. Then confirm here."
41
47
- title: "Flash LineageOS"
42
48
type: confirm_button
43
-
content: "Now tap Factory Reset, then Format data / factory reset and continue with the formatting process. This will remove encryption and delete all files stored in the internal storage, as well as format your cache partition (if you have one)."
49
+
content: "Now tap Factory Reset, then Format data / Factory reset on your phone screen and continue with the formatting process. This will remove encryption and delete all files stored in the internal storage, as well as format your cache partition (if you have one)."
44
50
- title: "Flash LineageOS"
45
51
type: confirm_button
46
-
content: "Return to the main menu."
52
+
content: "Return to the main menu on the phone."
47
53
- title: "Flash LineageOS"
48
54
type: confirm_button
49
-
content: "On the device, select “Apply Update”, then “Apply from ADB” to begin sideload. Then confirm here"
55
+
content: "On the device, select “Apply Update”, then “Apply from ADB” to begin sideload. Then confirm here."
50
56
- title: "Flash LineageOS"
51
57
type: call_button
52
-
content: "Flash lineageOS image. Don't remove the USB-Cable!"
58
+
content: "Now it's time to flash the LineageOS image. Don't remove the USB-Cable and press 'Confirm and run' to start! This might take a while. Confirm after it's done."
53
59
command: "adb sideload <image>"
54
60
- title: "Flash LineageOS"
55
61
type: confirm_button
56
-
content: "Flashing finished. Now press 'back' (arrow) and then 'Reboot system now' to finish the installation."
57
-
- title: "Successfully finished flashing"
58
-
type: text
59
-
content: "Have fun with LineageOS!"
62
+
content: "Flashing finished. Now press 'back' (arrow) and then 'Reboot system now' on the phone screen to finish the installation."
content: "Turn on your device and wait until its fully booted."
5
-
- title: "Boot into recovery"
2
+
- title: "Boot into bootloader"
6
3
type: call_button
7
-
content: "Reboot into bootloader"
4
+
content: "As a first step, you need to boot into the bootloader. A bootloader is the piece of software, that tells your phone who to start and run an operating system (like Android). Your device should be turned on. Then press 'Confirm and run' to reboot into the bootloader. Continue once it's done."
8
5
command: "adb reboot download"
9
-
- title: "Boot into recovery"
6
+
- title: "Flash custom recovery"
10
7
type: call_button
11
-
content: "Flash custom recovery"
8
+
content: "In this step, you need to flash a custom recovery on your device. Press 'Confirm and run' to start the process. Confirm afterwards to continue."
content: "Unplug the USB cable from your device. Manually reboot into recovery. Press the Volume Down + Power buttons for 8~10 seconds until the screen turns black & release the buttons immediately when it does, then boot to recovery with the device powered off, hold Volume Up + Home + Power."
12
+
content: "Unplug the USB cable from your device. Then manually reboot into recovery by pressing the Volume Down + Power buttons for 8~10 seconds until the screen turns black & release the buttons immediately when it does, then boot to recovery with the device powered off, hold Volume Up + Home + Power."
16
13
- title: "Flash LineageOS"
17
14
type: confirm_button
18
-
content: "Now tap 'Wipe'. Then tap 'Format Data' and continue with the formatting process. This will remove encryption and delete all files stored in the internal storage."
15
+
content: "Now tap 'Wipe' on your phone. Then tap 'Format Data' and continue with the formatting process. This will remove encryption and delete all files stored in the internal storage. Confirm to continue once you are done."
19
16
- title: "Flash LineageOS"
20
17
type: confirm_button
21
-
content: "Return to the previous menu and tap 'Advanced Wipe', then select the 'Cache' and 'System' partitions and then 'Swipe to Wipe'."
18
+
content: "Return to the previous menu on your phone and tap 'Advanced Wipe', then select the 'Cache' and 'System' partitions and then 'Swipe to Wipe'. Confirm to continue once you are done."
22
19
- title: "Flash LineageOS"
23
20
type: confirm_button
24
-
content: "Now connect the phone to the computer again with the USB-cable. On the device, go back and select “Advanced”, “ADB Sideload”, then swipe to begin sideload. Then confirm here"
21
+
content: "Now connect the phone to the computer again with the USB-cable. On the device, go back and select “Advanced”, “ADB Sideload”, then swipe to begin sideload. Then confirm here."
25
22
- title: "Flash LineageOS"
26
23
type: call_button
27
-
content: "Flash lineageOS image. Don't remove the USB-Cable!"
24
+
content: "Now it's time to flash the LineageOS image. Don't remove the USB-Cable and press 'Confirm and run' to start! This might take a while. Confirm after it's done."
28
25
command: "adb sideload <image>"
29
-
- title: "Reboot"
26
+
- title: "Reboot into LineageOS"
30
27
type: call_button
31
-
content: "Reboot into OS"
32
-
command: "adb reboot"
33
-
- title: "Successfully finished flashing"
34
-
type: text
35
-
content: "Have fun with LineageOS!"
28
+
content: "As a final step, reboot into LineageOS to finish the installation by pressing the button."
content: "On the device, dial *#*#7378423#*#* (*#*#SERVICE#*#*) to launch the service menu."
4
+
content: "As a first step, you need to unlock the bootloader of your device. On the device, dial *#*#7378423#*#* (*#*#SERVICE#*#*) to launch the service menu."
5
5
- title: "Unlock the bootloader"
6
6
type: confirm_button
7
-
content: "Go to service info > configuration and check rooting status – you can only continue if it says Bootloader unlock allowed: Yes."
7
+
content: "Go to service info > configuration and check rooting status - you can only continue if it says 'Bootloader unlock allowed: Yes.'"
8
8
- title: "Unlock the bootloader"
9
9
type: confirm_button
10
-
content: "Connect the device to your PC via USB."
10
+
content: "Connect the device to your PC via USB. And confirm to continue."
11
11
- title: "Unlock the bootloader"
12
12
type: call_button
13
-
content: "Unlock the bootloader"
13
+
content: "Press the button to reboot into the bootloader now. Then confirm to continue."
14
14
command: "adb reboot bootloader"
15
15
- title: "Unlock the bootloader"
16
16
type: confirm_button
17
17
content: "Follow the instructions on Sonys official unlocking website to generate an unlock code for your bootloader. https://developer.sonymobile.com/unlockbootloader/unlock-yourboot-loader/"
18
18
- title: "Unlock the bootloader"
19
19
type: call_button_with_input
20
-
content: "Use your code to unlock the bootloader of your device:"
20
+
content: "Use your code to unlock the bootloader of your device. Type in the full 18 character code starting with 0x (Example: 0x3EC4F7AD6E0B32B6). If you already did that, you can skip this step."
21
21
command: "fastboot oem unlock <inputtext>"
22
22
allow_skip: True
23
23
- title: "Flash temporary recovery"
24
-
type: confirm_button
25
-
content: "Since the device resets completely, you will need to re-enable USB debugging to continue. Connect your device to your PC via USB."
24
+
type: call_button
25
+
content: "Press the button to reboot. Since the device resets completely, you will need to re-enable USB debugging to continue. Connect your device to your PC via USB. Then confirm here to continue."
26
+
command: "fastboot reboot"
26
27
- title: "Flash temporary recovery"
27
28
type: call_button
28
-
content: "Reboot into bootloader"
29
+
content: "Now you have to reboot into bootloader again. Press the button to do it and continue once it is done."
29
30
command: "adb reboot bootloader"
30
31
allow_skip: True
31
32
- title: "Flash temporary recovery"
32
33
type: call_button
33
-
content: "Flash recovery image"
34
+
content: "Next, you need to flash a custom recovery image. Press the button to flash the selected image. Then continue."
34
35
command: "fastboot flash boot <recovery>"
35
36
- title: "Flash LineageOS"
36
37
type: call_button
37
-
content: "Boot into recovery"
38
+
content: "Now, boot into recovery by pressing the button. Once it's booted again, continue."
38
39
command: "fastboot reboot"
39
40
- title: "Flash LineageOS"
40
41
type: confirm_button
41
-
content: "Now tap 'Wipe'. Then tap 'Format Data' and continue with the formatting process. This will remove encryption and delete all files stored in the internal storage."
42
+
content: "Now tap 'Wipe'. Then tap 'Format Data' and continue with the formatting process on your phone. This will remove encryption and delete all files stored in the internal storage. Then press the button to continue."
42
43
- title: "Flash LineageOS"
43
44
type: confirm_button
44
-
content: "Return to the previous menu and tap 'Advanced Wipe', then select the 'Cache' and 'System' partitions and then 'Swipe to Wipe'."
45
+
content: "Return to the previous menu and tap 'Advanced Wipe', then select the 'Cache' and 'System' partitions and then 'Swipe to Wipe' on the phone. Once it's finished, confirm here to continue."
45
46
- title: "Flash LineageOS"
46
47
type: confirm_button
47
-
content: "On the device, go back and select “Advanced”, “ADB Sideload”, then swipe to begin sideload. Then confirm here"
48
+
content: "On the device, go back to the main menu and select “Advanced”, “ADB Sideload”, then swipe to begin sideload. Then confirm here"
48
49
- title: "Flash LineageOS"
49
50
type: call_button
50
-
content: "Flash lineageOS image. Don't remove the USB-Cable!"
51
+
content: "By pressing the button, you flash lineageOS image now. This can take a while. Don't remove the USB-Cable!"
51
52
command: "adb sideload <image>"
52
53
- title: "Reboot"
53
54
type: call_button
54
-
content: "Reboot into OS"
55
-
command: "adb reboot"
56
-
- title: "Successfully finished flashing"
57
-
type: text
58
-
content: "Have fun with LineageOS!"
55
+
content: "As a final step, reboot into LineageOS to finish the installation by pressing the button."
0 commit comments