twrpdtgen 1.0.0

TWRP Device Tree Generator. A script that generates a TWRP-compatible device tree.

TWRP device tree generator

Create a TWRP-compatible device tree only from a recovery image (or a boot image if the device is A/B) of your device's stock ROM It has been confirmed that this script supports images built starting from Android 4.4 up to Android 11

Installation

pip install twrpdtgen

The module is supported on Python 3.6 and above.

Linux only: Be sure to have cpio installed in your system (Install cpio using sudo apt install cpio or sudo pacman -S cpio based on what package manager you're using)

How to use

$ twrpdtgen -h
TWRP device tree generator

usage: twrpdtgen [-h] [-v] recovery_image

positional arguments:
  recovery_image  path to a recovery image (or boot image if the device is A/B)

optional arguments:
  -h, --help      show this help message and exit
  -v, --verbose   Enable debugging logging

When an image is provided, if everything goes well, there will be a device tree at working/manufacturer/codename

You can also use the module in a script, with the following code:

from twrpdtgen.twrp_dt_gen import generate_device_tree

# The function will return a DeviceTree object, you can find its declaration here:
from twrpdtgen.utils.device_tree import DeviceTree

result = generate_device_tree(image_path, output_path)