🎯 This guide will help you install and use FolkPatch from scratch, easy even for beginners!

🔍 Basic Knowledge

What is FolkPatch?

FolkPatch is a fork of APatch, focusing on optimizing interface design and function expansion, without introducing new core functions.

🛠️ Preparation

• A phone with unlocked Bootloader
• A computer with ADB tools
• Your phone kernel supports KernelPatch

📱 Check Device Compatibility

Supported Device Types

✅ Supported Devices:

• ARM64 architecture (Most Android phones in recent years)
• Android kernel version 3.18 - 6.6

❌ Unsupported Devices:

• Non-ARM64 architecture devices (some old tablets)
• Kernel version lower than 3.18 or higher than 6.6

How to Check Kernel Version?

1. Method 1: Phone Settings

   • Settings → About Phone → Software Information → Kernel Version

2. Method 2: Use ADB Command

   adb shell uname -r

How to Check Kernel Configuration (Root Required)

If your phone is already Rooted, you can use the following command to check the kernel configuration:

zcat /proc/config.gz | grep CONFIG_KALLSYMS

Should display:

CONFIG_KALLSYMS=y
CONFIG_KALLSYMS_ALL=y

Or

CONFIG_KALLSYMS=y
CONFIG_KALLSYMS_ALL=n

Hint

If either of the above configurations is displayed, your device supports FolkPatch.

---

📁 Get Necessary Files

Get Boot Image

1. From Official Firmware Package

   • Download the official firmware corresponding to your phone model
   • Unzip and find the boot.img file
   • Copy to computer for backup

2. Extract from Current Device

   # Requires ADB permission
   adb pull /dev/block/by-name/boot ./boot.img

Backup Boot Image

Important

Be sure to backup the original boot.img image!

This file is an important guarantee for restoring the system. If there is a problem such as failure to boot, you need it to repair the phone!

---

🚀 Install FolkPatch

Method 1: Official Tool One-Click Flash (Highly Recommended)

This is currently the most convenient installation method. The official FolkTool supports one-click flashing without complex operations.

For detailed tutorial, please refer to: FolkTool Usage Guide

1. Download Tool: Visit FolkTool Release Page to download the latest version of the tool.
2. Connect Device: Ensure your phone has USB debugging enabled and is connected to the computer.
3. One-Click Flash: Run the tool and follow the interface instructions to automatically complete the flashing.

Method 2: Automatic Patching (Recommended for Beginners)

This is the simplest and safest method, suitable for most users.

Step 1: Install FolkPatch Manager

1. Download and install FolkPatch Manager APK on your phone
2. Allow "Install apps from unknown sources"

Step 2: Patch Boot Image

1. Open FolkPatch Manager
2. Click the patch button in the upper right corner 🛠️
3. Select "Select a boot image and patch"
4. Find and select the boot.img file you prepared

Use Local Patch File (KPimg)

On the install page, under the KernelPatch Patch/Install menu, there is a "Use local patch file (KPimg)" option. Tap it to select a custom kpimg-android file for patching. The rest of the process is the same as normal patching.

This is useful when you need to patch with a specific version of KernelPatch. The kpimg-android file must be downloaded manually from the KernelPatch Releases page. FolkPatch does not include this file by default.

Step 3: Set Superkey

1. Set a password in the "Superkey" card
2. This will be your password to get Root permission, please remember it!
3. ⚠️ Weak passwords are prohibited (such as 12345678), the system will require a complex password

注意

Please be sure to remember your Superkey, which ensures your control over Root permissions.

Step 4: Finish Patching

1. Click "Start Patching" and wait for completion
2. After successful patching, the path of the patched image will be displayed, for example: /storage/emulated/0/Download/folkpatch_xxxx.img

Continue reading the "Flash Image" section below to complete the installation.

Method 3: Manual Patching (For Advanced Users)

When KernelPatch is updated but the manager is not yet updated, you can use this method.

Step 1: Download Tools

1. Visit KernelPatch Release Page
2. Download the following files:
   • kptools-win.zip (Windows users) or kptools-linux (Linux users)
   • kpimg-android
   • magiskboot (corresponding system version)

Step 2: Unpack Boot Image

# Windows Users
magiskboot.exe unpack boot.img

# Linux Users
./magiskboot unpack boot.img

Step 3: Patch Kernel

# Windows Users
kptools-x86_64-win.exe -p --image kernel-b --skey "YourKey" --kpimg kpimg-android --out kernel

# Linux Users
./kptools-linux -p --image kernel-b --skey "YourKey" --kpimg kpimg-android --out kernel

Step 4: Repack

