# pangu-immortal/magicwx architecture

> Architecture diagram of the GitHub repository pangu-immortal/magicwx, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pangu-immortal/magicwx
- Repository: https://github.com/pangu-immortal/magicwx

## Overview

##### Project type and purpose
- MagicWX is a native Android application embedding an ONNX-based AI model for on-device inference.
- It has no server-side components; it focuses on UI, background Services, model loading, and Xposed integration.

##### Main components
a. Android UI Layer
- Activities/Fragments under app/src/main/java (not shown in tree but implied)
- XML layouts and resource files in app/src/main/res
b. On-Device Inference Engine
- ONNX Runtime library (added via Gradle)
- Assets folder containing `model.onnx` and `vocab.json`
c. Background Services & API Hooks
- Android Services for auto-start, keep-alive, and pull-up functionality
- Xposed module integration (hooking system APIs)
d. Android Framework & System
- AndroidManifest.xml declaring components and permissions
- Interaction with Android OS (PackageManager, ActivityManager, Accessibility, Broadcast receivers)
e. Build & Packaging
- Gradle build scripts (app/build.gradle, settings.gradle)
- ProGuard rules (proguard-rules.pro)
- ABI splits for 32-bit/64-bit architectures

##### Relationships and data flow
- User → UI Layer: user input triggers UI events
- UI Layer → Inference Engine: passes text or features to ONNX Runtime
- Inference Engine (Assets + ONNX Runtime) → Output: model returns results to UI
- UI/Service → Android System: requests for background tasks, auto-start, pop-up windows
- Xposed Hooks intercept OS calls to bypass restrictions (app install/uninstall, process restart)

##### Architectural patterns & design principles
- Separation of Concerns: UI vs. inference vs. system hooks
- Modularizing inference code so it’s isolated in a ModelManager class
- Services for long-running background jobs
- Use of Android’s asset management for large files

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User
    User["User"]:::external

    %% UI Layer
    subgraph "UI Layer" 
        direction TB
        MainActivity["MainActivity / Fragment"]:::ui
        Resources["Resources (res)"]:::ui
        Manifest["AndroidManifest.xml"]:::ui
    end

    %% Inference Layer
    subgraph "On-Device Inference Engine"
        direction TB
        ONNXRuntime["ONNX Runtime Library"]:::inference
        ModelManager["ModelManager"]:::inference
        subgraph "Model Assets"
            direction TB
            Vocab["vocab.json"]:::inference
            ONNXModel["model.onnx"]:::inference
        end
    end

    %% Services & Hooks
    subgraph "Background Services & Xposed Hooks"
        direction TB
        AutoStartService["AutoStartService"]:::service
        KeepAliveService["KeepAliveService"]:::service
        PopupService["PopupService"]:::service
        XposedHook["XposedHook Integration"]:::service
    end

    %% Android Framework/System
    subgraph "Android Framework & System"
        direction TB
        AndroidOS["Android OS"]:::system
        BroadcastReceiver["BroadcastReceiver"]:::system
        PackageManager["PackageManager"]:::system
        ActivityManager["ActivityManager"]:::system
        AccessibilityService["Accessibility"]:::system
    end

    %% Build & Packaging
    subgraph "Build & Packaging"
        direction TB
        AppBuildGradle["app/build.gradle"]:::build
        SettingsGradle["settings.gradle"]:::build
        RootBuildGradle["build.gradle"]:::build
        GradleProperties["gradle.properties"]:::build
        WrapperFiles["gradle/wrapper/..."]:::build
        ProGuard["app/proguard-rules.pro"]:::build
    end

    %% Connections
    User -->|"interacts with"| MainActivity
    MainActivity -->|"loads UI resources"| Resources
    MainActivity -->|"defined in"| Manifest

    MainActivity -->|"calls"| ModelManager
    ModelManager -->|"uses"| ONNXRuntime
    ModelManager -->|"loads"| ONNXModel
    ModelManager -->|"loads"| Vocab
    ModelManager -->|"returns results to"| MainActivity

    MainActivity -->|"starts"| AutoStartService
    MainActivity -->|"binds to"| KeepAliveService
    MainActivity -->|"triggers"| PopupService
    XposedHook -->|"hooks into"| AndroidOS

    AutoStartService -->|"registers with"| BroadcastReceiver
    KeepAliveService -->|"calls"| ActivityManager
    PopupService -->|"requests"| AccessibilityService
    BroadcastReceiver -->|"notifies"| PackageManager

    AppBuildGradle -->|"configures"| ONNXRuntime
    AppBuildGradle -->|"includes assets"| Vocab
    AppBuildGradle -->|"includes assets"| ONNXModel
    RootBuildGradle -->|"imports modules"| AppBuildGradle
    SettingsGradle -->|"includes project"| AppBuildGradle
    GradleProperties -->|"settings for"| AppBuildGradle
    WrapperFiles -->|"Gradle version"| AppBuildGradle
    ProGuard -->|"applies rules to"| AppBuildGradle

    %% Click Events
    click Resources "https://github.com/pangu-immortal/magicwx/tree/Ai/app/src/main/res"
    click Manifest "https://github.com/pangu-immortal/magicwx/blob/Ai/app/src/main/AndroidManifest.xml"
    click MainActivity "https://github.com/pangu-immortal/magicwx/tree/Ai/app/src/main/java"
    click Vocab "https://github.com/pangu-immortal/magicwx/blob/Ai/app/src/main/assets/model/vocab.json"
    click ONNXModel "https://github.com/pangu-immortal/magicwx/blob/Ai/app/src/main/assets/model/model.onnx"
    click AppBuildGradle "https://github.com/pangu-immortal/magicwx/blob/Ai/app/build.gradle"
    click SettingsGradle "https://github.com/pangu-immortal/magicwx/blob/Ai/settings.gradle"
    click RootBuildGradle "https://github.com/pangu-immortal/magicwx/blob/Ai/build.gradle"
    click GradleProperties "https://github.com/pangu-immortal/magicwx/blob/Ai/gradle.properties"
    click WrapperFiles "https://github.com/pangu-immortal/magicwx/blob/Ai/gradle/wrapper/gradle-wrapper.properties"
    click ProGuard "https://github.com/pangu-immortal/magicwx/blob/Ai/app/proguard-rules.pro"

    %% Styles
    classDef ui fill:#bbdefb,stroke:#1e88e5,color:#0d47a1;
    classDef inference fill:#c8e6c9,stroke:#43a047,color:#1b5e20;
    classDef service fill:#ffe0b2,stroke:#fb8c00,color:#e65100;
    classDef system fill:#e0e0e0,stroke:#757575,color:#212121;
    classDef build fill:#f0f4c3,stroke:#afb42b,color:#33691e;
    classDef external fill:#ffffff,stroke:#000000,color:#000000;
```
