Skip to content

docs: Update install instructions to use kptools for unpack/repack operations and add ikconfig dump option.#349

Merged
AkinaLTS merged 1 commit intoAndroidPatch:mainfrom
Eric-Johnson-1:main
Mar 17, 2026
Merged

docs: Update install instructions to use kptools for unpack/repack operations and add ikconfig dump option.#349
AkinaLTS merged 1 commit intoAndroidPatch:mainfrom
Eric-Johnson-1:main

Conversation

@Eric-Johnson-1
Copy link
Contributor

@Eric-Johnson-1 Eric-Johnson-1 commented Mar 13, 2026

Summary

This PR updates the manual patching documentation across all 4 locales to reflect that magiskboot has been removed from KernelPatch releases and its boot image unpack/repack functionality has been integrated directly into kptools.

Motivation

Users following the current documentation would be unable to find magiskboot in the KernelPatch release assets, leading to confusion and failed manual patching attempts. The kptools binary now provides native unpack and repack subcommands, making magiskboot unnecessary.

Changes

Command Replacements

Windows (manual patching):

- 1. Download `kptools-win.zip`, `kpimg-android` and `magiskboot`. Extract them into the same directory for use.
+ 1. Download `kptools-msys2-win.7z` and `kpimg-android`. Extract them into the same directory for use.
- magiskboot.exe unpack boot.img
+ kptools.exe unpack boot.img
- kptools-x86_64-win.exe -p --image kernel-b --skey "YourKey" --kpimg kpimg-android --out kernel
+ kptools.exe -p --image kernel-b --skey "YourKey" --kpimg kpimg-android --out kernel
- magiskboot.exe repack boot.img
+ kptools.exe repack boot.img

Linux (manual patching):

- 1. Download `kptools-linux`, `kpimg-android` and `magiskboot`.
+ 1. Download `kptools-linux` and `kpimg-android`.
- magiskboot unpack boot.img
+ ./kptools-linux unpack boot.img
- magiskboot repack boot.img
+ ./kptools-linux repack boot.img
Help Output Updates

Added the new -f, --flag command and unpack/repack subcommand documentation to the kptools help output section:

   -d, --dump                       Dump kallsyms infomations of kernel image(-i).
+  -f, --flag                       Dump ikconfig infomations of kernel image(-i).
   -l, --list                       Print all patch informations of kernel image if (-i) specified.
                                    Print extra item informations if (-M) specified.
                                    Print KernelPatch image informations if (-k) specified.
+Unpack kernel: unpack <boot.img>
+Repack kernel: repack <boot.img>
 Options:
Files Modified
File Locale Changes
docs/install.md English Commands, download list, help output
docs/zh_CN/install.md 简体中文 Commands, download list
docs/ru/install.md Русский Commands, download list, help output
docs/pt_BR/install.md Português Commands, download list, help output

Note

The Chinese locale (zh_CN/install.md) does not include a kptools help output section, so only command and download list changes were applied there.

Verification

  • grep -ri "magiskboot" across entire project returns 0 results
  • grep -ri "kptools-x86_64" across entire project returns 0 results
  • grep -ri "kptools-win.zip" across entire project returns 0 results
  • All 4 locale files consistently use the updated command syntax
  • Help output matches the latest kptools --help output

Testing

Manual review recommended. Suggested verification steps:

  1. Confirm the new commands match the actual kptools --help output from the latest binary.
  2. Verify the extracted binary name from kptools-msys2-win.7z is indeed kptools.exe.
  3. Optionally, test the full manual patching workflow on both Windows and Linux using the updated instructions.

@AkinaLTS AkinaLTS merged commit 6452a92 into AndroidPatch:main Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants