docker-py-revanced
docker-py-revanced copied to clipboard
One Click Python util to build all Revanced apps.
Docker-Py-ReVanced
A little python script that will help you in building Revanced apps.
Build
You can use any of the following methods to build.
🚀In GitHub(Recommended)
-
Fork the project.
-
Add following secrets to the repo.
- GH_TOKEN (required) - GitHub token so that it can upload to GitHub after building. Click here to learn how to get that.
- VT_API_KEY (optional) - required only if you want Virus total scan.
- ENVS (optional) - 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
-
GitHub Secrets
might look like this(With VT_SCAN) -
After adding secrets,
ENVS
secret might look like thisPATCH_APPS=youtube_music,twitter EXCLUDE_PATCH_YOUTUBE=custom-branding EXCLUDE_PATCH_YOUTUBE_MUSIC=yt-music-is-shit YOUTUBE_VERSION=67.68.69 YOUTUBE_MUSIC_VERSION=latest TWITTER_VERSION=0.2.2 REDDIT_VERSION=latest TIKTOK_VERSION=latest WARNWETTER_VERSION=latest
-
Go to actions tab. Select
Build Revanced APK
.Click onRun Workflow
.- It can take a few minute to start. Just be patient.
🚶Detailed step by step guide
- Go to actions tab
- Check the status of build, It should look green.
- Check logs if something fails.
-
If the building process is successful, you’ll get your APKs in the releases
-
-
Click on
Build-<SomeRandomDate>
and download the apk file.
🐳With Docker
- Install Docker
- Run script with
docker-compose up
🫠Without Docker
- Install Java17 (zulu preferred)
- Install Python
- Create virtual environment
python3 -m venv venv
- Activate virtual environment
source venv/bin/activate
- Install Dependencies with
pip install -r requirements.txt
- Run the script with
python python main.py
Note
By default, script build the version as recommended by Revanced team.
- Supported values for <REVANCED_APPS_NAME> are :
- youtube
- youtube_music
- tiktok
- warnwetter
- If you want to build a specific version . Add
version
inenvironment
in the format
Example:<APPNAME>_VERSION=<VERSION>
YOUTUBE_VERSION=17.31.36 YOUTUBE_MUSIC_VERSION=X.X.X TWITTER_VERSION=X.X.X REDDIT_VERSION=X.X.X TIKTOK_VERSION=X.X.X WARNWETTER_VERSION=X.X.X
- If you want to build
latest
version, whatever latest is available(including beta) . Addlatest
inenvironment
in the format
Example:<APPNAME>_VERSION=latest
YOUTUBE_VERSION=latest YOUTUBE_MUSIC_VERSION=latest TWITTER_VERSION=latest REDDIT_VERSION=latest TIKTOK_VERSION=latest WARNWETTER_VERSION=latest
- By default, it will build all build app supported by Revanced team. If you
don't
want to waste time and build only few apps. Add the apps you want to build in
environment
in the format
Example:PATCH_APPS=<REVANCED_APPS_NAME>
PATCH_APPS=youtube,twitter,reddit
- If you don't want to use default keystore. You can provide your own by placing it
inside
apks
folder. And adding the name ofkeystore-file
inenvironment
likeKEYSTORE_FILE_NAME=revanced.keystore
- If you want to exclude any patch. Set comma separated patch in
environment
in the format
Example:EXCLUDE_PATCH_<REVANCED_APPS_NAME>=<PATCH_TO_EXCLUDE-1,PATCH_TO_EXCLUDE-2>
EXCLUDE_PATCH_YOUTUBE=custom-branding,hide-get-premium EXCLUDE_PATCH_YOUTUBE_MUSIC=yt-music-is-shit
- Remember to download the Microg. Otherwise, you will not be able to open YouTube.
Generate Token
- Go to your account developer settings.
Click on generate new token.
- Give a nice name. and grant following permissions
Thanks to @aliharslan0 for his work.