Patcher framework used in the ReVanced project.

dependabot[bot] 8a0b6d2c5e build(deps): bump com.android.tools.smali:smali from 3.0.4 to 3.0.5 9 mesi fa
.github a4e18334bc chore: Revert using a relative image path 9 mesi fa
api f1d7217495 feat: Read and write arbitrary files in APK files 9 mesi fa
assets 287841d806 chore: Add heading to issue templates 1 anno fa
docs d862d61386 docs: Un-indent markdown to fix rendering 9 mesi fa
gradle 8a0b6d2c5e build(deps): bump com.android.tools.smali:smali from 3.0.4 to 3.0.5 9 mesi fa
src 8e1117ed3f refactor: Properly abstract `Patch#execute` function 9 mesi fa
.editorconfig f1d7217495 feat: Read and write arbitrary files in APK files 9 mesi fa
.gitattributes a4a030f2b2 build: update gradle 1 anno fa
.gitignore a49e78234b chore: remove project files 1 anno fa
.releaserc 1790f0d706 ci: Change bumping commit scope 1 anno fa
CHANGELOG.md ceb6fd51c1 chore(release): 19.3.1 [skip ci] 9 mesi fa
CONTRIBUTING.md 29adcd5aad docs: Fix broken links 9 mesi fa
LICENSE 81e0220d15 License ReVanced Patcher under GPLv3 2 anni fa
README.md 6b2bc5ef4d docs: Fix docs link [skip ci] 9 mesi fa
build.gradle.kts fe8ea9130d build: Remove unnecessary `java` plugin 9 mesi fa
gradle.properties ceb6fd51c1 chore(release): 19.3.1 [skip ci] 9 mesi fa
gradlew a4a030f2b2 build: update gradle 1 anno fa
gradlew.bat a4a030f2b2 build: update gradle 1 anno fa
package-lock.json 5bef74adb5 build: Bump dependencies 9 mesi fa
package.json 5bef74adb5 build: Bump dependencies 9 mesi fa
settings.gradle.kts e7dacfba8c build: Simplify enabling local build cache 11 mesi fa

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.