How fiorenmas/revanced-and-revanced-extended-non-root works
Project Overview & Purpose
• This repository is a collection of open-source scripts designed to make patching various Android apps (such as YouTube, YouTube Music, Facebook, Twitter, etc.) easier. Users choose from options like “Revanced” or “Revanced Extended” (including beta, stable, and lite variations) and select the appropriate CPU architecture.
• The core purpose is to simplify the patching process by integrating various external patching projects into a unified, automated script-running system.
Main Components
• GitHub CI/CD Integration:
– The “.github” folder contains actions and workflows. This represents the automated CI/CD pipeline that builds, tests, and releases updated patch files.
• Build Scripts Engine:
– The “src/build” directory holds numerous shell scripts for building different variants (e.g., Revanced.sh, Revanced-Extended.sh, and their beta/Android version counterparts). This is where the main build logic lives.
• Patch & Options Modules:
– The “src/patches” folder is organized by target apps (YouTube, Facebook, Instagram, etc.). Each app folder contains “include-patches” and “exclude-patches” directories to determine which modifications get applied.
– The “src/options” folder supplies configuration files (in JSON format) that correspond to specific patching scenarios or app variants.
• Utility and Environment Configuration Scripts:
– The “src/etc” folder contains helper scripts (for tasks like managing connections or CI-specific configuration) along with key files like the keystore.
• Supporting Documentation:
– The “docs” folder, which contains FAQs and visual assets (banner images), supports user guidance and troubleshooting.
Component Relationships and Data Flow
• User Input & Configuration:
– Users start by selecting the target app and variant (from Revanced options) along with appropriate CPU architecture. This decision ties into the “options” JSON files.
• Build & Patch Generation:
– The selected options trigger execution of the corresponding build script (located in “src/build”), which in turn refers to the appropriate patches (from “src/patches”) and configuration files.
– Utility scripts (in “src/etc”) may be called during the build process to manage environment settings, CI integration, or connectivity.
• CI/CD Pipeline:
• External Dependencies:
– External dependencies like MicroG or other repositories (mentioned in the README) should be represented as external services or libraries that the build process depends on.
Architectural Patterns and Design Principles
• Modular design principle: The repository is structured into modular directories (build scripts, patches, options) that separate concerns. Each app’s patches are isolated in their own subdirectories, making extension or maintenance easier.
• Script-driven automation: The system relies on shell scripts organized clearly by build type, enabling automation and customization.
• CI/CD integration: Emphasize the automated pipelines (GitHub Actions) that drive testing and release processes.
Final Checklist
• Component Labels: Clearly mark “User Input/Selection,” “Build Scripts Engine,” “App Patches,” “Configuration Options,” “Utility Scripts,” “CI/CD Pipeline,” and “External Dependencies.”
– How user choice triggers specific build scripts.
– How build scripts interact with patch sets and options.
– How CI/CD triggers and monitors the whole process.
• Details capture the essence of a modular, automated script-based build system for patching APKs.