Patcher framework used in the ReVanced project.

semantic-release-bot ead701bdaf chore: Release v21.0.0 [skip ci] 1 month ago
.github ffb1d880d7 ci: Use permissions and regular GitHub token instead of PAT 2 months ago
api 0746c22743 feat: Move fingerprint match members to fingerprint for ease of access by using context receivers 1 month ago
assets 287841d806 chore: Add heading to issue templates 1 year ago
docs 0746c22743 feat: Move fingerprint match members to fingerprint for ease of access by using context receivers 1 month ago
gradle 73d3cbf4ff build: Bump Gradle Wrapper to 8.9 4 months ago
src 1358d3fa10 perf: Use smallest lookup map for strings 1 month ago
.editorconfig f1d7217495 feat: Read and write arbitrary files in APK files 10 months ago
.gitattributes a4a030f2b2 build: update gradle 1 year ago
.gitignore a49e78234b chore: remove project files 1 year ago
.releaserc e1b984d601 ci: Adjust release commit message 2 months ago
CHANGELOG.md ead701bdaf chore: Release v21.0.0 [skip ci] 1 month ago
CONTRIBUTING.md 26d449e6d9 docs: Fix broken links 4 months ago
LICENSE 81e0220d15 License ReVanced Patcher under GPLv3 2 years ago
README.md 49466060e3 docs: Fix docs link [skip ci] 4 months ago
build.gradle.kts 0746c22743 feat: Move fingerprint match members to fingerprint for ease of access by using context receivers 1 month ago
gradle.properties ead701bdaf chore: Release v21.0.0 [skip ci] 1 month ago
gradlew 73d3cbf4ff build: Bump Gradle Wrapper to 8.9 4 months ago
gradlew.bat 73d3cbf4ff build: Bump Gradle Wrapper to 8.9 4 months ago
package-lock.json e95f13ae3e build(Needs bump): Update dependencies 2 months ago
package.json e95f13ae3e build(Needs bump): Update dependencies 2 months ago
settings.gradle.kts 11a911dc67 feat: Convert APIs to Kotlin DSL (#298) 4 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.