sjva/docker-py-revanced
1
0
Fork 0
mirror of https://github.com/sotam0316/docker-py-revanced.git synced 2026-04-25 03:48:37 +09:00
Code Issues Packages Projects Releases Wiki Activity

🎨 Updated docs

Browse Source
This commit is contained in:
Nikhil Badyal
2023-08-24 21:39:15 +05:30
parent 7d0e83eed1
commit 9853edcfef
2 changed files with 87 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
+60 -17
View File
@@ -1,29 +1,72 @@
#GLobal envs #Global:
PATCH_APPS=youtube,youtube_music,twitter EXTRA_FILES=https://github.com/inotia00/VancedMicroG/releases/latest@VancedMicroG.apk,https://github.com/inotia00/mMicroG/releases@mmicrog.apk
PATCH_APPS=youtube,youtube_revancify_red,youtube_revancify_blue,youtube_mmt,youtube_music,reddit
GLOBAL_CLI_DL=https://github.com/revanced/revanced-cli GLOBAL_CLI_DL=https://github.com/revanced/revanced-cli
GLOBAL_PATCHES_DL=https://github.com/revanced/revanced-patches GLOBAL_PATCHES_DL=https://github.com/revanced/revanced-patches
GLOBAL_PATCHES_JSON_DL=https://github.com/revanced/revanced-patches GLOBAL_PATCHES_JSON_DL=https://github.com/revanced/revanced-patches
GLOBAL_INTEGRATIONS_DL=https://github.com/revanced/revanced-integrations GLOBAL_INTEGRATIONS_DL=https://github.com/revanced/revanced-integrations
EXISTING_DOWNLOADED_APKS=youtube,youtube_music
#Example
EXISTING_DOWNLOADED_APKS=twitter
PERSONAL_ACCESS_TOKEN=ghp_asample_token PERSONAL_ACCESS_TOKEN=ghp_asample_token
#YouTune #YouTube:
YOUTUBE_CLI_DL=https://github.com/revanced/revanced-cli YOUTUBE_CLI_DL=https://github.com/inotia00/revanced-cli
YOUTUBE_PATCHES_DL=https://github.com/revanced/revanced-patches YOUTUBE_PATCHES_DL=https://github.com/YT-Advanced/ReX-patches
YOUTUBE_PATCHES_JSON_DL=https://github.com/revanced/revanced-patches YOUTUBE_PATCHES_JSON_DL=https://github.com/YT-Advanced/ReX-patches
YOUTUBE_INTEGRATIONS_DL=https://github.com/revanced/revanced-integrations YOUTUBE_INTEGRATIONS_DL=https://github.com/YT-Advanced/ReX-integrations
YOUTUBE_EXCLUDE_PATCH=custom-branding-icon-revancify-blue,custom-branding-icon-revancify-red,custom-branding-icon-mmt,custom-branding-youtube-name,enable-debug-logging
#Example
YOUTUBE_KEYSTORE_FILE_NAME=youtube.keystore YOUTUBE_KEYSTORE_FILE_NAME=youtube.keystore
YOUTUBE_ARCHS_TO_BUILD=arm64-v8a,armeabi-v7a YOUTUBE_ARCHS_TO_BUILD=arm64-v8a,armeabi-v7a
YOUTUBE_EXCLUDE_PATCH=custom-branding,hide-get-premium
YOUTUBE_INCLUDE_PATCH=remove-screenshot-restriction
YOUTUBE_VERSION=17.31.36
#YOUTUBE_MUSIC Music
YOUTUBE_MUSIC_CLI_DL=https://github.com/revanced/revanced-cli/releases/tag/v2.22.1 #YouTube Revancify Red:
YOUTUBE_MUSIC_PATCHES_DL=https://github.com/revanced/revanced-patches YOUTUBE_REVANCIFY_RED_PACKAGE_NAME=com.google.android.youtube
YOUTUBE_MUSIC_PATCHES_JSON_DL=https://github.com/revanced/revanced-patches YOUTUBE_REVANCIFY_RED_DL_SOURCE=https://www.apkmirror.com/apk/google-inc/youtube/
YOUTUBE_MUSIC_INTEGRATIONS_DL=https://github.com/revanced/revanced-integrations YOUTUBE_REVANCIFY_RED_CLI_DL=https://github.com/inotia00/revanced-cli
YOUTUBE_MUSIC_EXCLUDE_PATCH=yt-music-is-shit YOUTUBE_REVANCIFY_RED_PATCHES_DL=https://github.com/YT-Advanced/ReX-patches
YOUTUBE_REVANCIFY_RED_PATCHES_JSON_DL=https://github.com/YT-Advanced/ReX-patches
YOUTUBE_REVANCIFY_RED_INTEGRATIONS_DL=https://github.com/YT-Advanced/ReX-integrations
YOUTUBE_REVANCIFY_RED_EXCLUDE_PATCH=custom-branding-icon-revancify-blue,custom-branding-icon-mmt,custom-branding-youtube-name,enable-debug-logging
#YouTube Revancify Blue:
YOUTUBE_REVANCIFY_BLUE_PACKAGE_NAME=com.google.android.youtube
YOUTUBE_REVANCIFY_BLUE_DL_SOURCE=https://www.apkmirror.com/apk/google-inc/youtube/
YOUTUBE_REVANCIFY_BLUE_CLI_DL=https://github.com/inotia00/revanced-cli
YOUTUBE_REVANCIFY_BLUE_PATCHES_DL=https://github.com/YT-Advanced/ReX-patches
YOUTUBE_REVANCIFY_BLUE_PATCHES_JSON_DL=https://github.com/YT-Advanced/ReX-patches
YOUTUBE_REVANCIFY_BLUE_INTEGRATIONS_DL=https://github.com/YT-Advanced/ReX-integrations
YOUTUBE_REVANCIFY_BLUE_EXCLUDE_PATCH=custom-branding-icon-revancify-red,custom-branding-icon-mmt,custom-branding-youtube-name,enable-debug-logging
#YouTube MMT:
YOUTUBE_MMT_PACKAGE_NAME=com.google.android.youtube
YOUTUBE_MMT_DL_SOURCE=https://www.apkmirror.com/apk/google-inc/youtube/
YOUTUBE_MMT_CLI_DL=https://github.com/inotia00/revanced-cli
YOUTUBE_MMT_PATCHES_DL=https://github.com/YT-Advanced/ReX-patches
YOUTUBE_MMT_PATCHES_JSON_DL=https://github.com/YT-Advanced/ReX-patches
YOUTUBE_MMT_INTEGRATIONS_DL=https://github.com/YT-Advanced/ReX-integrations
YOUTUBE_MMT_EXCLUDE_PATCH=custom-branding-icon-revancify-blue,custom-branding-icon-revancify-red,custom-branding-youtube-name,enable-debug-logging
#YouTube Music:
YOUTUBE_MUSIC_CLI_DL=https://github.com/inotia00/revanced-cli
YOUTUBE_MUSIC_PATCHES_DL=https://github.com/YT-Advanced/ReX-patches
YOUTUBE_MUSIC_PATCHES_JSON_DL=https://github.com/YT-Advanced/ReX-patches
YOUTUBE_MUSIC_INTEGRATIONS_DL=https://github.com/YT-Advanced/ReX-integrations
YOUTUBE_MUSIC_EXCLUDE_PATCH=custom-branding-icon-mmt,custom-branding-icon-revancify-blue,custom-branding-icon-revancify-red,custom-branding-music-name,enable-compact-dialog,enable-debug-logging
YOUTUBE_MUSIC_VERSION=6.15.52
#Reddit
REDDIT_CLI_DL=https://github.com/inotia00/revanced-cli
REDDIT_PATCHES_DL=https://github.com/YT-Advanced/ReX-patches
REDDIT_PATCHES_JSON_DL=https://github.com/YT-Advanced/ReX-patches
REDDIT_INTEGRATIONS_DL=https://github.com/YT-Advanced/ReX-integrations
#Twitter #Twitter
TWITTER_VERSION=latest TWITTER_VERSION=latest
README.md
+27 -4
View File
@@ -152,14 +152,16 @@ You can use any of the following methods to build.
| [*APP_NAME*_EXCLUDE_PATCH**](#custom-exclude-patching) | Patches to exclude while patching **APP_NAME**. | [] | | [*APP_NAME*_EXCLUDE_PATCH**](#custom-exclude-patching) | Patches to exclude while patching **APP_NAME**. | [] |
| [*APP_NAME*_INCLUDE_PATCH**](#custom-include-patching) | Patches to include while patching **APP_NAME**. | [] | | [*APP_NAME*_INCLUDE_PATCH**](#custom-include-patching) | Patches to include while patching **APP_NAME**. | [] |
| [*APP_NAME*_VERSION**](#app-version) | Version to use for download for patching. | Recommended by patch resources | | [*APP_NAME*_VERSION**](#app-version) | Version to use for download for patching. | Recommended by patch resources |
| [*APP_NAME*_DL](#app-dl) | | | | [*APP_NAME*_DL](#app-dl) | Direct download Link for clean apk | None |
| [*APP_NAME*_DL_SOURCE](#any-patch-apps) | Download source of any of the supported scrapper | None |
| [*APP_NAME*_DL_SOURCE](#any-patch-apps) | Package name of the app to be patched | None |
`**` - By default all patches for a given app are included.<br> `**` - By default all patches for a given app are included.<br>
`**` - Can be used to included universal patch. `**` - Can be used to included universal patch.
## Note ## Note
1. Supported values for **APP_NAME** are : 1. <a id="any-patch-apps"></a>**Officially** Supported values for **APP_NAME**** are :
1. [youtube](https://www.apkmirror.com/apk/google-inc/youtube/) 1. [youtube](https://www.apkmirror.com/apk/google-inc/youtube/)
2. [youtube_music](https://www.apkmirror.com/apk/google-inc/youtube-music/) 2. [youtube_music](https://www.apkmirror.com/apk/google-inc/youtube-music/)
@@ -201,10 +203,31 @@ You can use any of the following methods to build.
38. [bacon](https://www.apkmirror.com/apk/onelouder-apps/baconreader-for-reddit/) 38. [bacon](https://www.apkmirror.com/apk/onelouder-apps/baconreader-for-reddit/)
39. [microg](https://github.com/inotia00/mMicroG/releases) 39. [microg](https://github.com/inotia00/mMicroG/releases)
40. [pixiv](https://www.apkmirror.com/apk/pixiv-inc/pixiv/) 40. [pixiv](https://www.apkmirror.com/apk/pixiv-inc/pixiv/)
<br>`**` - 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.
```ini
<APP_NAME>_DL_SOURCE=<apk-link-to-any-of-the-suppored-scrapper>
<APP_NAME>_PACKAGE_NAME=<package-name-of-the-application>
```
You can also provide DL to the clean apk instead of providing DL_SOURCES as mentioned in this [note](#app-dl)
Supported Scrappers are
1. APKMIRROR - Supports downloading any versions
1. Link Format - https://www.apkmirror.com/apk/<organisation-name>/app-name/
2. Example Link - https://www.apkmirror.com/apk/google-inc/youtube/
2. UPTODOWN - Supports downloading any versions
1. Link Format - https://<app-name>.en.uptodown.com/android
2. Example Link - https://spotify.en.uptodown.com/android
3. APKSOS - Supports downloading any versions
1. Link Format - https://apksos.com/download-app/<package-name>
2. Example Link - https://apksos.com/download-app/com.expensemanager
4. APKPURE - Supports downloading only latest version
1. Link Format - https://d.apkpure.com/b/APK/<package-name>?version=latest
2. Example Link - https://d.apkpure.com/b/APK/com.google.android.youtube?version=latest
<br>Please verify the source of original APKs yourself with links provided. I'm not responsible for any damage <br>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. caused.If you know any better/safe source to download clean. Open a discussion.
2. By default, script build the latest version as recommended by `patches.json` team.
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. 3. Remember to download the **_Microg_**. Otherwise, you may not be able to open YouTube/YouTube Music.
4. <a id="patch-apps"></a>By default, tool will build only `youtube`. To build other apps supported by patching 4. <a id="patch-apps"></a>By default, tool will build only `youtube`. 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 resources.Add the apps you want to build in `.env` file or in `ENVS` in `GitHub secrets` in the format