====== Installing & Configuring microG on a Compatible Custom ROM ======
**READ BEFORE STARTING — COMPATIBILITY & SUPPORT NOTICE**
* **Does NOT work on Stock Android:** You cannot install microG on standard factory firmware (Samsung One UI, Google Pixel Stock, Motorola, etc.) because stock Android blocks **Signature Spoofing**. The device must already be running a custom ROM with native signature spoofing support (such as official LineageOS 21+, crDroid, or CalyxOS).
* **No OS Flashing Covered Here:** This guide assumes the custom ROM is already installed and booting normally. For unlocking bootloaders or flashing a custom ROM, refer strictly to the ROM's official device wiki (e.g., [[https://wiki.lineageos.org|LineageOS Wiki]]).
* **Unofficial Community Guide:** ChYK (Total_Apps) does not provide technical support for modified operating systems or microG. For help, visit the **Total Launcher - a uiTLM community** Discord or **r/uiTotalLauncher**.
-----
===== 1. How Total Launcher Works with microG =====
Total Launcher is split into two separate packages:
- **Total Launcher** (''com.ss.launcher2'') — The core free launcher application. It runs normally without Google Play Services or microG.
- **Total Launcher Key** (''com.ss.launcher2.key'') — The separate license unlocker app that enables Pro features.
When running on a de-Googled custom ROM, **microG** provides an open-source re-implementation of Google Play Services so apps that check for Google frameworks or Google account sign-in can function without proprietary Google bloatware.
**Important Note on Total Launcher Key:**
Total Launcher verifies Pro status by checking for the installed **Total Launcher Key** app and validating its license. Because uiTLM only endorses official distribution channels, you must obtain Total Launcher and Total Launcher Key through official sources (such as Google Play on a licensed profile, or an official direct distribution channel if provided by the developer).
-----
===== 2. Prerequisites =====
Before beginning, confirm that the following are in place:
- A device running a custom ROM with **Signature Spoofing** enabled/supported.
- **F-Droid** installed on your device (downloadable directly from [[https://f-droid.org|f-droid.org]]).
- An active internet connection.
-----
===== 3. Add the Official microG Repository to F-Droid =====
microG is distributed through its own official F-Droid repository rather than the default F-Droid catalog.
- Open the **F-Droid** app on your device.
- Tap **Settings** (the gear icon in the bottom navigation bar).
- Under the **My Apps** section, tap **Repositories**.
- Tap the **+** (Add repository) button in the top-right corner.
- Enter the official microG repository address carefully:
* **Repository address:** ''https://microg.org/fdroid/repo''
- Tap **Add**.
- Return to the main **Categories** or **Latest** tab and pull down on the screen to refresh the repositories until F-Droid finishes updating its index.
-----
===== 4. Install the Core microG Packages =====
Once F-Droid finishes updating the repository index, search for and install the following packages:
- **microG Services** (package ID: ''com.google.android.gms'') — *Provides the core Play Services framework, account authentication, and location/cloud messaging APIs.*
- **microG Companion** (package ID: ''com.android.vending'' — *formerly named FakeStore*) — *Provides the Play Store framework stub required by Android to route license verification requests to microG.*
- **microG Services Framework Proxy** (package ID: ''com.google.android.gsf'') — *Install only if required by your specific ROM version; newer microG releases bundle most proxy functions directly into microG Services.*
**Reboot Recommended:** After installing **microG Services** and **microG Companion**, reboot the device once before configuring permissions so Android registers the new system-level service providers cleanly.
-----
===== 5. Grant Permissions & Verify via microG Self-Check =====
After rebooting, open the **microG Settings** app from the app drawer (if hidden on the ROM, open **Android Settings → Apps → See all apps → microG Services → App details / Open**).
- Inside **microG Settings**, tap **Self-Check** at the top of the menu.
- Review every checklist item under **System**, **Signature spoofing support**, and **Permissions granted**:
* **System supports signature spoofing:** Must be checked. If unchecked, verify that signature spoofing is enabled in the custom ROM's settings or that the ROM supports it.
* **Play Services (GmsCore) has correct signature:** Must be checked.
* **Play Store (Phonesky) has correct signature:** Must be checked (this verifies **microG Companion**).
- Tap any unchecked permission rows directly inside **Self-Check** (such as **Location**, **SMS**, **Phone**, or **Battery optimization ignored**) and tap **Allow** when Android prompts you.
- Ensure **Battery optimization ignored** is checked so Android does not kill microG background license or push checks.
-----
===== 6. Optional: Sign In to Your Google Account =====
If validation of an existing Google Play license or sync account-dependent services is needed:
- Open **microG Settings**.
- Tap **Account** (or **Google Accounts**).
- Tap **Sign in** and follow the on-screen login prompts.
- Return to the main **microG Settings** screen and toggle on **Google device registration** if you use push notifications (Cloud Messaging) or Play licensing checks.
-----
===== 7. Final Check in Total Launcher =====
- Open **Total Launcher** (''com.ss.launcher2'').
- Long-press an empty area on the home screen to enter edit mode, or open **Launcher Options** (the menu icon).
- Confirm that Pro options are unlocked and accessible without license warning pop-ups.
- If **Tasker**, **MacroDroid**, or **Shizuku** is used alongside Total Launcher, verify their battery optimizations are also set to **Unrestricted** in Android's **App info → App battery usage** screen.