AMMF2 - Aurora Modular Magisk Framework

简体中文 | English

📋 Project Overview

AMMF2 (Aurora Modular Magisk Framework 2) is a powerful Magisk module development framework designed to simplify the module development process by providing standardized structures and rich functional components. The framework supports multiple languages, WebUI configuration interface, custom scripts, and other features, making it suitable for various types of Magisk module development.

Telegram Group

✨ Key Features

• Multi-language Support: Built-in support for Chinese, English, Japanese, Russian, and other languages
• WebUI Configuration Interface: Beautiful Material Design-style web configuration interface
• Custom Script System: Flexible script system supporting installation-time and runtime scripts
• File Monitoring Service: Built-in filewatch tool supporting file change-triggered operations
• Logging Tools: Complete logging system with log recording and error handling
• User Interaction Features: Various user interaction methods such as menu selection and key detection
• GitHub Action Support: Built-in GitHub Action workflows supporting automatic building and publishing
• Comprehensive Error Handling: Provides complete error handling and logging mechanisms

🚀 Quick Start

Getting the Framework

# Method 1: Clone the repository using Git
git clone https://github.com/Aurora-Nasa-1/AMMF2.git
cd AMMF2

# Method 2: Download ZIP archive
# Visit https://github.com/Aurora-Nasa-1/AMMF2/archive/refs/heads/main.zip

# Other methods...

Basic Configuration

Note: This framework requires GitHub Action for module building

1. How to create a new module: Module Development Guide

2. Release Upload Configuration: Action uses softprops/action-gh-release@v2 to upload Release, needs to be configured in repository settings

3. Commit or create Tag(v) to trigger build, Enjoy*

Build Module

The module build process is now managed by RMM (RootManageModuleModel).

1. Local Build Module: Please refer to the Module Development Guide for detailed local build instructions and prerequisites. In short, after setting up NDK, uv, and RMM, the build command is:

   rmm build

   The old build.sh script is deprecated.

2. GitHub Action Automatic Build: Committing or pushing a Tag (e.g., v1.0) will automatically trigger the GitHub Actions workflow to build the module. This process also uses RMM.

Custom Script Development

To ensure future updatability, it is recommended not to modify service.sh and customize.sh

1. Installation Script: Write custom scripts executed during module installation in files/scripts/install_custom_script.sh.

2. Service Script: Write runtime service scripts for the module in files/scripts/service_script.sh.

📚 More Documentation

• Directory Structure - Detailed project directory structure description
• Script Development Guide - Script development and function usage instructions
• WebUI Development Guide - WebUI development and customization instructions

🤝 Contribution

Welcome to submit PR or Issue to improve this framework! If you find this project useful, please give it a Star ⭐

📄 License

This project is licensed under the MIT LICENSE.

🙏 Acknowledgments

Pure CSS Material 3 Design