diff --git a/README.md b/README.md index 7c22698..d1c6160 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ Note - I prefer [Revanced Extended](https://github.com/inotia00/revanced-patches Revanced Extended. ## Pre-Built APKs + You can get pre-built apks [here](https://t.me/revanced_apkss) ## Build Yourself @@ -14,33 +15,32 @@ You can get pre-built apks [here](https://t.me/revanced_apkss) You can use any of the following methods to build. - 🚀In GitHub (**_`Recommended`_**) - 1. Fork the project. - ![fork] - 2. Add `ENVS` (**optional**) secret to the repo. Required only if you want to cook specific apps/versions. -
- 🚶Detailed step by step guide + 1. Fork the project. + ![fork] + 2. 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 - ![step_1] - - Add Repository secret - ![step_2] - -
- - 3. Go to actions tab. Select `Build & Release`.Click on `Run Workflow`. - -
- 🚶Detailed step by step guide - - - Go to actions tab - ![action_0] - - Check the status of build, It should look green. - ![build_wait] + - Go to the repo settings and then to actions->secret + ![step_1] + - Add Repository secret + ![step_2]
- 4. If the building process is successful, you’ll get your APKs in the ![apks] + 3. Go to actions tab. Select `Build & Release`.Click on `Run Workflow`. +
+ 🚶Detailed step by step guide + + - Go to actions tab + ![action_0] + - Check the status of build, It should look green. + ![build_wait] + +
+ + 4. If the building process is successful, you’ll get your APKs in the ![apks]
🐳With Docker Compose @@ -85,11 +85,11 @@ You can use any of the following methods to build. curl -fsSL https://get.docker.com -o get-docker.sh sh get-docker.sh ``` -2. Run script with - ```shell - docker run -v "$(pwd)"/apks:/app/apks/ nikhilbadyal/docker-py-revanced - ``` - You can pass below envs with `-e` flag. +2. Run script with + ```shell + docker run -v "$(pwd)"/apks:/app/apks/ nikhilbadyal/docker-py-revanced + ``` + You can pass below envs with `-e` flag.
@@ -97,44 +97,44 @@ You can use any of the following methods to build.
🫠Without Docker -1. Install Java17 (zulu preferred) -2. Install Python -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 python main.py - ``` +1. Install Java17 (zulu preferred) +2. Install Python +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 python main.py + ``` +
- ### Note + (Pay attention to 3,4)
By default, script build the version as recommended by Revanced team. 1. Supported values for **__** are : - 1. youtube - 2. youtube_music - 3. twitter - 4. reddit - 5. tiktok - 6. warnwetter - 7. spotify + 1. youtube + 2. youtube_music + 3. twitter + 4. reddit + 5. tiktok + 6. warnwetter + 7. spotify 2. Remember to download the **_Microg_**. Otherwise, you will not be able to open YouTube. -3. By default, it will build [all](#note) 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 `.env` file or in `ENVS` in +3. By default, it will build only `youtube`. To build other apps supported by revanced team. + Add the apps you want to build in `.env` file or in `ENVS` in `GitHub secrets` in the format ```ini PATCH_APPS= @@ -208,19 +208,19 @@ By default, script build the version as recommended by Revanced team. BUILD_EXTENDED=False ``` 9. For Telegram Upload. - 1. Set up a telegram channel, send a message to it and forward the message to - this telegram [bot](https://t.me/username_to_id_bot) - 2. Copy `id` and save it to `TELEGRAM_CHAT_ID`
- ![chat id] - 3. `TELEGRAM_BOT_TOKEN` - Telegram provides BOT_TOKEN. It works as sender. Open [bot](https://t.me/BotFather) and + 1. Set up a telegram channel, send a message to it and forward the message to + this telegram [bot](https://t.me/username_to_id_bot) + 2. Copy `id` and save it to `TELEGRAM_CHAT_ID`
+ ![chat id] + 3. `TELEGRAM_BOT_TOKEN` - Telegram provides BOT_TOKEN. It works as sender. Open [bot](https://t.me/BotFather) and create one copy api key
- ![bot api] - 4. `TELEGRAM_API_ID` - Telegram API_ID is provided by telegram [here](https://my.telegram.org/apps)
- ![tg api] - 5. `TELEGRAM_API_HASH` - Telegram API_HASH is provided by telegram [here](https://my.telegram.org/apps)
- ![tg api hash] - 6. After Everything done successfully the actions secrets of the repository will look something like
- + ![bot api] + 4. `TELEGRAM_API_ID` - Telegram API_ID is provided by telegram [here](https://my.telegram.org/apps)
+ ![tg api] + 5. `TELEGRAM_API_HASH` - Telegram API_HASH is provided by telegram [here](https://my.telegram.org/apps)
+ ![tg api hash] + 6. After Everything done successfully the actions secrets of the repository will look something like
+ 10. Configuration defined in `ENVS` in `GitHub secrets` will override the configuration in `.env` file. You can use this fact to define your normal configurations in `.env` file and sometimes if you want to build something different just once. Add it in `GitHub secrets` or you can ignore `.env` file and always use `GitHub secrets` because to modify @@ -247,16 +247,27 @@ By default, script build the version as recommended by Revanced team. 14. Sample Envs ![envs] [fork]: https://i.imgur.com/R5HdByI.png + [secrets]: https://i.imgur.com/083Bjpg.png + [step_1]: https://i.imgur.com/Inj82KK.png + [step_2]: https://i.imgur.com/V2Wfx3J.png + [action_0]: https://i.imgur.com/XSCvzav.png + [build_wait]: https://i.imgur.com/CsJt9W1.png + [apks]: https://i.imgur.com/S5d7qAO.png + [chat id]: https://i.imgur.com/22UiaWs.png + [bot api]: https://i.imgur.com/A6JCyK2.png + [tg api]: https://i.imgur.com/eha3nnb.png + [tg api hash]: https://i.imgur.com/7n5k1mp.png + [envs]: https://i.imgur.com/ajSE5nA.png Thanks to [@aliharslan0](https://github.com/aliharslan0/pyrevanced) for his work. diff --git a/src/config.py b/src/config.py index daf996d..2eaf531 100644 --- a/src/config.py +++ b/src/config.py @@ -5,7 +5,7 @@ from typing import List from environs import Env from requests import Session -from src.utils import supported_apps +from src.utils import default_build class RevancedConfig: @@ -20,7 +20,7 @@ class RevancedConfig: self.apk_mirror = "https://www.apkmirror.com" self.upto_down = ["spotify"] self.keystore_name = env.str("KEYSTORE_FILE_NAME", "revanced.keystore") - self.apps = env.list("PATCH_APPS", supported_apps) + self.apps = env.list("PATCH_APPS", default_build) self.extended_apps: List[str] = ["youtube", "youtube_music"] self.rip_libs_apps: List[str] = ["youtube"] self.normal_cli_jar = "revanced-cli.jar" diff --git a/src/utils.py b/src/utils.py index e6cb552..73801d7 100644 --- a/src/utils.py +++ b/src/utils.py @@ -1,14 +1,8 @@ """Utilities.""" from typing import Dict -supported_apps = [ +default_build = [ "youtube", - "youtube_music", - "twitter", - "reddit", - "tiktok", - "warnwetter", - "spotify", ] possible_archs = ["armeabi-v7a", "x86", "x86_64", "arm64-v8a"]