TWRP Device Tree Generator UI

A user-friendly PyQt6-based GUI for the TWRP Device Tree Generator that makes it easy for normal users to convert Android recovery images into TWRP-compatible device trees.

Features

• Easy-to-Use GUI: Modern PyQt6 interface with intuitive workflow
• Automatic Export Path: Defaults to ~/Documents/trees/[device_codename]
  • Linux: /home/[username]/Documents/trees/[device_codename]
  • Windows: C:\Users\[username]\Documents\trees\[device_codename]
• Real-time Progress: Live log output during generation
• File Browser: Easy image and output folder selection
• Optional Git Integration: Create a git repository after generation
• Cross-platform: Works on Linux, Windows, and macOS
• Wide Android Support: Android 4.4 through Android 17

Requirements

• Python 3.8 or greater
• PyQt6
• Linux: cpio must be installed (sudo apt install cpio or sudo pacman -S cpio)

Installation

pip install twrpdtui

Or if using Poetry:

poetry install

Usage

GUI Mode (Recommended for Normal Users)

twrpdtgen-gui

Or:

python3 -m twrpdtgen --gui

CLI Mode

twrpdtgen <path-to-image>

With custom output:

twrpdtgen <path-to-image> -o /custom/output/path

With git repo initialization:

twrpdtgen <path-to-image> --git

How to Use the GUI

1. Launch the GUI: Run twrpdtgen-gui
2. Select Recovery Image: Click "Browse" and choose your recovery image (.img or .bin)
3. Choose Output Folder (Optional): Default is ~/Documents/trees/
4. Set Options: Enable "Initialize Git repository" if desired
5. Click Generate: Start the device tree generation
6. Monitor Progress: Watch the live log output
7. Done: Your device tree will be in the specified folder

Supported Image Types

• Recovery images (.img, .bin)
• Boot images (for A/B devices)
• Tested on Android 4.4 - 17

Supported Android Versions

Output Structure

~/Documents/trees/[device_codename]/
├── Android.bp
├── Android.mk
├── AndroidProducts.mk
├── BoardConfig.mk
├── device.mk
├── extract-files.sh
├── omni_[device_codename].mk
├── README.md
├── setup-makefiles.sh
├── vendorsetup.sh
├── recovery.fstab
├── prebuilt/
│   ├── kernel
│   ├── dt.img
│   ├── dtb.img
│   └── dtbo.img
└── recovery/
    └── root/
        └── *.rc

Advanced Usage

Using as a Python Library

from twrpdtgen.device_tree import DeviceTree
from pathlib import Path

# Get image info
device_tree = DeviceTree(image_path=Path("/path/to/recovery.img"))

# Dump device tree to folder
output_path = Path("/path/to/output")
device_tree.dump_to_folder(output_path)

License

Apache License 2.0

Copyright (C) 2022 The Android Open Source Project

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Contributing

Contributions are welcome! Feel free to submit issues and pull requests.

Credits

• Original twrpdtgen by twrpdtgen
• GUI implementation by RetroFrost