Skip to content

ekimiateam/openandroidinstaller

 
 

Repository files navigation

OpenAndroidInstaller

OpenAndroidInstaller

Makes installing alternative Android distributions nice and easy!

License Release Downloads Flathub Twitter Mastodon

The OpenAndroidInstaller project helps Android users to keep their smartphone's operating system up to date with free software and to continue using the device even though the manufacturer no longer offers updates. With a graphical installation software, users are easily guided through the installation process of free Android operating systems like LineageOS.

Website · Report Bugs · Request Feature

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.

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.

Usage

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.

1. Download OpenAndroidInstaller

Warning

ARM-based systems are not supported.

OpenAndroidInstaller support all three major operating systems, namely Linux, macOS and Windows. You can download the correct version for you system from the GitHub Releases.

The executables are compressed inside .zip files, so you'll have to extract them first (make sure you have extracting software installed). If you get prompted to, you'll have to adjust the permission of the executable to ensure its proper functionality.

If you run Windows, you might also need to install the Universal USB Drivers and other potentially drivers needed for your device.

For Linux, a Flatpak version is available in Flathub, org.openandroidinstaller.OpenAndroidInstaller.

2. Download the custom ROM, recovery image & optional add-ons

Here are the official links for:

3. Start OpenAndroidInstaller

After starting the app you will be prompted to plug your device into your computer and you will be given a step-by-step tutorial on how to install your new OS for your specific device.

Officially supported devices

Currently, the we support 86 devices by various vendors and working on adding more soon!

Support for these devices is provided as best effort, but things might still go wrong. Help to improve the tool by reporting any issues you might face.

