uvmod/README.md
matt 106eb8c91f
Update README.md
added link to chinese version
2023-08-07 09:07:45 +02:00

1.6 KiB

CLICK HERE TO OPEN UVMOD

中文版 Open Chinese Version (maintained independently)

Introduction

Web-based client-side Quansheng firmware patcher written in Javascript and HTML using Bootstrap 4.6.0, jQuery and parts of the SB Admin 2 Theme.
It is based on the discoveries by the many contributors in the uvmod-kitchen and implements the same functionality in a modular and flexible javascript structure.

Visitors can generate a patched firmware image by selecting the desired patches. Patches modify the firmware on a binary level and can accept user input to customize variables. A custom base image can be supplied to allow support for mods that are compiled and linked directly into the firmware.

Mod development

Clone this repository and execute python3 -m http.server or python -m http.server in the root directory for an instant local web server, allowing easy testing.
Mods are defined in mods.js, with an example mod to outline the pattern.
Also refer to the helper functions and documentation in modframework.js.

The supported format for binary data is in the format of a hex string without separators. You can use find and replace to remove all \x from a regular hex string or directly export the correct format from a bytes object in python using print(''.join('%02x'%i for i in BYTES_OBJECT)).