🤓Docker-Py-ReVanced

A little python script that will help you in building Revanced apps and sharing them anywhere.

Note - If you are a root user and want magisk module (Extended). Get them here

This is just a builder for revanced and not a revanced support. Please be understanding and refrain from asking about revanced features/bugs. Discuss those on proper relevant forums.

Pre-Built APKs

You can get pre-built apks here

Facing issues? Click here.

Build Yourself

You can use any of the following methods to build.

• 🚀 GitHub (Recommended)

  1. Click Star to support the project.

  2. Fork the project.

  3. Add ENVS (optional) secret to the repo. Required only if you want to cook specific apps/versions.

     • Go to the repo settings and then to actions->secret
     • Add Repository secret

  4. Go to actions tab. Select Build & Release.Click on Run Workflow.

     • Go to actions tab
     • Check the status of build, It should look green.

  5. If the building process is successful, you'll get your APKs in the

  6. Make sure to do below steps once in a while(daily or weekly) to keep the builder bug free.

• 🐳 Docker Compose

  1. Install Docker Desktop.
  2. Clone the repo

     git clone https://github.com/nikhilbadyal/docker-py-revanced
     

  3. cd to the cloned repo

     cd docker-py-revanced
     

  4. Update .env file if you want some customization(See notes)
  5. Run script with

     docker compose up --build
     

• 🐳With Docker

  1. Install Docker or Docker Desktop.

     curl -fsSL https://get.docker.com -o get-docker.sh
     sh get-docker.sh
     

  2. Run script with

     docker run -v "$(pwd)"/apks:/app/apks/  nikhilbadyal/docker-py-revanced
     

     You can pass the below environment variables (See notes) with the -e flag or use the --env-file flag.

• 🫠Without Docker

  1. Install Java >= 21
  2. Install Python >= 3.11
  3. Create virtual environment

     python3 -m venv venv
     

  4. Activate virtual environment

     source venv/bin/activate
     

  5. Install Dependencies with

     pip install -r requirements.txt
     

  6. Run the script with

     python main.py
     

Configurations

Global Config

Env Name	Description	Default
PATCH_APPS	Apps to patch/build	youtube
EXISTING_DOWNLOADED_APKS	Already downloaded clean apks	[]
PERSONAL_ACCESS_TOKEN	GitHub/GitLab Token to be used	None
DRY_RUN	Do a dry run	False
GLOBAL_CLI_DL*	DL for CLI to be used for patching apps.(Disabled Temp)	Revanced CLI
GLOBAL_PATCHES_DL*	DL for Patches to be used for patching apps.	ReVanced API patches bundle
GLOBAL_SPACE_FORMATTED_PATCHES*	Whether patches are space formatted.	True
GLOBAL_KEYSTORE_FILE_NAME*

* - Can be overridden for individual app.

App Level Config

Env Name	Description	Default
APP_NAME_CLI_DL	DL for CLI to be used for patching APP_NAME.(Disabled Temp)	GLOBAL_CLI_DL
APP_NAME_PATCHES_DL	DL for Patches to be used for patching APP_NAME. Supports multiple bundles via comma separation.	GLOBAL_PATCHES_DL
APP_NAME_SPACE_FORMATTED_PATCHES	Whether patches are space formatted. APP_NAME.	GLOBAL_SPACE_FORMATTED_PATCHES
APP_NAME_KEYSTORE_FILE_NAME	Key file to be used for signing APP_NAME.	GLOBAL_KEYSTORE_FILE_NAME
APP_NAME_OLD_KEY	Whether key used was generated with cli > v4(new) APP_NAME.	GLOBAL_OLK_KEY
APP_NAME_ARCHS_TO_BUILD	Arch to keep in the patched APP_NAME.	GLOBAL_ARCHS_TO_BUILD

** - By default all patches for a given app are included. ** - Can be used to included universal patch. *** - Can be used for unavailable apps in the repository (unofficial apps).