# Windows Users
magiskboot.exe repack boot.img

# Linux Users
./magiskboot repack boot.img

After completion, you will get a file named new-boot.img, which is the patched image.

Alternative

You can also use the Online Patching Tool, just upload the Boot image to automatically complete the patching.

Method 4: Direct Flashing (Via Recovery)

The latest version of FolkPatch supports one-click flashing from third-party Recoveries like TWRP.

Note

This feature was introduced in version 11142. Earlier versions do not support this method.

Step 1: Rename Installation Package

Rename the downloaded FolkPatch installation package (.apk) extension to .zip, for example:

FolkPatch-11142-release.apk → FolkPatch-11142-release.zip

Step 2: Flash via Recovery

1. Boot your phone into third-party Recovery (such as TWRP)
2. Select "Install" function
3. Browse and select the renamed .zip file
4. Swipe to confirm flashing and wait for completion

Tip

The adb sideload method used by third-party AOSP ROM Recoveries (e.g., LineageOS) is also supported.

Important Warning

Direct flashing does NOT use a fixed superkey!

After flashing with this method, the superkey will be a random combination of numbers and letters, which will be displayed during the patching process. Please make sure to write down this key!

If you need to customize your own superkey, please manually enter FolkPatch Manager after booting and re-patch to set your own superkey.

---

📲 Flash Image (For Method 2 and Method 3)

Preparation

1. Ensure USB debugging is enabled on the phone
2. Copy the patched image to the computer
3. Connect phone and computer

Start Flashing

Step 1: Enter Fastboot Mode

adb reboot bootloader

Step 2: Flash Patched Image

# Replace PATH/TO/boot.img with the actual path of your patched image
fastboot flash boot PATH/TO/boot.img

Step 3: Reboot Device

fastboot reboot

Tip

If you are not sure if the flashing is successful, you can first use the following command to boot temporarily:

fastboot boot PATH/TO/boot.img

This way, if the system cannot start normally, just restart the phone to restore the original state.

---

✅ Post-Install Operations

Verify Root Permission

1. Install Root permission detection app (such as Root Checker)
2. Open the app and check if "Root permission obtained" is displayed

Use Root Apps

1. Open an app that requires Root permission
2. FolkPatch will pop up a permission request
3. Select "Allow" and enter your Superkey

Install Module Support

1. Open FolkPatch Manager
2. Enter "Modules" page
3. You can download and install various functional modules

Use Module Scripts

Many modules contain scripts that run automatically, which can perform specific tasks when the system starts:

• service.sh - Executed late in system boot, suitable for most scenarios
• post-fs-data.sh - Executed after file system mount (blocking, use with caution)
• boot-completed.sh - Executed after system boot is complete

How to view and manage scripts:

1. View Scripts: Enter the module details page, click "Browse Module Files"
2. Execute Action: If the module supports it, click the "Execute Action" button to run specific scripts
3. View Logs: Script logs are usually saved in the /data/local/tmp/ directory

Learn more:

• 📥 Script Import Tutorial(Open in new window) - How to import custom scripts
• ⚙️ Script Management Guide(Open in new window) - Complete guide to managing scripts
• 💡 Script Examples(Open in new window) - Common script example code

---

🗑️ Uninstall FolkPatch

Method 1: Uninstall using FolkPatch Manager

1. Download the FolkPatch installation package identical to your current version
2. Rename the file, add -uninstall, for example: FolkPatch-10888-release.apk → FolkPatch-10888-release-uninstall.zip
3. Transfer the file to the phone and flash it via Recovery

提示

Similarly, like installation, uninstallation also supports using adb sideload.

Method 2: Manually Flash Back Original Boot Image

1. Put the phone into Fastboot mode:

   adb reboot bootloader

2. Flash back your previously backed up original Boot image:

   fastboot flash boot PATH/TO/original_boot.img

3. Reboot phone:

   fastboot reboot

Important Reminder

Never flash the init_boot file, it will only cause the system to fail to boot!

---

🎉 Complete

Congratulations! You have successfully installed FolkPatch. Now you can freely explore more possibilities of the Android system!

Remember to abide by the principle of "Safe Flashing":

• Only install apps and modules from reliable sources
• Regularly backup important data
• Do not modify critical system files at will

Enjoy your Root journey! 🚀

Some materials cited from APatch Documentation

Copyright

Copyright Ownership:FolkPatch Team

License under:Attribution 4.0 International (CC-BY-4.0)

Edit this page

Contributors: Matsuzaka Yuki, matsuzaka-yuki

Previous pageIntroduction

Next pageOne-Click Flash