KernelSU/Apatch/Magisk WebUI Module Template

This is a template for creating KernelSU/Apatch/Magisk modules with WebUI. It includes a basic structure and a build script

How to use template

1. Fork this template
2. Modify module/module.prop with your module details.
   1. Set your repo url in updateJson
3. Develop you own module, lol
4. Edit CHANGELOG.md
5. Build the module using nix build
   1. or just use GitHub Actions (nix run nixpkgs#act -- -j build -P ubuntu-latest=ghcr.io/catthehacker/ubuntu:act-24.04 --artifact-server-path ./artifacts (choose Medium size image))
6. Remove "How to use template" section from README.md

Module Structure

• docs
  • KernelSU
  • Apatch
  • Magisk
• module/: Module content
  • module.prop: Module metadata
  • banner.{png,webp}: Banner which will be shown in module managers
    • works in KSU-Next and other new managers
    • you could place it inside webroot/ to use as WebUI media
    • recommended size is 640*320
  • webroot/: WebUI assets
  • META-INF/ From magisk docs
• CHANGELOG.md: Module changelog
• update.json: Will be generated from module.prop

Development with Nix

Use nix develop (or better, use direnv) to enter a development shell with necessary tools installed:

Install

• Download zip from latest release
• Flash via your module manager of choice