nikhilbadyal/docker-py-revanced repository overview

⁠🤓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.

     🚶Detailed step by step guide

     • 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.

     🚶Detailed step by step guide

     • 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
     

     Copy
  3. cd to the cloned repo

     cd docker-py-revanced
     

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

     docker compose up --build
     

     Copy

• 🐳With Docker

  1. Install Docker or Docker Desktop⁠.

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

     Copy
  2. Run script with

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

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

• 🫠Without Docker

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

     python3 -m venv venv
     

     Copy
  4. Activate virtual environment

     source venv/bin/activate
     

     Copy
  5. Install Dependencies with

     pip install -r requirements.txt
     

     Copy
  6. Run the script with

     python main.py
     

     Copy

⁠Configurations

⁠Global Config

* - Can be overridden for individual app.

⁠App Level Config

** - 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).

⁠Note

1. Officially Supported values for APP_NAME** are :

   • youtube⁠
   • youtube_music⁠
   • twitter⁠
   • reddit⁠
   • tiktok⁠
   • warnwetter⁠
   • spotify⁠
   • nyx-music-player⁠
   • icon_pack_studio⁠
   • ticktick⁠
   • twitch⁠
   • hex-editor⁠
   • windy⁠
   • my-expenses⁠
   • backdrops⁠
   • expensemanager⁠
   • tasker⁠
   • irplus⁠
   • vsco⁠
   • meme-generator-free⁠
   • nova_launcher⁠
   • netguard⁠
   • instagram⁠
   • inshorts⁠
   • messenger⁠
   • grecorder⁠
   • trakt⁠
   • candyvpn⁠
   • sonyheadphone⁠
   • androidtwelvewidgets⁠
   • yuka⁠
   • relay⁠
   • boost⁠
   • rif⁠
   • sync⁠
   • infinity⁠
   • slide⁠
   • bacon⁠
   • microg⁠
   • pixiv⁠
   • strava⁠
   • solidexplorer⁠
   • lightroom⁠
   • duolingo⁠
   • musically⁠
   • photomath⁠
   • joey⁠
   • vanced⁠
   • spotify-lite⁠
   • digitales⁠
   • scbeasy⁠
   • reddit-news⁠
   • finanz-online⁠
   • tumblr⁠
   • fitnesspal⁠
   • facebook⁠
   • lemmy-sync⁠

   
   ** - You can also patch any other app which is not supported officially.To do so, you need to provide few more inputs to the tool which are mentioned below. These config will override the sources config from the tool.

   <APP_NAME>_DL_SOURCE=<apk-link-to-any-of-the-suppored-scrapper>
   <APP_NAME>_PACKAGE_NAME=<package-name-of-the-application>
   

   Copy

   You can also provide DL to the clean apk instead of providing DL_SOURCES as mentioned in this note⁠. Supported Scrappers are:

   1. APKMIRROR - Supports downloading any available version
      1. Link Format - https://www.apkmirror.com/apk/⁠/app-name/
      2. Example Link - https://www.apkmirror.com/apk/google-inc/youtube/⁠
   2. UPTODOWN - Supports downloading any available version
      1. Link Format - https://.en.uptodown.com/android
      2. Example Link - https://spotify.en.uptodown.com/android⁠
   3. APKSOS - Supports downloading any available version
      1. Link Format - https://apksos.com/download-app/⁠
      2. Example Link - https://apksos.com/download-app/com.expensemanager⁠
   4. APKPURE - Supports downloading any available version
      1. Link Format - https://apkpure.net/-/⁠
      2. Example Link - https://apkpure.net/-/com.google.android.youtube⁠
   5. APKMonk - Supports downloading any available version
      1. Link Format - https://www.apkmonk.com/app/⁠/
      2. Example Link - https://www.apkmonk.com/app/⁠/
   6. Google Drive - Supports downloading from Google Drive lint
      1. Link Format - https://drive.google.com/uc⁠?
      2. Example Link - https://drive.google.com/uc?id=1ad44UTghbDty8o36Nrp3ZMyUzkPckIqY⁠

   
   Please verify the source of original APKs yourself with links provided. I'm not responsible for any damage caused.If you know any better/safe source to download clean. Open a discussion.

