ReVanced Builder

NOTICE

This repository has been archived in favour of ReVanced Builder v4, a rewrite of the same builder from scratch using better technologies. At the time of writing, v4 is not yet available for the public, but it will be soon once the core features are finished. In the meantime, you can download the latest version of Builder v3, which, at the moment, works just fine. If ReVanced changes anything about the patching process in the upstream, or APKMirror modifies its API to disallow APK downloads, Builder may fail in ways nobody can really predict accurately. No support, hereafter, will be given for this version, however.

---

This project will allow you to download the APK of any of the officially supported apps and build ReVanced easily!

Required

You'll need at least Zulu JDK 17 and ADB (optional, required only for rooted phones).

If you plan to use it from source, you'll also require Node.js >= 16.

How to use

If you are on a PC, download the latest executable from here or if you are on a Android device, please see this.

NOTE: If you intend to build the rooted version of either YouTube or YouTube Music, you must have the stock YouTube app to be the same version as the one chosen for building. Otherwise, the build will fail.

For developers

For developers, see this

How to use (Docker)

Required docker and docker-compose (for *nix cli) must be installed

Note: If you're using Docker Desktop, docker-compose will be pre-installed.

Clone the repository and cd into the directory revanced-builder

Build using docker-compose

docker-compose build --pull --no-cache

This builds the Docker image (--no-cache is used to build the image from scratch; sometimes the cache might cause version conflicts).

After building, launch the container (runs at localhost:8000):

docker-compose up -d

To stop the container:

docker-compose down

Note: docker-compose uses docker-compose.yml so make sure you are in the same directory revanced-builder

To update to a newer version, stop the existing container if it is running, build the image and start it again.

Build using only docker

docker build . --pull -t <name_of_the_image> --no-cache

Run the newly built container:

docker run -d --name <name_of_container> -p 8000:8000 --restart unless-stopped -v ./revanced/:/app/revanced-builder/revanced/ <name_of_the_image>

This launches the container on http://localhost:8000

To stop the container:

docker rm <name_of_container> -f
docker rmi <name_of_the_image> -f

To update to a newer version of Builder, stop the existing container if it is running, build the container start it again.

In both the builds, a persistent storage is kept. All the builds are stored in <path/to>/revanced-builder/revanced/.