Obtainium

Optional integration with Obtainium so patched APKs can be installed and updated straight from your GitHub Releases. See obtainium.md for setup steps, how it works, and full option details.

Env Name	Description	Default
OBTAINIUM_EXPORT	Generate per-app HTML sources for Obtainium	False
OBTAINIUM_GITHUB_TAG	Release tag the generated links point to	latest
OBTAINIUM_SITE_EXPORT	Generate a one-click install site (index.html at branch root)	False
OBTAINIUM_VERSION_EXTRACTION_REGEX	Regex used to extract app + patch version for display	See docs
OBTAINIUM_VERSION_MATCH_GROUP	Match-group template used with the regex above	$1+$2

Note

1. Officially Supported values for APP_NAME** are :

   • youtube
   • youtube_music
   • photos
   • twitter
   • reddit
   • tiktok
   • warnwetter
   • spotify
   • nyx-music-player
   • icon_pack_studio
   • ticktick
   • twitch
   • windy
   • my-expenses
   • backdrops
   • expensemanager

7a. CLI argument compatibility profiles and overrides: This builder now supports multiple CLI syntax families and key-value override maps. dotenv # Default profile (recommended today) GLOBAL_CLI_ARGSF=revanced-cli Built-in profile values: - revanced-cli (default, current flag-based ReVanced CLI format) - morphe-cli (morphe-style list-patches requires --patches)

Override maps use unordered `KEY=value` pairs in a single string:
```dotenv
 GLOBAL_CLI_LPARGS="CMD=list-patches INDEX=-i PACKAGES=-p UNIVERSAL=-u VERSIONS=-v OPTIONS=-o PATCHES=__POSITIONAL__ PATCHES_POST= TEMPORARY_FILES_PATH="
 GLOBAL_CLI_PARGS="CMD=patch PATCHES=-p PATCHES_POST= ENABLED=-e DISABLED=-d OPTIONS=-O PURGE=--purge KEYSTORE=--keystore KEYSTORE_ENTRY_ALIAS=--keystore-entry-alias=alias KEYSTORE_ENTRY_PASSWORD=--keystore-entry-password=ReVanced KEYSTORE_PASSWORD=--keystore-password=ReVanced EXCLUSIVE=--exclusive APK=__POSITIONAL__ OUTPUT=-o FORCE=--force RIP_LIB=--rip-lib TEMPORARY_FILES_PATH=-t"
```
`PATCHES_POST` is an optional companion argument appended after every patch bundle (used by ReVanced v6 with `-b`).
`TEMPORARY_FILES_PATH` is a dynamic argument; when a CLI profile sets it, the builder passes
`<apks>/<CLI_TEMP_FOLDER_NAME>/<patch-source-app-name>` so parallel patchers do not share purge-sensitive temp files.
ReVanced and Morphe patch commands expose `-t`; Morphe list-patches also exposes `-t`, while ReVanced list-patches does not.
`CONTINUE_ON_ERROR` is an optional patch flag; the built-in `morphe-cli` profile enables `--continue-on-error`
because Morphe can skip one failed patch while still producing the app.
App-level overrides are also supported and take precedence:
```dotenv
 YOUTUBE_CLI_ARGSF=morphe-cli
 YOUTUBE_CLI_LPARGS="PATCHES=--patches TEMPORARY_FILES_PATH=-t"
 YOUTUBE_CLI_PARGS="PATCHES=-p STRIPLIBS=--striplibs TEMPORARY_FILES_PATH=-t"
```

Example configuration for the standard ReVanced CLI:
```dotenv
 GLOBAL_CLI_ARGSF=revanced-cli
```

8. If you don't want to use default keystore. You can provide your own by placing it inside apks folder. And adding the name of keystore-file in .env file or in ENVS in GitHub secrets (Recommended) in the format

 GLOBAL_KEYSTORE_FILE_NAME=revanced.keystore