2. By default, script build the latest version mentioned in patches.json file.

3. Remember to download the Microg. Otherwise, you may not be able to open YouTube/YouTube Music.

4. By default, tool will build only youtube,youtube_music. To build other apps supported by patching resources.Add the apps you want to build in .env file or in ENVS in GitHub secrets in the format

   PATCH_APPS=<APP_NAME>
   

   Copy

   Example:

   PATCH_APPS=youtube,twitter,reddit
   

   Copy

   Tip - If for some reason you want to patch app but want to go through all this .env while running you can enter app name in
   to be patched box.

5. If APKMirror or other apk sources are blocked in your region or script somehow is unable to download from apkmirror. You can download apk manually from any source. Place them in /apks directory and provide environment variable in .env file or in ENVS in GitHub secrets(Recommended) in the format.

    EXISTING_DOWNLOADED_APKS=<Comma,Seperate,App,Name>
   

   Copy

   Example:

    EXISTING_DOWNLOADED_APKS=youtube,youtube_music
   

   Copy

   If you add above. Script will not download the youtube & youtube_musicapk from internet and expects an apk in /apks folder with same name.

6. If you run script again & again. You might hit GitHub API limit. In that case you can provide your Personal GitHub Access Token in .env file or in ENVS in GitHub secrets (Recommended) in the format -

    PERSONAL_ACCESS_TOKEN=<PAT>
   

   Copy

7. You can provide Direct download to the resource to used for patching apps .env file or in ENVS in GitHub secrets (Recommended) in the format -

    GLOBAL_CLI_DL=https://github.com/revanced/revanced-cli
    GLOBAL_PATCHES_DL=https://github.com/revanced/revanced-patches
    GLOBAL_PATCHES_JSON_DL=https://github.com/revanced/revanced-patches
    GLOBAL_INTEGRATIONS_DL=local://integrations.apk
   

   Copy

   Resources downloaded from envs and will be used for patching for any APP_NAME. Unless provided different resource for the individual app.
   
   Tool also support resource config at app level. You can patch A app with X resources while patching B with Y resources. This can be done by providing Direct download link for resources for app.
   Example:

    YOUTUBE_CLI_DL=https://github.com/inotia00/revanced-cli
    YOUTUBE_PATCHES_DL=https://github.com/inotia00/revanced-patches
    YOUTUBE_PATCHES_JSON_DL=https://github.com/inotia00/revanced-patches
    YOUTUBE_INTEGRATIONS_DL=https://github.com/inotia00/revanced-integrations
   

   Copy

   With the config tool will try to patch YouTube with resources from inotia00 while other global resource will used for patching other apps.
   If you have want to provide resource locally in the apks folder. You can specify that by mentioning filename prefixed with local://.
   Note - The link provided must be DLs. Unless they are from GitHub.
   Note - If your patches resource are available on GitHub and you want to select latest resource without excluding pre-release you can add latest-prerelease to the URL. Example:

    YOUTUBE_PATCHES_DL=https://github.com/inotia00/revanced-patches/releases/latest-prerelease
   

   Copy

   For above example tool while selecting latest patches will consider pre-releases/beta too.

   YOUTUBE_PATCHES_DL=https://github.com/inotia00/revanced-patches/releases/latest
   

   Copy

   For above example tool while selecting latest patches will exclude any pre-release/beta ie. will consider only stable releases..
   Note - Some of the patch source like inotia00 still provides - separated patches while revanced shifted to Space formatted patches. Use SPACE_FORMATTED_PATCHES to define the type of patches.

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
   

   Copy

   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
   

   Copy

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

    GLOBAL_OLD_KEY=False
   

   Copy

   if you are using different key for different apps. You need to specify at app level.

   YOUTUBE_OLD_KEY=False
   

   Copy

9. 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

    GLOBAL_OPTIONS_FILE=my_options.json
   

   Copy

   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_OPTIONS_FILE=my_cool_yt_options.json
   

   Copy

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
    

    Copy

    Tool also support configuring