Deprecated - please see https://github.com/lin18-microG

How to build

General assumption is, that you are familiar with building ROMs and how to use git etc. The LineageOS build instructions (example: hotdog device) should provide you with needed additional informations.

Initialize the build tree

Create the directory, which should contain your build tree and 'cd' into it.

repo init -u https://github.com/LineageOS/android.git -b lineage-17.1 --groups=all,-notdefault,-darwin,-mips

Decide, what you want to do

The main purpose of this organization is to build the "hardened microG" variants for below listed devices:

• Sony Xperia Z1 compact (amami) XDA Thread amami
• OnePlus 3T (oneplus3) XDA Thread oneplus3
• OnePlus 7T Pro (hotdog) XDA Thread hotdog
• Motorola Moto G3 (osprey) XDA Thread osprey
• LG G5 international (h850) - no XDA thread

With the exception of the amami device, all other listed devices are officially supported by LineageOS, so if you are not interested in the "hardened microG" build variant for any other of above devices than the amami, you should simply stick to the official LineageOS builds and build instructions.

So you have two options:

1. You simply would like to build the "default LineageOS 17.1" for the amami device
2. You would like to build the "hardened microG" build variant for any of the above devices

Option 1 - build standard LineageOS 17.1 for the amami device

Continue as outlined below after having initialized the build tree

curl https://raw.githubusercontent.com/lin17-microG/local_manifests/lineage-17.1/setup_common.xml > .repo/local_manifests/setup_common.xml
curl https://raw.githubusercontent.com/lin17-microG/local_manifests/lineage-17.1/setup_sony.xml > .repo/local_manifests/setup_sony.xml
repo sync --no-tags

After the tree has been synch'ed, enter the below commands to build LineageOS 17.1 for the amami device:

source build/envsetup.sh
brunch amami

You can also follow the instructions given in below option 2 and execute ./switch_microG default to checkout the 'lineage-17.1' default branches.

Option 2 - build the "hardened microG" variant for any of the above listed devices

Of course, you can use the below instructions for ANY device, but if you would like to build for any other device, you have to first replicate the device-specific repositories of your device, such as device-config, kernel and vendor blobs. To do so, the local_manifests directory needs to be updated accordingly (I am not going to explain that part, there is plenty of info available).

Step 1 - Basic tree synchronization

cd .repo
git clone https://github.com/lin17-microG/local_manifests 
cd local_manifests 
git checkout lineage-17.1
cd ../.. 
repo sync --no-tags

Step 2 - Finalize tree setup

Copy and execute the scripts as shown below.

IMPORTANT: repo sync performs a checkout without branch (detached state). The below scripts perform a 'real' checkout and will create the branch to be checked out.

cp z_patches/croot-scripts/* .
./switch_microG.sh reference
./switch_microG.sh default
./switch_microG.sh microG
./switch_microG.sh hmalloc
./switch_microG.sh reference

Step 3 - Adapt your preferences

If you want to sign your build with your own signing keys, make sure that the directoty ~/.android-certs exists and contains your signing keys. You have in the 'root' of your build tree a collection of shell scripts of the type build_devicename.sh, e.g. build_hotdog.sh for the hotdog device. Edit the script of your choice to define your own ccache directory and (optionally) your build output directory (comment out, if you would like to use the default location out/ within your build tree).

Step 4 - Checkout the correct branches and build

• For the devices amami, h850, osprey and the android emulator, execute the checkout script as follows: ./switch_microG.sh microG.
• For the devices hotdog and oneplus3, do ./switch_microG.sh hmalloc
• To build without signing (to be more precise: sign with the publicly known test keys), execute ./build_*device*.sh test (e.g. ./build_hotdog.sh test)
• To build using your own signing key (which must be present in ~/.android-certs !), execute ./build_*device*.sh sign (e.g. ./build_hotdog.sh sign)
• To build the android emulator, execute ./build_emulator.sh test and to start it, execute ./start_emulator.sh

IMPORTANT: How to re-synch the build tree

Always execute ./switch_microG.sh reference, before you perform another repo sync to synchronize your tree. After having synchronized (you may have to perform a --force-sync, if further forks have been created), check whether the switch script has been updated in directory z_patches/croot-scripts and copy it into the 'root' of your build tree. Afterwards, switch to the specific build variant.