From 70a695017eb833afef326fe77f27fa8642238752 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Thu, 22 May 2025 14:15:44 +0200 Subject: [PATCH] docs: Update docs with all manager features and improve consistency --- docs/1_installation.md | 2 +- docs/2_1_patching.md | 33 +++++++++++++------------ docs/2_2_managing.md | 15 ----------- docs/2_2_managing_apps.md | 15 +++++++++++ docs/2_3_managing_patches.md | 22 +++++++++++++++++ docs/2_3_updating.md | 13 ---------- docs/2_4_settings.md | 39 ----------------------------- docs/2_4_updating.md | 18 ++++++++++++++ docs/2_5_settings.md | 37 +++++++++++++++++++++++++++ docs/2_usage.md | 16 ++++++------ docs/3_troubleshooting.md | 37 ++++++++++----------------- docs/4_building.md | 48 ++++++++++++++++++------------------ 12 files changed, 156 insertions(+), 139 deletions(-) delete mode 100644 docs/2_2_managing.md create mode 100644 docs/2_2_managing_apps.md create mode 100644 docs/2_3_managing_patches.md delete mode 100644 docs/2_3_updating.md delete mode 100644 docs/2_4_settings.md create mode 100644 docs/2_4_updating.md create mode 100644 docs/2_5_settings.md diff --git a/docs/1_installation.md b/docs/1_installation.md index d4c08984..1737d5c7 100644 --- a/docs/1_installation.md +++ b/docs/1_installation.md @@ -4,7 +4,7 @@ In order to use ReVanced on your Android device, ReVanced Manager must be instal ## โœ… Installation steps -1. Download the latest version of ReVanced Manager from [here](https://github.com/revanced/revanced-manager/releases/latest) +1. Download the latest version of ReVanced Manager at [revanced.app/download](https://revanced.app/download) or from [GitHub releases](https://github.com/ReVanced/revanced-manager/releases/latest) 2. Install ReVanced Manager ## โญ๏ธ What's next diff --git a/docs/2_1_patching.md b/docs/2_1_patching.md index 7203affa..c48af413 100644 --- a/docs/2_1_patching.md +++ b/docs/2_1_patching.md @@ -1,25 +1,26 @@ -# ๐Ÿงฉ Patching apps +# ๐Ÿ’‰ Patching apps -The following pages will guide you through using ReVanced Manager to patch apps. +Learn how to use ReVanced Manager to patch apps. ## โœ… Steps to patch apps -1. Navigate to the Apps tab from the top navigation bar -2. Tap the + button in the bottom right corner -3. Choose an app to patch[^1] -4. Tap on the version of the app you want to patch[^2] -5. Select the patches you want to apply -6. Tap the Patch button -7. Tap on the **Install** button - > **Note**: If you are rooted, you can mount the patched app on top of the original app.[^3] - > Optionally, you may export the patched app to storage using the options in the top right corner. +1. Navigate to the `Apps` tab at the top navigation bar +2. Tap on the `+` button in the bottom right corner +3. Select an app to patch.[^1] +4. Optionally change the selection of patches[^2] +5. Optionally select a specific downloader to download the app[^3] +6. Tap on the `Patch` button to begin the patching process +7. Tap on the `Install` button to install the patched app[^4] -[^1]: Non-root users may be prompted to select an APK from storage, in which case you have to source the APK file yourself. ReVanced does not provide any APK files. -[^2]: It is suggested to use the version with the most patches to get the most out of ReVanced. -[^3]: Mounting the patched app on top of the original app will only work if the installed app version matches the version of the app selected in step 4. above. +[^1]: Here you can see all the apps that are supported by ReVanced. +You can also add custom apps by tapping on the `+` button in the top right corner. +[^2]: It is recommended to use the default set of patches by tapping on the `Reset` button in the bottom right corner. +[^3]: By default, all available downloader will be used to download the app. +If you want to use a specific downloader, you can change it here. +[^4]: You can export the patched app or the patch logs in the bottom left corner. ## โญ๏ธ What's next -The next page will bring you back to the usage page. +The next page will explain how to view, open, re-patch or uninstall apps. -Continue: [๐Ÿ› ๏ธ Usage](2_usage.md) +Continue: [๐Ÿงฐ Managing apps](2_2_managing_apps.md) diff --git a/docs/2_2_managing.md b/docs/2_2_managing.md deleted file mode 100644 index 29ec56fc..00000000 --- a/docs/2_2_managing.md +++ /dev/null @@ -1,15 +0,0 @@ -# ๐Ÿงฐ Managing patched apps - -After patching an app, you may want to manage it. This page will guide you through managing patched apps. - -## โœ… Steps to manage patched apps - -1. Navigate to the Apps tab from the top navigation bar -2. Select the app you want to manage -3. -## โญ๏ธ What's next - -The next page will bring you back to the usage page. - -Continue: [๐Ÿ› ๏ธ Usage](2_usage.md) - diff --git a/docs/2_2_managing_apps.md b/docs/2_2_managing_apps.md new file mode 100644 index 00000000..1f194380 --- /dev/null +++ b/docs/2_2_managing_apps.md @@ -0,0 +1,15 @@ +# ๐Ÿงฐ Managing apps + +Learn how to view, open, re-patch or uninstall apps. + +## โœ… Steps to manage patched apps + +1. Navigate to the `Apps` tab at the top navigation bar +2. Select the app you want to view, open, re-patch or uninstall + +## โญ๏ธ What's next + +The next page will explain how to add new, manage existing or remove patches. + +Continue: [๐Ÿงฉ Managing patches](2_3_managing_patches.md) + diff --git a/docs/2_3_managing_patches.md b/docs/2_3_managing_patches.md new file mode 100644 index 00000000..dce3389c --- /dev/null +++ b/docs/2_3_managing_patches.md @@ -0,0 +1,22 @@ +# ๐Ÿงฉ Managing patches + +Learn how to add new, manage existing or remove patches. + +## โœ… Steps to manage patches + +1. Navigate to the `Patches` tab at the top navigation bar +2. Tap on the `+` button in the bottom right corner +3. Chose one of the options to add new patches[^1]: + - **Enter URL**: Add patches from a remote location + - **Select from storage**: Add patches from your local storage +4. Select one of the patches from the list to manage or remove it + +[^1]: The selected file must be a JSON using the [ReVanced API](https://github.com/revanced/revanced-api) format +(Example: `https://api.revanced.app/v4/patches`). + +## โญ๏ธ What's next + +The next page will explain how to update ReVanced Manager. + +Continue: [๐Ÿ”„ Updating ReVanced Manager](2_4_updating.md) + diff --git a/docs/2_3_updating.md b/docs/2_3_updating.md deleted file mode 100644 index 2b42104c..00000000 --- a/docs/2_3_updating.md +++ /dev/null @@ -1,13 +0,0 @@ -# ๐Ÿ”„ Updating ReVanced Manager - -In order to keep up with the latest features and bug fixes, it is recommended to keep ReVanced Manager up to date. - -## โœ… Updating steps - -> Currently not implemented - -## โญ๏ธ What's next - -The next page will bring you back to the usage page. - -Continue: [๐Ÿ› ๏ธ Usage](2_usage.md) diff --git a/docs/2_4_settings.md b/docs/2_4_settings.md deleted file mode 100644 index 008cda46..00000000 --- a/docs/2_4_settings.md +++ /dev/null @@ -1,39 +0,0 @@ -# โš™๏ธ Configuring ReVanced Manager - -ReVanced Manager has settings that can be configured to your liking. - -## โญ Essential settings - -- ### ๐Ÿ”— API URL - - Specify the URL of the API to use. This is used to fetch ReVanced Patches and update ReVanced Manager. - -- ### ๐Ÿงฌ Sources - - Override the API and change the source of ReVanced Patches. - -- ### ๐Ÿงช Experimental ReVanced Patches support - - Lift app version constraints from ReVanced Patches. This allows you to patch any version of an app, even if the patch is not explicitly compatible with it. - -- ### ๐Ÿง‘โ€๐Ÿ”ฌ Experimental universal support - - This will show or hide ReVanced Patches, which are not meant for any app in particular but rather for all apps but may not work on all apps. - -- ### ๐Ÿ”‘ Export, import or delete keystore - - Manage the keystore used to sign patched apps. - -- ### ๐Ÿ“„ Export, import or reset ReVanced Patches selection - - Manage the ReVanced Patches selection. This is useful if you want to share your ReVanced Patches selection with others or reset it to the default selection. - -- ### โ„น๏ธ About - - View information about your device and ReVanced Manager. This includes the version of ReVanced Manager and supported architectures of your device. - -## โญ๏ธ What's next - -The next page will bring you back to the usage page. - -Continue: [๐Ÿ› ๏ธ Usage](2_usage.md) diff --git a/docs/2_4_updating.md b/docs/2_4_updating.md new file mode 100644 index 00000000..52fa94d2 --- /dev/null +++ b/docs/2_4_updating.md @@ -0,0 +1,18 @@ +# ๐Ÿ”„ Updating ReVanced Manager + +Learn how to update ReVanced Manager. + +## โœ… Steps to update ReVanced Manager + +1. Navigate to the settings by tapping on the settings icon in the top right corner +2. Navigate to the `Updates` screen +3. Configure the update settings accordingly[^1] + +[^1]: By default, ReVanced Manager will check for updates automatically on launch +and let you when an update is available. + +## โญ๏ธ What's next + +The next page will explain how to configure ReVanced Manager. + +Continue: [โš™๏ธ Configuring ReVanced Manager](2_5_settings.md) diff --git a/docs/2_5_settings.md b/docs/2_5_settings.md new file mode 100644 index 00000000..c8ddd3b9 --- /dev/null +++ b/docs/2_5_settings.md @@ -0,0 +1,37 @@ +# โš™๏ธ Configuring ReVanced Manager + +Learn how to configure ReVanced Manager. + +## ๐Ÿ”ง Settings + +- **Import & export**: Import or export patch selections, patch options and the signing keystore +- **Downloads**: Enable or disable ReVanced Manager downloader and manage past downloaded apps here +- **Advanced**: + - **API URL**: Set the URL of the ReVanced API, ReVanced Manager will use + - **Disable version compatibility check**: Patching versions of apps the patches are explicitly compatible with is enforced. + Disabling this will allow patching versions of apps the patches are not explicitly compatible with + > โš ๏ธ Warning + > Patches may fail patching versions they are not explicitly compatible with. + > Unless you know what you are doing, it is recommended to keep this enabled. + - **Allow changing patch selection**: The default selection of patches is enforced. + Enabling this will allow you to change the patch selection + > โš ๏ธ Warning + > Changing the selection may cause unexpected issues. + > Unless you know what you are doing, it is recommended to keep this disabled. + - **Require suggested app version**: Specific versions of apps is enforced based on the patch selection automatically. + Disabling this will allow you to patch any version of apps + > โš ๏ธ Warning + > Patches not compatible with the selected version of the app will not be used. + > Unless you know what you are doing, it is recommended to keep this enabled. + - **Allow universal patches**: Patches that do not specify compatibility with an app explicitly are forcibly disabled. + Enabling this will allow selecting such patches + > โš ๏ธ Warning + > Universal patches do not specify compatibility with an app explicitly may not work on all apps regardless. + > Unless you know what you are doing, it is recommended to keep this disabled. +- **About**: View more information and links about ReVanced and ReVanced Manager. + +## โญ๏ธ What's next + +The next page will explain how to troubleshoot issues with ReVanced Manager. + +Continue: [โ“ Troubleshooting](3_troubleshooting.md) diff --git a/docs/2_usage.md b/docs/2_usage.md index f079782f..c26172f4 100644 --- a/docs/2_usage.md +++ b/docs/2_usage.md @@ -1,16 +1,18 @@ # ๐Ÿ› ๏ธ Usage -The following pages will guide you through using ReVanced Manager to patch apps, manage patched apps, and update ReVanced Manager. +The following pages will guide you through using ReVanced Manager to patch and manage apps, +manage patches, and update or configure ReVanced Manager. ## ๐Ÿ“– Table of contents -1. [๐Ÿงฉ Patching apps](2_1_patching.md) -2. [๐Ÿงฐ Managing patched apps](2_2_managing.md) -3. [๐Ÿ”„ Updating ReVanced Manager](2_3_updating.md) -4. [โš™๏ธ Configuring ReVanced Manager](2_4_settings.md) +1. [๐Ÿ’‰ Patching apps](2_1_patching.md) +2. [๐Ÿงฐ Managing apps](2_2_managing_apps.md) +3. [๐Ÿงฉ Managing patches](2_3_managing_patches.md) +4. [๐Ÿ”„ Updating ReVanced Manager](2_4_updating.md) +5. [โš™๏ธ Configuring ReVanced Manager](2_5_settings.md) ## โญ๏ธ What's next -The next page will guide you through troubleshooting ReVanced Manager. +The next page will explain how to use ReVanced Manager to patch apps. -Continue: [โ” Troubleshooting](3_troubleshooting.md) +Continue: [๐Ÿ’‰ Patching apps](2_1_patching.md) diff --git a/docs/3_troubleshooting.md b/docs/3_troubleshooting.md index 5a860c6b..da368716 100644 --- a/docs/3_troubleshooting.md +++ b/docs/3_troubleshooting.md @@ -1,31 +1,20 @@ -# โ” Troubleshooting +# โ“ Troubleshooting -In case you encounter any issues while using ReVanced Manager, please refer to this page for possible solutions. +Find common issues and their solutions below. -- ๐Ÿ’‰ Patching fails with an error +## ๐Ÿ†˜ Common issues - Make sure ReVanced Manager is up to date by following [๐Ÿ”„ Updating ReVanced Manager](2_3_updating.md) and select the **Default** button when choosing patches. - -- ๐Ÿ’ฅ App not installed as package conflicts with an existing package - - An existing installation of the app you're trying to patch is conflicting with the patched app. Uninstall the existing app before installing the patched app. - -- โ—๏ธ Error code `135`, `139` or `1` when patching the app - - Your device is not supported. Refer to the [Prerequisites](0_prerequisites.md) page for supported devices. - - Alternatively, you can use [ReVanced CLI](https://github.com/revanced/revanced-cli) to patch the app. - -- ๐Ÿšซ Non-root install is not possible with the current patches selection - - Select the **Default** button when choosing patches. - -- ๐Ÿšจ Patched app crashes on launch - - Select the **Default** button when choosing patches. +- **Patching fails with an error or patched app crashes**: + - Make sure ReVanced Manager is up to date by following [๐Ÿ”„ Updating ReVanced Manager](2_4_updating.md) + - Reset the safeguard settings under `Settings` > `Advanced` to their default values + - If a patch has options, reset them to their default values or correctly configure them + - Make sure you are patching a full APK file and not an [APK bundle](https://developer.android.com/guide/app-bundle/app-bundle-format) +- **Patches fail to load**: The selected file is not using the ReVanced API format or the remote URL is not reachable. +- **Patching takes too long**: Make sure you are using a device with enough storage space and free memory. + Be patient during the patching process. ## โญ๏ธ What's next -The next page will teach you how to build ReVanced Manager from source. +Learn how to build ReVanced Manager from source. -Continue: [๐Ÿ”จ Building from source](4_building.md) +Continue: [๐Ÿ”จ Build from source](4_building.md) diff --git a/docs/4_building.md b/docs/4_building.md index 56917e5f..9e52014d 100644 --- a/docs/4_building.md +++ b/docs/4_building.md @@ -1,8 +1,18 @@ -# ๐Ÿ› ๏ธ Building from source +# ๐Ÿ› ๏ธ Build from source This page will guide you through building ReVanced Manager from source. -1. Download Java SDK 17 ([Azul JDK](https://www.azul.com/downloads/?version=java-17-lts&package=jdk#zulu) or [OpenJDK](https://jdk.java.net/java-se-ri/17)) and add it to path +1. Install Java Development Kit 17 (e.g. [Temurin JDK](https://adoptium.net/temurin/releases/?os=any&arch=any&version=17)) + + Using [WinGet](https://learn.microsoft.com/en-us/windows/package-manager/winget): + ``sh + winget install EclipseAdoptium.Temurin.17.JDK + `` + + Using [SDKMAN!](https://sdkman.io/): + ```sh + sdk install java 17.0.15-tem + ``` 2. Clone the repository @@ -10,29 +20,19 @@ This page will guide you through building ReVanced Manager from source. git clone https://github.com/revanced/revanced-manager.git && cd revanced-manager ``` -3. Create a GitHub personal access token with the `read:packages` scope [here](https://github.com/settings/tokens/new?scopes=read:packages&description=ReVanced) +3. Build the APK -4. Add your GitHub username and the token to `~/.gradle/gradle.properties` - - ```properties - gpr.user = YourUsername - gpr.key = ghp_longrandomkey - ``` - -5. Set the `sdk.dir` property in `local.properties` to your Android SDK location - - ```properties - sdk.dir = /path/to/android/sdk - ``` - -6. Build the APK - - Debug: ```sh - ./gradlew assembleDebug + ./gradlew assembleRelease ``` - Release: - ```sh - ./gradlew assembleRelease -Psign - ``` +> [!NOTE] +> If the build fails due to authentication, you may need to authenticate to GitHub Packages. +> Create a personal access tokens with the scope `read:packages` [here](https://github.com/settings/tokens/new?scopes=read:packages&description=ReVanced) and add your token to ~/.gradle/gradle.properties. Create the file if it does not exist. +> +> Example `gradle.properties` file: +> +> ```properties +> gpr.user = +> gpr.key = +> ```