Patcher framework used in the ReVanced project.

oSumAtrIX f57e571a14 chore: Merge branch `dev` to `main` (#276) 2 months ago
.github fe616beb22 docs: Add documentation (#278) 2 months ago
api f1d7217495 feat: Read and write arbitrary files in APK files 3 months ago
assets 287841d806 chore: Add heading to issue templates 5 months ago
docs fe616beb22 docs: Add documentation (#278) 2 months ago
gradle db8866212a build: Bump Gradle 3 months ago
src cc183062ab chore: Fix inline comment 2 months ago
.editorconfig f1d7217495 feat: Read and write arbitrary files in APK files 3 months ago
.gitattributes a4a030f2b2 build: update gradle 10 months ago
.gitignore a49e78234b chore: remove project files 1 year ago
.releaserc 1790f0d706 ci: Change bumping commit scope 9 months ago
CHANGELOG.md ceb6fd51c1 chore(release): 19.3.1 [skip ci] 3 months ago
CONTRIBUTING.md fe616beb22 docs: Add documentation (#278) 2 months ago
LICENSE 81e0220d15 License ReVanced Patcher under GPLv3 2 years ago
README.md fe616beb22 docs: Add documentation (#278) 2 months ago
build.gradle.kts fe8ea9130d build: Remove unnecessary `java` plugin 3 months ago
gradle.properties ceb6fd51c1 chore(release): 19.3.1 [skip ci] 3 months ago
gradlew a4a030f2b2 build: update gradle 10 months ago
gradlew.bat a4a030f2b2 build: update gradle 10 months ago
package-lock.json 608a05d9aa build: Bump dependencies 3 months ago
package.json 68e2acebba build: Bump dependencies 3 months ago
settings.gradle.kts e7dacfba8c build: Simplify enabling local build cache 5 months ago

README.md


                       

Continuing the legacy of Vanced

💉 ReVanced Patcher

GitHub Workflow Status (with event) GPLv3 License

ReVanced Patcher used to patch Android applications.

❓ About

ReVanced Patcher is a library that is used to patch Android applications.
It powers ReVanced Manager, ReVanced CLI and ReVanced Library and a rich set of patches have been developed using ReVanced Patcher in the 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 to your project
  2. Add the dependency to your project:
    dependencies {
        implementation("app.revanced:revanced-patcher:{$version}")
    }

For a minimal project configuration, see ReVanced Patches template.

📚 Everything else

📙 Contributing

Thank you for considering contributing to ReVanced Patcher. You can find the contribution guidelines here.

🛠️ Building

To build ReVanced Patcher, you can follow the 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.

📜 Licence

ReVanced Patcher is licensed under the GPLv3 license. Please see the licence file for more information. tl;dr 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.