Back to the overviewInstall OkcarOS on
jason
Installing a custom recovery using
Install OkcarOS on
Xiaomi Mi Note 3
jason
WARNING: The provided instructions are for OkcarOS 18.1. These will only work if you follow every section and step precisely.
Do not continue after something fails!
Do not continue after something fails!
Basic requirements
- Read through the instructions at least once before actually following them, so as to avoid any problems due to any missed steps!
- Make sure your computer has
adb
andfastboot
. Setup instructions can be found here. - Enable USB debugging on your device.
- Boot your device with the stock OS at least once and check every functionality.
WARNING: Make sure that you can send and receive SMS and place and receive calls (also via WiFi and LTE, if available), otherwise it won’t work on OkcarOS either! Additionally, some devices require that VoLTE/VoWiFi be utilized once on stock to provision IMS.
- LineageOS is provided as-is with no warranty. While we attempt to verify everything works you are installing this at your own risk!
Unlocking the bootloader
NOTE: The steps below only need to be run once per device. They require a machine running Windows 7 or newer.
WARNING: Unlocking the bootloader will erase all data on your device! 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 OkcarOS once installed.
- 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 tappingMIUI Version
. - Link the device to your Mi account in
Settings
>Additional settings
>Developer options
>Mi Unlock status
. - Download the Mi Unlock app (Windows is required to run the app).
- Run the Mi Unlock app and follow the instructions provided by the app. It may tell you that you have to wait up to 30 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.
Installing a custom recovery using fastboot
- Download a custom recovery - you can download TWRP. Simply download the latest recovery file, named something like
twrp-x.x.x-x-jason.img
and rename it torecovery.img
.Important: Other recoveries may not work for installation or updates. We strongly recommend to use the one linked above! - Connect your device to your PC via USB if it isn’t already.
- If your device isn’t already in fastboot mode, on the computer, open a command prompt (on Windows) or terminal (on Linux or macOS) window, and type:
adb -d reboot bootloader
You can also boot into fastboot mode via a key combination:
- With the device powered off, hold Volume Down + Power. Keep holding both buttons until the word “FASTBOOT” appears on the screen, then release.
- Once the device is in fastboot mode, verify your PC finds it by typing:
fastboot devices
If you don’t get any output or an error:
- on Windows: make sure the device appears in the device manager without a triangle. Try other drivers until the command above works!
- on Linux or macOS: If you see
no permissions fastboot
try runningfastboot
as root. When the output is empty, check your USB cable (preferably use a USB Type-A 2.0 one or a USB hub) and port!
Tip: Some devices have buggy USB support while in bootloader mode, if you seefastboot
hanging with no output when using commands such asfastboot getvar ...
,fastboot boot ...
,fastboot flash ...
you may want to try a different USB port (preferably a USB Type-A 2.0 one) or a USB hub. - Flash recovery onto your device:
fastboot flash recovery recovery.img
- Now reboot into recovery to verify the installation.
Do not reboot into the existing OS, since it will overwrite the recovery you just installed!
-
With the device powered off, hold Volume Up + Power. Keep holding both buttons until the “MI” logo appears on the screen, then release.
NOTE: If you can’t power down the device, try long-pressing the key-combination (if any was used in the instructions above) until the device reboots and follow the instructions above
-
Installing OkcarOS from recovery
- Build a OkcarOS installation package.
- (Optionally): If you want to install Google Apps add-on package (use the
arm64
architecture), you can download it from here.
- (Optionally): If you want to install Google Apps add-on package (use the
- If you are not in recovery, reboot into recovery:
- With the device powered off, hold Volume Up + Power. Keep holding both buttons until the “MI” logo appears on the screen, then release.
- Now tap Wipe.
- Now tap Format Data and continue with the formatting process. This will remove encryption and delete all files stored in the internal storage.
- Return to the previous menu and tap Advanced Wipe, then select the Cache and System partitions and then Swipe to Wipe.
- Sideload the OkcarOS
.zip
package:- On the device, select “Advanced”, “ADB Sideload”, then swipe to begin sideload.
- On the host machine, sideload the package using:
adb -d sideload filename.zip
.Tip: Normally, adb will reportTotal xfer: 1.00x
, but in some cases, even if the process succeeds the output will stop at 47% and reportadb: failed to read command: Success
. In some cases it will reportadb: failed to read command: No error
oradb: failed to read command: Undefined error: 0
which is also fine.
Installing Add-Ons
NOTE: If you don’t want to install any add-on (such as Google Apps), you can skip this whole section!
WARNING: If you want the Google Apps add-on on your device, you must follow this step before booting into OkcarOS for the first time!
- Repeat the sideload steps above for all desired packages in sequence.
All set!
Once you have installed everything successfully, you can now reboot your device into the OS for the first time!
- Run
adb -d reboot
.
NOTE:
The first boot usually takes no longer than 15 minutes, depending on the device.
If it takes longer, you may have missed a step, otherwise feel free to get assistance.
WARNING: Depending on which recovery you use, you may be prompted to install additional apps and services.
We strongly advise you to opt out of installing these, as they may cause your device to bootloop,
as well as attempt to access or corrupt your data.
Get assistance
After you’ve double checked that you followed the steps precisely, didn’t skip any and still have questions or got stuck, feel free to ask on our subreddit or in #OkcarOS on Libera.Chat.