This is a very beginner friendly tutorial on how to build a Custom ROM for your device. For this tutorial, I will be taking LineageOS ROM for OnePlus 7 as an example.
- Your device with USB cable (OnePlus 7 for example)
- x64-bit powerful Linux PC or server. Recommended: 4 cores - 8 threads or more with 64GB RAM, (32GB RAM + 16GB or more ZRAM should also do the job). Just 32GB RAM for Android 14 onwards will lead to the build being killed. Storage of 350GB or more. I will be considering Ubuntu to build in this tutorial.
- Unlimited internet connection
- Basic Git and GitHub knowledge. You will need some advanced knowledge too which you can learn along with time.
Download the platform-tools for Linux from here by using the terminal.
cd ~/
wget https://dl.google.com/android/repository/platform-tools-latest-linux.zipUse this command to unzip it:
unzip platform-tools-latest-linux.zip -d ~Now you have to add adb and fastboot to your PATH. In the same terminal enter this:
cd ~/
nano ~/.profileJust enter the following text at the bottom of the file that opens up, save it and close.
# add Android SDK platform tools to path
if [ -d "$HOME/platform-tools" ] ; then
PATH="$HOME/platform-tools:$PATH"
fiKey combination to save file and exit in nano editor is: (Ctrl + O) + (Enter) + (Ctrl + X). Then, run this to update your environment.
source ~/.profileSeveral packages are needed to build a Custom ROM and all those can be installed easily by using Akhil Narang's scripts. Run this:
cd ~/
git clone https://github.com/akhilnarang/scripts
cd scripts
./setup/android_build_env.shYou’ll need to set up some directories in your build environment To create them:
mkdir -p ~/bin
mkdir -p ~/androidThe ~/bin directory will contain the git-repo tool (commonly named “repo”) and the ~/android directory will contain the source code of the Custom ROM
Enter the following to download the repo binary and make it executable (runnable):
curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
chmod a+x ~/bin/repoGiven that repo requires you to identify yourself to sync Android, run the following commands to configure your git identity:
git config --global user.email "[email protected]"
git config --global user.name "Your Name"Get into the android directory that we created and initialize the branch of repo that you wish to build. You can find the link to initialize the repo in the manifest of the particular ROM. As I am considering LineageOS ROM for example, you can look at their manifest from here. LineageOS calls this particular repo as "android" but for other ROMs it is usually called as "manifest". Just for reference you can look at the manifest of Pixel Experience from here.
cd ~/android
repo init -u https://github.com/LineageOS/android.git -b lineage-20.0 --git-lfsDownload the source code by this command:
repo sync -c -j$(nproc --all) --force-sync --no-clone-bundle --no-tagsNote that repo sync will take time depending on your internet connection.
To build a ROM for a specific device, we usually need three device trees i.e., device trees, kernel and vendor trees. For OnePlus 7 we have 2, 1 and 2 directories respectively in device trees, kernel and vendor tree. The number of directories might vary from device to device. You can easily find that by checking your device specific trees from Lineage OS GitHub (if available). Note that device codename for OnePlus 7 is guacamoleb. You need to clone all the directories below from GitHub into your source code. For OnePlus 7 the directories are:
- android/device/oneplus/guacamoleb
- android/device/oneplus/sm8150-common
Clone them to the respective directories. For example, clone "android_device_oneplus_guacamoleb" in "android/device/oneplus/guacamoleb" directory. The command for this example would be:
git clone https://github.com/LineageOS/android_device_oneplus_guacamoleb -b lineage-20 ~/android/device/oneplus/guacamolebClick the directories to see the trees that I use for my build. If you are adapting trees from Lineage OS for other custom ROMs, you need to make a few changes in the trees as in here. Refer other trees of your device to know what exact changes you need to make.
There might be other repositories required to build a ROM. For example in LineageOS 20 (Android 13) for OnePlus 7, couple of extra repositories are used, which are: android/hardware/oplus and a firmware reposiory which is linked here.
Next we can start building the ROM by using the following commands. These commands might be different for different ROMs. Check the ROM manifest for exact commands. The format for LineageOS is:
source build/envsetup.sh
breakfast device_codename
export USE_CCACHE=1
export CCACHE_EXEC=/usr/bin/ccache
ccache -M 50G
croot
brunch device_codename | tee log.txtAbove mentioned 3rd, 4th and 5th lines are only for first build. It will set ccache for building ROMs."50G" is to metion the amount of ccache you are allocating to build the ROM. 30 to 50 GB should be enough for building ROM for one device. ccache will increase the speed of building the ROM. For OnePlus 7 the following commands to be used for first build.
source build/envsetup.sh
breakfast guacamoleb
export USE_CCACHE=1
export CCACHE_EXEC=/usr/bin/ccache
ccache -M 50G
croot
brunch guacamoleb | tee log.txtFor second build onwards:
source build/envsetup.sh
breakfast guacamoleb
croot
brunch guacamoleb | tee log.txtNow the building time might vary depending on your raw PC power. First build usually takes long time. Second buid onwards, time will significantly get reduced. To clean build a ROM for later builds use this command after calling the "lunch" command:
make clobberFor a dirty build, use:
make installcleanDirty build is recommended for faster builds (unless no major change is done).