Fairphone
Vendor Device Name CodeName Models Status
Fairphone Fairphone 2 FP2 tested
Fairphone Fairphone 3 FP3 tested
Fairphone Fairphone 4 FP4 tested
Google
Vendor Device Name CodeName Models Status
Google Pixel 2 walleye walleye tested
Google Pixel 2 XL taimen taimen tested
Google Pixel 3 blueline blueline tested
Google Pixel 3 XL crosshatch crosshatch tested
Google Pixel 3a sargo sargo tested
Google Pixel 3a XL bonito bonito tested
Google Pixel 4 flame flame tested
Google Pixel 4 XL coral coral tested
Google Pixel 4a sunfish sunfish tested
Google Pixel 5 redfin redfin tested
Google Pixel 5a barbet barbet tested
Motorola
Vendor Device Name CodeName Models Status
Motorola edge racer XT2063-2, XT2063-3 tested
Motorola moto g5 cedric XT1670, XT1671, XT1672, XT1675, XT1676, XT1677 tested
Motorola moto g6 plus evert XT1926-2, XT1926-3, XT1926-5, XT1926-6, XT1926-7, XT1926-8, XT1926-9 tested
Motorola moto g7 power ocean XT1955-1, XT1955-2, XT1955-4, XT1955-5, XT1955-7 tested
Motorola moto g 5G plus / one 5G nairo XT2075-3, XT2075-5 tested
Motorola moto g 5G / one 5G ace kiev XT2113-2, XT2113-3 tested
Motorola moto z griffin XT1650-3, XT1650-05 tested
OnePlus
Vendor Device Name CodeName Models Status
OnePlus One bacon A0001 tested
OnePlus 3/3T oneplus3 A3000, A3003, A3010 untested
OnePlus 5 cheeseburger A5000 tested
OnePlus 5T dumpling A5010 tested
OnePlus 6 enchilada A6000, A6003 tested
OnePlus 6T fajita A6010, A6013 tested
OnePlus 7 guacamoleb GM1900, GM1901, GM1903, GM1905 tested
OnePlus 7 Pro guacamole GM1910, GM1911, GM1913, GM1917 tested
OnePlus 7T hotdogb HD1900, HD1901, HD1903, HD1905 tested
OnePlus 7T Pro hotdog HD1910, HD1911, HD1913, HD1917 tested
OnePlus Nord avicii AC2001, AC2003 tested
OnePlus Nord N200 dre DE2117 tested
OnePlus 9 lemonade LE2110, LE2111, LE2113, LE2115 under development
Samsung
Vendor Device Name CodeName Models Status
Samsung Galaxy J7 2015 j7elte tested
Samsung Galaxy J7 Prime on7xelte untested
Samsung Galaxy A3 2017 a3y17lte SM-A320FL tested
Samsung Galaxy A5 2016 a5xelte SM-A510F tested
Samsung Galaxy A5 2017 a5y17lte tested
Samsung Galaxy A7 2016 a7xelte tested
Samsung Galaxy A7 2017 a7y17lte untested
Samsung Galaxy Grand Prime VE grandprimevelte SM-G531F tested
Samsung Galaxy S III Neo s3ve3g GT-I9301I tested
Samsung Galaxy Tab S2 gts210vewifi T813 tested
Samsung Galaxy S4 jfltexx untested
Samsung Galaxy S4 Mini LTE serranoltexx tested
Samsung Galaxy S5 klte G900F/M/R4/R7/T/V/W8 tested
Samsung Galaxy S5 mini kminilte SM-G800F/M/Y tested
Samsung Galaxy S6 zerofltexx tested
Samsung Galaxy S6 Edge zeroltexx tested
Samsung Galaxy S7 herolte SM-G930F tested
Samsung Galaxy S7 Edge hero2lte tested
Samsung Galaxy S8 dreamlte tested
Samsung Galaxy S9 starlte tested
Samsung Galaxy S10 beyond1lte tested
Samsung Galaxy S10e beyond0lte tested
Samsung Galaxy S10+ beyond2lte tested
Samsung Galaxy Note 3 LTE hltetmo N900T/V/W8 tested
Samsung Galaxy Note 8 greatlte SM-N950F tested
Samsung Galaxy Note 9 crownlte tested
Samsung Galaxy Note 10 d1 tested
Samsung Galaxy Note 10+ d2s tested
Sony
Vendor Device Name CodeName Models Status
Sony Xperia Z yuga C6603 tested
Sony Xperia Z3 z3 tested
Sony Xperia 10 kirin tested
Sony Xperia 10 Plus mermaid tested
Sony Xperia XA2 pioneer tested
Sony Xperia XZ2 akari tested
Sony Xperia XZ3 akatsuki tested
Sony Xperia XZ kagura planned
Xiaomi & Poco
Vendor Device Name CodeName Models Status
Xiaomi Redmi 7A / 8 / 8A / 8A Dual Mi439 : pine / olive / olivelite / olivewood tested
Xiaomi Redmi 9A / 9C / 9AT / 9i / 9A Sport / 10A / 10A Sport garden / dandelion / blossom / angelican tested
Xiaomi Redmi 9 / Poco M2 lancelot / galahad / shivan untested
Xiaomi Redmi Note 7 lavender tested
Xiaomi Redmi Note 8 / 8T ginkgo / willow untested
Xiaomi Redmi Note 8 Pro begonia untested
Xiaomi Redmi Note 9S / 9 Pro / 9 Pro Max / 10 Lite / Poco M2 pro miatoll : gram / curtana / excalibur / joyeuse untested
Xiaomi Redmi Note 10S / 11SE / Poco M5S rosemary / maltose / secret /rosemary_p untested
Xiaomi Mi A2 / Mi 6X jasmine_sprout untested
Xiaomi Mi 8 dipper untested
Xiaomi Mi 9T / Redmi K20 davinci / davinciin untested
Xiaomi Redmi K20 Pro / Mi 9T Pro raphael / raphaelin untested
Xiaomi Redmi Note 10 Pro sweet M2101K6G tested
Xiaomi Redmi K40 / Mi 11X / Poco F3 alioth / aliothin untested
Xiaomi Poco X3 / X3 NFC surya / karna untested
Xiaomi Poco X3 Pro vayu tested
Xiaomi 12 cupid untested

... and more to come!

Tutorials

Contributing

All kinds of contributions are welcome. These include and are not limited to:

  • Fixing and improving 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 improving the codebase
  • Reporting bugs

Make sure to check if your issue or PR has already been fixed or implemented before opening a new one!

More sources:

Acknowledgements

  • The project received financial support from the German Federal Ministry for Education and Research under the grant identifier 01IS22S26 from September 2022 until February 2023.

logos of the "Bundesministerium für Bildung und Forschung", Prodotype Fund and OKFN-Deutschland

Credits

  • The Android SDK Platform Tools (such as adb and fastboot) are Apache-licensed universal Android utilities
  • Heimdall is an MIT-licensed replacement for the leaked ODIN tool to flash Samsung devices.
  • libusb-1.0 is a LGPL-2.1-licensed library for USB device access from Linux, macOS, Windows and others.
  • copy-partitions-20220613-signed.zip The copy-partitions script was created by LineageOS developer erfanoabdi and filipepferraz and released under LGPL. (It's used when the partitions need to be copied before flashing)

License

Original development by Tobias Sterbak. Copyright (C) 2022-2024.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see gnu.org/licenses.

About

Makes installing alternative Android distributions nice and easy.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.4%
  • Makefile 0.6%