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
value: "Thank you for your interest in OpenAndroidInstaller!"
9
+
- type: markdown
10
+
attributes:
11
+
value: "To get your device supported, please take the time to fill out this form."
12
+
- type: markdown
13
+
attributes:
14
+
value: "---"
15
+
- type: checkboxes
16
+
attributes:
17
+
label: Is your device already requested?
18
+
description: Please search to see if an issue for your device already exists.
19
+
options:
20
+
- label: I have searched the existing issues
21
+
required: true
22
+
- type: markdown
23
+
attributes:
24
+
value: "---"
25
+
- type: markdown
26
+
attributes:
27
+
value: "**Please input your device's details below:**"
28
+
- type: input
29
+
attributes:
30
+
label: Brand
31
+
description: The brand / manufacturer of your device
32
+
placeholder: Google
33
+
validations:
34
+
required: true
35
+
- type: input
36
+
attributes:
37
+
label: Name
38
+
description: The name of your device
39
+
placeholder: Pixel 3a
40
+
validations:
41
+
required: true
42
+
- type: input
43
+
attributes:
44
+
label: Device code
45
+
description: The device code OAI gave you in the error message
46
+
placeholder: sargo
47
+
validations:
48
+
required: true
49
+
- type: input
50
+
attributes:
51
+
label: Model
52
+
description: The model name of your device (only required, if there are several models)
53
+
placeholder: G020F
54
+
validations:
55
+
required: false
56
+
- type: markdown
57
+
attributes:
58
+
value: "---"
59
+
- type: textarea
60
+
attributes:
61
+
label: Device images
62
+
description: "Please provide links to any available images for the device, such as official stock firmware, Custom ROMs and Recoveries you would like to install."
Copy file name to clipboardExpand all lines: README.md
+21-68Lines changed: 21 additions & 68 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,20 +27,21 @@
27
27
</p>
28
28
</div>
29
29
30
-
> **Warning**: This application is currently in beta state, so use at your own risk! While many people tested the application so far and we heard of no bricked devices, things might still go wrong.
31
-
32
-
> **Note**: Unlocking the bootloader will erase all data on your device!
33
-
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.
34
-
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.
35
-
If you wish to backup the TA partition first, you can find tutorials related to your device on the internet.
30
+
> [!WARNING]
31
+
> This application is currently in beta state, so use at your own risk! While many people tested the application so far and we heard of no bricked devices, things might still go wrong.
36
32
33
+
> [!IMPORTANT]
34
+
> Unlocking the bootloader will erase all data on your device!
35
+
> 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.
36
+
> 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.
37
+
> If you wish to backup the TA partition first, you can find tutorials related to your device on the internet.
37
38
38
39
## Usage
39
40
40
41
Linux is currently the best supported platform (tested with Ubuntu 20.04/22.04 LTS). Windows and MacOS are also supported but you might experience more issues. So far there is no support for ARM-based systems.
41
42
42
43
1. Download the [.exe or appropriate executable file for your OS](https://github.com/openandroidinstaller-dev/openandroidinstaller/releases) from the releases or get the [official flatpak from flathub](https://flathub.org/apps/org.openandroidinstaller.OpenAndroidInstaller). You might need to change permissions to run the executable.
43
-
- On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com/) and other potentially drivers needed for your device.
44
+
- On Windows also [install the Universal USB Drivers](https://adb.clockworkmod.com) and other potentially drivers needed for your device.
44
45
2. Download the custom ROM image and the TWRP recovery image for your device and optionally some addons. A source for files can be found on the following websites:
45
46
- some custom ROMs:
46
47
-[LineageOS](https://wiki.lineageos.org/devices)
@@ -82,11 +83,12 @@ Samsung | Galaxy Grand Prime VE | grandprimevelte | SM-G531F | tested
82
83
Samsung | Galaxy S III Neo | s3ve3g | GT-I9301I | tested
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.
185
-
186
-
1. Clone the main branch of this repository
187
-
2. Run `make poetry` and `make install` to install poetry to manage python and install the required dependencies like adb, fastboot and heimdall.
188
-
3. Run `make app` to start the desktop app from the source.
186
+
And more to come!
189
187
190
188
191
189
## Contributing
@@ -199,62 +197,17 @@ All kinds of contributions are welcome. These include:
199
197
- Add features and/or improve the code base.
200
198
- Report bugs.
201
199
202
-
More details on how to contribute can be found [here](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/CONTRIBUTING.md).
203
-
Please have a look before opening an issue or starting to contribute.
204
-
205
-
A detailed list can be found [here](https://openandroidinstaller.org/#contribute).
206
-
207
-
### How to contribute your own installation configurations
208
-
209
-
If you want to use the tool for a non-supported smartphone, the fastest way is to adapt an [existing config file](https://github.com/openandroidinstaller-dev/openandroidinstaller/tree/main/openandroidinstaller/assets/configs). The file should be named after the official `device code` of the device. Add the code output by `adb shell getprop | grep ro.product.device` (when the devices is connected to the computer) as well as the official device code to the `supported_device_codes` list in the config. You can also get the device code by connecting the device to the computer and run OpenAndroidInstaller to detect the device.
200
+
[How to contribute your own installation configurations](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/docs/how_to_contribute_your_own_installation_configurations.md)
210
201
211
-
**To test your config file with the executable** without using the developer setup, place it in the same directory as the executable. There it will be detected by name. After you created a config file and it works fine, you can open a pull request to make the file available to other users. Please also add the device to the supported devices table above.
202
+
[How to build the application for your platform](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/docs/building_the_application_for_your_platform.md)
212
203
213
-
#### Content of a config file
204
+
[On unlocking the bootloader](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/docs/unlocking_the_bootloader.md)
214
205
215
-
A config file consists of two parts. The first part are some metadata about the device and the second parts are the steps to unlock the bootloader, boot a recovery and install the ROMs.
216
-
217
-
##### How to write Metadata
218
-
Every config file should have `metadata` with the following fields:
219
-
-`maintainer`: str; Maintainer and author of the config file.
220
-
-`device_name`: str; Name of the device.
221
-
-`is_ab_device`: bool; A boolean to determine if the device is a/b-partitioned or not.
222
-
-`device_code`: str; The official device code.
223
-
-`supported_device_codes`: List[str]; A list of supported device codes for the config. The config will be loaded based on this field.
224
-
-`twrp-link`: [OPTIONAL] str; name of the corresponding twrp page.
225
-
226
-
In addition to these metadata, every config can have optional `requirements`. If these are set, the user is asked to check if they are meet.
227
-
-`android`: [OPTIONAL] int|str; Android version to install prior to installing a custom ROM.
228
-
-`firmware`: [OPTIONAL] str; specific firmware version to install before installing a custom ROM.
229
-
230
-
##### How to write steps:
231
-
Every step in the config file corresponds to one view in the application. These steps should contain the following fields:
232
-
-`type`: str; Corresponds to the type of view to generate. There are the following options:
233
-
-`text`: Just display the text given in content.
234
-
-`confirm_button`: Display the content, as well as a button to allow the user to go to the next step.
235
-
-`call_button`: Display the content text and a button that runs a given command. After the command is run, a confirm button is displayed to allow the user to move to the next step.
236
-
-`call_button_with_input`: Display the content text, an input field and a button that runs a given command. The inputtext, can be used in the command by using the `<inputtext>` placeholder in the command field. After the command is run, a confirm button is displayed to allow the user to move to the next step.
237
-
-`link_button_with_confirm`: Display a button that opens a browser with a given link, confirm afterwards. Link is given in `link`.
238
-
-`img`: [OPTIONAL] Display an image on the left pane of the step view. Images are loaded from `openandroidinstaller/assets/imgs/`.
239
-
-`content`: str; The content text displayed alongside the action of the step. Used to inform the user about what's going on. For consistency and better readability the text should be moved into the next line using `>`.
240
-
-`link`: [OPTIONAL] Link to use for the link button if type is `link_button_with_confirm`.
241
-
-`command`: [ONLY for call_button* steps] str; The command to run. One of `adb_reboot`, `adb_reboot_bootloader`, `adb_reboot_download`, `adb_sideload`, `adb_twrp_wipe_and_install`, `adb_twrp_copy_partitions`, `fastboot_boot_recovery`, `fastboot_unlock_with_code`, `fastboot_unlock`, `fastboot_oem_unlock`, `fastboot_get_unlock_data`, `fastboot_reboot`, `heimdall_flash_recovery`.
242
-
-`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.
243
-
244
-
**Please try to retain this order of these fields in your config to ensure consistency.**
245
-
246
-
## How to build the application for your platform
247
-
248
-
The executables for the OpenAndroidInstaller are build with [pyinstaller](https://pyinstaller.org/en/stable/index.html). You can create builds for MacOS or Linux with `make build-app`. For Windows the paths need to be modified. For now, you can have a look [here](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/v0.1.2-alpha/.github/workflows/manual-build-windows.yml#L22) on how it's done.
249
-
250
-
If you build the application for your platform and want to contribute the build, please reach out to me.
251
-
252
-
#### On unlocking the bootloader
253
-
Devices by *Samsung*, *Google* and *Fairphone* make it fairly easy to unlock the bootloader and receive good support in the installer.
206
+
More details on how to contribute can be found [here](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/main/CONTRIBUTING.md).
207
+
Please have a look before opening an issue or starting to contribute.
254
208
255
-
Some devices with require manual steps to unlock the bootloader. In general you will need to create an account at a vendor website and receive some code from there. OpenAndroidInstaller will try to guide you as far as possible. These vendors include *Sony, Motorola, Xiaomi* and *OnePlus* among others.
209
+
A detailed list can be found [here](https://openandroidinstaller.org/#contribute).
256
210
257
-
Other phone vendors stops allowing to unlock the bootloader all together. There is nothing to be done if you didn't unlock your device in time. These vendors include *Huawei and LG* among others. Support for these vendors will always be very limited.
The executables for the OpenAndroidInstaller are build with [pyinstaller](https://pyinstaller.org/en/stable/index.html). You can create builds for MacOS or Linux with `make build-app`. For Windows the paths need to be modified. For now, you can have a look [here](https://github.com/openandroidinstaller-dev/openandroidinstaller/blob/v0.1.2-alpha/.github/workflows/manual-build-windows.yml#L22) on how it's done.
4
+
5
+
If you build the application for your platform and want to contribute the build, please reach out to me.
6
+
7
+
## Run OpenAndroidInstaller for development
8
+
9
+
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.
10
+
11
+
1. Clone the main branch of this repository
12
+
2. Run `make poetry` and `make install` to install poetry to manage python and install the required dependencies like adb, fastboot and heimdall.
13
+
3. Run `make app` to start the desktop app from the source.
0 commit comments