Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AkinaLTS merged 1 commit into from
Mar 17, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,12 @@ You can go to [KernelPatch](https://github.com/bmax121/KernelPatch/releases) pro

#### Windows

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.

2. Execute this command:

```cmd
magiskboot.exe unpack boot.img
kptools.exe unpack boot.img
```

To unpack the `boot.img` to get the kernel file. Rename the kernel to **kernel-b**. (kernel-b can be any third-party kernel, but third-party kernels come with no guarantees and won't be supported).
Expand All @@ -99,7 +99,7 @@ Windows users can patch using `CMD` or `PowerShell`.
Execute this command to patch:

```cmd
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
```

Alternatively, it's recommended to use `WSL` with `Linux` for patching:
Expand All @@ -111,7 +111,7 @@ Alternatively, it's recommended to use `WSL` with `Linux` for patching:
If no errors were reported during patching, execute this command:

```cmd
magiskboot.exe repack boot.img
kptools.exe repack boot.img
```

To pack and generate the image. The generated `new-boot.img` is the patched image.
Expand All @@ -120,12 +120,12 @@ To pack and generate the image. The generated `new-boot.img` is the patched imag

#### Linux

1. Download `kptools-linux`, `kpimg-android` and `magiskboot`.
1. Download `kptools-linux` and `kpimg-android`.

2. Execute this command:

```sh
magiskboot unpack boot.img
./kptools-linux unpack boot.img
```

To unpack the `boot.img` to get the kernel file. Rename the kernel to **kernel-b** (Say again, kernel-b can be any third-party kernel, but third-party kernels come with no guarantees and won't be supported).
Expand All @@ -139,7 +139,7 @@ Execute this command to patch:
If no errors were reported during patching, execute this command:

```sh
magiskboot repack boot.img
./kptools-linux repack boot.img
```

To pack and generate the image. The generated `new-boot.img` is the patched image.
Expand All @@ -166,9 +166,12 @@ COMMAND:
-u, --unpatch Unpatch patched kernel image(-i).
-r, --reset-skey Reset superkey of patched image(-i).
-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:
-i, --image PATH Kernel image path.
-k, --kpimg PATH KernelPatch image path.
Expand Down
17 changes: 10 additions & 7 deletions docs/pt_BR/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,12 @@ Você pode ir até o projeto [KernelPatch](https://github.com/bmax121/KernelPatc

#### Windows

1. Baixe `kptools-win.zip`, `kpimg-android` e `magiskboot`. Extraia-os no mesmo diretório para o uso.
1. Baixe `kptools-msys2-win.7z` e `kpimg-android`. Extraia-os no mesmo diretório para o uso.

2. Execute este comando:

```cmd
magiskboot.exe unpack boot.img
kptools.exe unpack boot.img
```

Descompacte o `boot.img` para obter o arquivo do kernel. Renomeie o kernel para **kernel-b**. (O kernel-b pode ser outro kernel de terceiros, mas os kernels de terceiros não possuem garantias e não serão suportados).
Expand All @@ -99,7 +99,7 @@ Usuários do Windows podem fazer o patch usando `CMD` ou `PowerShell`.
Execute este comando para corrigir:

```cmd
kptools-x86_64-win.exe -p --image kernel-b --skey "SuaChave" --kpimg kpimg-android --out kernel
kptools.exe -p --image kernel-b --skey "SuaChave" --kpimg kpimg-android --out kernel
```

Alternativamente, é recomendado usar `WSL` com `Linux` para o patch:
Expand All @@ -111,7 +111,7 @@ Alternativamente, é recomendado usar `WSL` com `Linux` para o patch:
Se nenhum erro for relatado durante o patch, execute este comando:

```cmd
magiskboot.exe repack boot.img
kptools.exe repack boot.img
```

Empacote e gere a imagem. O `new-boot.img` gerado é a imagem corrigida.
Expand All @@ -120,12 +120,12 @@ Empacote e gere a imagem. O `new-boot.img` gerado é a imagem corrigida.

#### Linux

1. Baixe `kptools-linux`, `kpimg-android` e `magiskboot`.
1. Baixe `kptools-linux` e `kpimg-android`.

2. Execute este comando:

```sh
magiskboot unpack boot.img
./kptools-linux unpack boot.img
```

Descompacte o `boot.img` para obter o arquivo do kernel. Renomeie o kernel para **kernel-b**. (Novamente, o kernel-b pode ser outro kernel de terceiros, mas os kernels de terceiros não possuem garantias e não serão suportados).
Expand All @@ -139,7 +139,7 @@ Execute este comando para corrigir:
Se nenhum erro for relatado durante o patch, execute este comando:

```sh
magiskboot repack boot.img
./kptools-linux repack boot.img
```

Empacote e gere a imagem. O `new-boot.img` gerado é a imagem corrigida.
Expand All @@ -166,9 +166,12 @@ COMANDOS:
-u, --unpatch Desfazer patch na imagem do kernel(-i).
-r, --reset-skey Redefinir SuperKey da imagem do patch(-i).
-d, --dump Despejar informações do kallsyms da imagem do kernel(-i).
-f, --flag Despejar informações do ikconfig da imagem do kernel(-i).
-l, --list Imprimir todas as informações do patch da imagem do kernel se (-i) for especificado.
Imprimir informações extras do item se (-M) for especificado.
Imprimir informações da imagem do KernelPatch se (-k) for especificado.
Descompactar kernel: unpack <boot.img>
Reempacotar kernel: repack <boot.img>
OPÇÕES:
-i, --image PATH Caminho da imagem do kernel.
-k, --kpimg PATH Caminho da imagem do KernelPatch.
Expand Down
17 changes: 10 additions & 7 deletions docs/ru/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ CONFIG_KALLSYMS_ALL=n (Initial support)

#### Windows

1. Загрузите `kptools-win.zip`, `kpimg-android` и `magiskboot`. Извлеките их в один каталог для использования.
1. Загрузите `kptools-msys2-win.7z` и `kpimg-android`. Извлеките их в один каталог для использования.
2. Выполните эту команду:

```cmd
magiskboot.exe unpack boot.img
kptools.exe unpack boot.img
```

чтобы распаковать `boot.img` и получить файл ядра. Переименуйте ядро в **kernel-b**. (kernel-b может быть любым кастомным ядром, но работа на кастомных ядрах не гарантированна и не будет поддерживаться).
Expand All @@ -78,7 +78,7 @@ magiskboot.exe unpack boot.img
Выполните эту команду для патчинга:

```cmd
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
```

В качестве альтернативы рекомендуется использовать `WSL` с `Linux` для патчинга:
Expand All @@ -90,7 +90,7 @@ kptools-x86_64-win.exe -p --image kernel-b --skey "YourKey" --kpimg kpimg-androi
Если во время патчинга не было сообщено об ошибках, выполните эту команду:

```cmd
magiskboot.exe repack boot.img
kptools.exe repack boot.img
```

чтобы упаковать и сгенерировать образ. Сгенерированный `new-boot.img` является пропатченным образом.
Expand All @@ -99,11 +99,11 @@ magiskboot.exe repack boot.img

#### Linux

1. Загрузите `kptools-linux`, `kpimg-android` и `magiskboot`.
1. Загрузите `kptools-linux` и `kpimg-android`.
2. Выполните эту команду:

```sh
magiskboot unpack boot.img
./kptools-linux unpack boot.img
```

чтобы распаковать `boot.img` и получить файл ядра. Переименуйте ядро в **kernel-b** (Повторяем, kernel-b может быть любым кастомным ядром, но работа на кастомных ядрах не гарантированна и не будет поддерживаться).
Expand All @@ -117,7 +117,7 @@ magiskboot unpack boot.img
Если во время патчинга не было сообщено об ошибках, выполните эту команду:

```sh
magiskboot repack boot.img
./kptools-linux repack boot.img
```

чтобы упаковать и сгенерировать образ. Сгенерированный `new-boot.img` является пропатченным образом.
Expand All @@ -140,9 +140,12 @@ magiskboot repack boot.img
-u, --unpatch Удалить патч из пропатченного образа ядра(-i)
-r, --reset-skey Сбросить superkey пропатченного образа(-i)
-d, --dump Вывести информацию kallsyms образа ядра(-i)
-f, --flag Вывести информацию ikconfig образа ядра(-i)
-l, --list Вывести всю информацию о патчах образа ядра, если указан (-i)
Вывести дополнительную информацию об элементах, если указан (-M)
Вывести информацию об образе KernelPatch, если указан (-k)
Распаковка ядра: unpack <boot.img>
Перепаковка ядра: repack <boot.img>
Опции:
-i, --image PATH Путь к образу ядра
-k, --kpimg PATH Путь к образу KernelPatch
Expand Down
14 changes: 7 additions & 7 deletions docs/zh_CN/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ APatch 有多种修补方法。

#### Windows

1. 下载 `kptools-win.zip` 和 `kpimg-android` ，并解压到当前目录使用，同时下载 `magiskboot(Windows)` 。
1. 下载 `kptools-msys2-win.7z` 和 `kpimg-android` ，并解压到当前目录使用。

2. 执行:

```cmd
magiskboot.exe unpack boot.img
kptools.exe unpack boot.img
```

解压 boot，然后将 kernel 改名为 kernel-b (kernel-b可以是其他第三方内核，但是第三方内核不做任何保证，也不会受到支持)。
Expand All @@ -95,7 +95,7 @@ Windows可以使用 `CMD` 或 `PowerShell` 进行修补。
执行:

```cmd
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
```

或者更推荐的，使用 `WSL` 的`Linux`修补:
Expand All @@ -107,7 +107,7 @@ kptools-x86_64-win.exe -p --image kernel-b --skey "YourKey" --kpimg kpimg-androi
修补后无报错，最后用:

```cmd
magiskboot.exe repack boot.img
kptools.exe repack boot.img
```

打包生成镜像，生成的 **new-boot.img** 即为修补好的镜像。
Expand All @@ -116,12 +116,12 @@ magiskboot.exe repack boot.img

#### Linux

1. 下载 `kptools-linux` 和 `kpimg-android` ，并下载 `magiskboot`。
1. 下载 `kptools-linux` 和 `kpimg-android` 。

2. 执行:

```sh
magiskboot unpack boot.img
./kptools-linux unpack boot.img
```

解包boot，获取kernel文件。将kernel改名为kernel-b。
Expand All @@ -135,7 +135,7 @@ magiskboot unpack boot.img
修补后无报错，最后用:

```sh
magiskboot repack boot.img
./kptools-linux repack boot.img
```

打包生成镜像，生成的 `new-boot.img` 即是修补好的镜像。
Expand Down