Tool also support providing secret key at app level. You can sign A app with X key while signing B with Y key. Example:

 YOUTUBE_KEYSTORE_FILE_NAME=youtube.keystore

Note - If you are using your own keystore.And it was generated with cli > v4 Add Example:

 GLOBAL_OLD_KEY=False

if you are using different key for different apps. You need to specify at app level. ```dotenv YOUTUBE_OLD_KEY=False

9. <a id="global-options-file"></a>If you don't want to use default options.json file. You can provide your own by
placing it inside `apks` folder. And adding the name of `options-file` in `.env` file or in `ENVS` in `GitHub
secrets` (Recommended) in the format
```dotenv
 GLOBAL_OPTIONS_FILE=my_options.json

Tool also supports providing options file at app level. When an app-specific options file is provided, it is merged with the global options file. App-specific options override global options for the same patch name, while all other global options are preserved.

Example:

 YOUTUBE_OPTIONS_FILE=my_cool_yt_options.json

Options Merging Example: If your global options.json contains Theme and SponsorBlock options, and your app-specific my_cool_yt_options.json contains only a custom package name option, the final merged options will include all three. This is useful when using different patch sources (like Morphe, anddea, ReVanced) that require different patch option names for the same functionality.

Global options.json          App options.json           Final Merged Options
┌─────────────────┐         ┌─────────────────┐        ┌─────────────────┐
│ Theme           │         │ Change package  │   =>   │ Theme           │
│ SponsorBlock    │    +    │ name            │        │ SponsorBlock    │
│ Custom branding │         └─────────────────┘        │ Change package  │
└─────────────────┘                                    │ name            │
                                                       └─────────────────┘

10. You can build only for a particular arch in order to get smaller apk files.This can be done with by adding comma separated ARCHS_TO_BUILD in ENVS in GitHub secrets (Recommended) in the format.

     GLOABAL_ARCHS_TO_BUILD=arm64-v8a,armeabi-v7a
    

    Tool also support configuring at app level.

    Example:

     YOUTUBE_ARCHS_TO_BUILD=arm64-v8a,armeabi-v7a
    

    Note -

    1. Possible values are: armeabi-v7a,x86,x86_64,arm64-v8a
    2. Make sure the patching resource(CLI) support this feature.

11. If you want to include any extra file to the Github upload. Set comma arguments in .env file or in ENVS in GitHub secrets (Recommended) in the format

    # Exact filename match
    EXTRA_FILES=<url>@<appName>.apk
    
    # Regex pattern match for dynamic/versioned asset names
    EXTRA_FILES=<url>@/<regex-pattern>/
    

    Example:

     EXTRA_FILES=https://github.com/inotia00/mMicroG/releases/[email protected]
     # Regex example matching versioned MicroG filenames:
     EXTRA_FILES=https://github.com/microg/GmsCore/releases/latest@/com\.google\.android\.gms-\d+\.apk$/
    

12. If you want to exclude any patch. Set comma separated patch in .env file or in ENVS in GitHub secrets (Recommended) in the format

    <APP_NAME>_EXCLUDE_PATCH=<PATCH_TO_EXCLUDE-1,PATCH_TO_EXCLUDE-2>
    

    Example:

     YOUTUBE_EXCLUDE_PATCH=custom-branding,hide-get-premium
     YOUTUBE_MUSIC_EXCLUDE_PATCH=yt-music-is-shit
    

    Note -

    1. All the patches for an app are included by default.
    2. Revanced patches are provided as space separated, make sure you type those - separated here. It means a patch named Hey There must be entered as hey-there in the above example.

13. If you want to include any universal patch. Set comma separated patch in .env file or in ENVS in GitHub secrets (Recommended) in the format

    <APP_NAME>_INCLUDE_PATCH=<PATCH_TO_EXCLUDE-1,PATCH_TO_EXCLUDE-2>