commit	f94fdb263660f13f4ed24986d27e357281e0e46e	[log] [tgz]
author	Pete Fotheringham <petefoth@e.email>	Sun May 26 09:57:40 2024 +0100
committer	GitHub <noreply@github.com>	Sun May 26 09:57:40 2024 +0100
tree	f8f48d0b3af2e71aabdf8441edb2d362c87a31d3
parent	b8f6d866a479750207704a0487ad7337b16866de [diff]

tree: f8f48d0b3af2e71aabdf8441edb2d362c87a31d3

README.md

microG Mobile Services

This is a collection of FOSS APKs, coupled with the respective Makefiles for an easy integration in the Android build system.

To include them in your build, add a repo manifest file to include this repository as vendor/partner_gms and set WITH_GMS to true when building.

Example manifest:

<?xml version="1.0" encoding="UTF-8"?>
<manifest>
    <project path="vendor/partner_gms" name="lineageos4microg/android_vendor_partner_gms" remote="github" revision="master" />
</manifest>

Note 1. You do not need to set CUSTOM_PACKAGES for the packages to be included when building with our Docker engine.

Note 2. LineageOS now support restricted signature spoofing, so it is no longer neccessary to pacth their sources, unless you want unrestricted signature spoofing ~~For the microG packages to work, signature spoofing must be enabled, by patching the LineageOS sources before building.~~

If you are building with our Docker engine, this is done automatically according to the values of the SIGNATURE_SPOOFING variable - see here. By default, this variable is set to restricted, allowing only system apps (those built-in to the ROM) to 'spoof' the signature of another app.
If you are building manually, you can download and include the patches from here. If you follow the microG patching instructions, you ROM will allow any app, not only system apps, to spoof app signatures. To apply only 'restricted' signature spoofing, you should do something similar to what the Docker engine build.sh does in this code.

Note 3. If you encounter problems related to APK / app signing when using these components you may need to add the following line in the Android.mk for the component in question:

LOCAL_REPLACE_PREBUILT_APK_INSTALLED := $(LOCAL_PATH)/$(LOCAL_MODULE).apk

Such problems can occur when

the app / APK is resigned with your keys; (this should not happen if the line LOCAL_CERTIFICATE := PRESIGNED is included in the app makefile)
app / APK signatures are 'stripped` during the during the deodexing phase of the build. For some apps the deodexed app ends up unsigned, and so will not run.

The symptoms of the problem as some apps from this repo (e.g. FakeStore and GmsCore) missing completely from your launcher and acting like they're not installed.

(Some background to this issue can be found here and here)

The included APKs are:

FDroid packages (binaries sourced from here and here)
- FDroid: a catalogue of FOSS (Free and Open Source Software) applications for the Android platform
- FDroid Privileged Extension: a FDroid extension to ease the installation/removal of apps
- additional_repos.xml: a simple package to include the microG FDroid repository in the ROM (requires FDroid >= 1.5)
microG packages (binaries sourced from here)
- GmsCore: the main component of microG, a FOSS reimplementation of the Google Play Services (requires GsfProxy and FakeStore for full functionality)
- GsfProxy: a GmsCore proxy for legacy GCM compatibility
- FakeStore: an empty package that mocks the existence of the Google Play Store
- IchnaeaNlpBackend: Network location provider using Mozilla Location Service
- NominatimGeocoderBackend: Geocoder backend that uses OSM Nominatim service.

These are official unmodified prebuilt binaries, signed by the corresponding developers.