revanced-patcher/docs/2_1_setup.md

                       

Continuing the legacy of Vanced

👶 Setting up a development environment

To start developing patches with ReVanced Patcher, you must prepare a development environment.

📝 Prerequisites

• A Java IDE with Kotlin support, such as IntelliJ IDEA
• Knowledge of Java, Kotlin, and Dalvik bytecode
• Android reverse engineering skills and tools such as jadx

🏃 Prepare the environment

Throughout the documentation, ReVanced Patches will be used as an example project.

[!NOTE] To start a fresh project, you can use the ReVanced Patches template.

1. Clone the repository

   git clone https://github.com/revanced/revanced-patches && cd revanced-patches

1. Build the project

   ./gradlew build

[!NOTE] If the build fails due to authentication, you may need to authenticate to GitHub Packages. Create a PAT with the scope read:packages here and add your token to ~/.gradle/gradle.properties.

Example gradle.properties file:

gpr.user = user
gpr.key = key

1. Open the project in your IDE

[!TIP] It is a good idea to set up a complete development environment for ReVanced, so that you can also test your patches by following the ReVanced documentation.

⏭️ What's next

The next page will go into details about a ReVanced patch.

Continue: 🧩 Anatomy of a patch