Continuing the legacy of Vanced

# 💉 ReVanced Patcher ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/ReVanced/revanced-patcher/release.yml) ![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg) ReVanced Patcher used to patch Android applications. ## ❓ About ReVanced Patcher is a library that is used to patch Android applications. It powers [ReVanced Manager](https://github.com/ReVanced/revanced-manager), [ReVanced CLI](https://github.com/ReVanced/revanced-cli) and [ReVanced Library](https://github.com/ReVanced/revanced-library) and a rich set of patches have been developed using ReVanced Patcher in the [ReVanced Patches](https://github.com/ReVanced/revanced-patches) repository. ## 💪 Features Some of the features the ReVanced Patcher provides are: - 🔧 **Patch Dalvik VM bytecode**: Disassemble and assemble Dalvik bytecode - 📦 **Patch APK resources**: Decode and build Android APK resources - 📂 **Patch arbitrary APK files**: Read and write arbitrary files directly from and to APK files - 🧩 **Write modular patches**: Extensive API to write modular patches that can patch Dalvik VM bytecode, APK resources and arbitrary APK files ## 🚀 How to get started To use ReVanced Patcher in your project, follow these steps: 1. [Add the repository](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#using-a-published-package) to your project 2. Add the dependency to your project: ```kt dependencies { implementation("app.revanced:revanced-patcher:{$version}") } ``` For a minimal project configuration, see [ReVanced Patches template](https://github.com/ReVanced/revanced-patches-template). ## 📚 Everything else ### 📙 Contributing Thank you for considering contributing to ReVanced Patcher. You can find the contribution guidelines [here](CONTRIBUTING.md). ### 🛠️ Building To build ReVanced Patcher, you can follow the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation). ### 📃 Documentation The documentation contains the fundamentals of ReVanced Patcher and how to use ReVanced Patcher to create patches. You can find it [here](https://github.com/ReVanced/revanced-patcher/tree/main/docs). ## 📜 Licence ReVanced Patcher is licensed under the GPLv3 license. Please see the [licence file](LICENSE) for more information. [tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and modify ReVanced Patcher as long as you track changes/dates in source files. Any modifications to ReVanced Patcher must also be made available under the GPL, along with build & install instructions.