ReVanced/revanced-manager
1
0
Fork 0
mirror of https://github.com/revanced/revanced-manager.git synced 2025-06-12 20:57:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: Migrate to compose-dev branch

Browse Source
This commit is contained in:
oSumAtrIX
2025-05-20 13:45:09 +02:00
parent b0464408f1
commit 0b19a9865d
260 changed files with 813 additions and 40226 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/0_prerequisites.md
View File

@ -1,14 +0,0 @@
# 💼 Prerequisites
To use ReVanced Manager, you need to fulfill certain requirements.
## 🤝 Requirements
- Android device running Android 8.0 or higher
- Device's CPU supporting at least `arm64-v8a`, `armeabi-v7a`, or `x86_64` architecture(s)
## ⏭️ What's next
The next page will explain how to install ReVanced Manager.
Continue: [⬇️ Installation](1_installation.md)

14
docs/1_installation.md
View File

@ -1,14 +0,0 @@
# ⬇️ Installation
To use ReVanced on your Android device, ReVanced Manager must be first installed.
## ✅ Installation steps
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
The next page explain how to use ReVanced Manager to update ReVanced Manager and manage or patch apps.
Continue: [🛠️ Usage](2_usage.md)

46
docs/2_1_patching.md
View File

@ -1,46 +0,0 @@
# 🧩 Patching apps
Learn how to use ReVanced Manager to patch apps.
## ✅ Steps to patch apps
1. Navigate to the **Patcher** tab from the bottom navigation bar
2. Tap on the **Select an app** card
3. Choose an app to patch[^1]
> ℹ️ Note
> The suggested version is visible on each app's card.
> You can tap on it to open a search query to obtain an APK file for the selected app with the suggested version
> 💡 Tip
> If you are prompted to select an APK file from storage because the selected app is a split APK, tap on the "Suggested version" label to open a search query to obtain said APK file
4. Tap on the **Select patches** card and select the patches you want to apply[^2].
> ℹ️ Note
> Some patches have options that can or must be configured by tapping on ⚙️ icon next to the patch name.
> ⚠️ Warning
> If you see a warning, you can click on it for more information.
5. Tap on the **Done** then **Patch** button
> ⚠️ Warning
> The patching process may take ~5 minutes. Exiting the app may cancel patching or significantly increase the time it takes to patch.
6. Tap on the **Install** button
> ℹ️ Note
> If you are rooted, you can mount[^3] the patched app on top of the original app.[^4]
> Optionally, you may export the patched app to storage using the option in the bottom left corner.
[^1]: You can select installed apps from the list of installed apps or APK files from device storage. ReVanced does not provide any APK files, so you must source them yourself.
[^2]: It is suggested to use the default set of patches by tapping on the **Default** button above the list of patches.
[^3]: Mounting refers to using Linux's mounting mechanism to layer the patched app on top of the existing installed app.
[^4]: Mounting the patched app on top of the original app may only work if the installed app version matches the version of the app selected in step 3. above.
## ⏭️ What's next
The next page will explain how to view, open and uninstall patched apps.
Continue: [🧰 Managing patched apps](2_2_managing.md)

15
docs/2_2_managing.md
View File

@ -1,15 +0,0 @@
# 🧰 Managing patched apps
Learn how to view, open and uninstall patched apps.
## ✅ Steps to view, open and uninstall patched apps
1. Tap on the **Dashboard** tab in the bottom navigation bar
2. Tap on the **Info** button for the app you want to manage
3. Choose any of the options from the menu to view, open or uninstall the app
## ⏭️ What's next
The next page will explain how to update ReVanced Manager.
Continue: [🔄 Updating ReVanced Manager](2_3_updating.md)

14
docs/2_3_updating.md
View File

@ -1,14 +0,0 @@
# 🔄 Updating ReVanced Manager
Learn how to update ReVanced Manager.
## ✅ Updating steps
1. Navigate to the **Dashboard** tab from the bottom navigation bar
2. Tap on the **Update** button in the **Updates** section
## ⏭️ What's next
The next page will explain how to configure ReVanced Manager.
Continue: [⚙️ Configuring ReVanced Manager](2_4_settings.md)

66
docs/2_4_settings.md
View File

@ -1,66 +0,0 @@
# ⚙️ Configuring ReVanced Manager
Learn how to configure ReVanced Manager.
## 🎛️ Essential settings
- ### 🪛 Allow changing patch selection
By default, you can not change the patch selection and the default selection is used. 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
By default, ReVanced Manager allows you to patch an app if the suggested version to patch matches the version of the app you selected. Disabling this will allow you to patch an app even if the suggested version does not match the version of the app you selected.
> ⚠️ Warning
> Patches are more likely to fail on versions that are not suggested by ReVanced Manager. Unless you know what you are doing, it is recommended to keep this enabled.
- ### ✅ Version compatibility check
By default, ReVanced Manager does not allow you to select patches that are not compatible with the version of the app you selected. Disabling this will allow you to select patches that are not compatible with the version of the app you selected.
> ⚠️ Warning
> Patches are more likely to fail on versions they are not compatible with. Unless you know what you are doing, it is recommended to keep this enabled.
- ### 🧑‍🔬 Show universal patches
By default, ReVanced Manager only shows patches that are compatible with specific apps. Enabling this will show patches that are intended to work on all apps.
> ⚠️ Warning
> Patches that are intended to may not work on all apps. Unless you know what you are doing, it is recommended to keep this disabled.
- ### 🔗 API URL
Configure the API URL to use. The API is used to download patches and updates.
- ### 🧬 Use alternative source
Use alternative sources for patches and integrations instead of the API.
> ℹ️ Note
> ReVanced Manager will still use the API for updates.
- ### 💾 Import, export and reset options
You can import, export or reset saved settings. This includes:
- 🔑 Keystore used to sign patched apps
- 📄 Remembered selection of patches for each app
- ⚙️ Remembered patch options
- 🛠️ Remembered settings
> ℹ️ Note
> These can be used to backup and restore or reset settings to default in case of issues.
- ### ❓ About
View information about your device and ReVanced Manager. This includes the version of ReVanced Manager and architectures your device supports.
## ⏭️ What's next
The next page will explain how to troubleshoot issues with ReVanced Manager.
Continue: [❔ Troubleshooting](3_troubleshooting.md)

16
docs/2_usage.md
View File

@ -1,16 +0,0 @@
# 🛠️ Usage
Learn how to use ReVanced Manager to manage and patch apps or update 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)
## ⏭️ What's next
The next page will explain how to use ReVanced Manager to patch apps.
Continue: [🧩 Patching apps](2_1_patching.md)

32
docs/3_troubleshooting.md
View File

@ -1,32 +0,0 @@
# ❔ Troubleshooting
In case you encounter any issues while using ReVanced Manager, this page will help you troubleshoot them.
- 💉 Common issues during or after patching
- Make sure ReVanced Manager is up to date by following [🔄 Updating ReVanced Manager](2_3_updating.md)
- You may have changed settings in ReVanced Manager that are not recommended to change. Please review the warnings that appear when adjusting these settings and reset them to their default configuration as explained in [⚙️ Configuring ReVanced Manager](2_4_settings.md)
- 🚫 App not installed as package conflicts with an existing package
An existing installation of the app you're trying to patch conflicts with the patched app (i.e., signature mismatch or downgrade). Uninstall the existing app before installing the patched app.
> 💡 Tip
> This may also be caused by changing settings in ReVanced Manager that are not recommended to change. Please review the warnings that appear when adjusting these settings and reset them to their default configuration as explained in [⚙️ Configuring ReVanced Manager](2_4_settings.md)
- ❗️ Error code `135`, `139` or `1` when patching the app
- You may be trying to patch a split APK[^1]. This can fail under certain circumstances. If that is the case, patch a full APK
- Your device may otherwise be unsupported. Please look at the [Prerequisites](0_prerequisites.md) page to see if your device is supported. Alternatively, you can use [ReVanced CLI](https://github.com/revanced/revanced-cli) to patch the app.
- 🚨 Patched app crashes on launch
This may also be caused by changing settings in ReVanced Manager that are not recommended to change. Please review the warnings that appear when adjusting these settings and reset them to their default configuration as explained in [⚙️ Configuring ReVanced Manager](2_4_settings.md)
## ⏭️ What's next
The next page will teach you how to build ReVanced Manager from source.
Continue: [🔨 Building from source](4_building.md)
[^1]: https://developer.android.com/guide/app-bundle/app-bundle-format

41
docs/4_building.md
View File

@ -1,41 +0,0 @@
# 🛠️ Building from source
Learn how to build ReVanced Manager from source.
1. Setup the Flutter environment for your [platform](https://docs.flutter.dev/get-started/install)
2. Clone the repository
```sh
git clone https://github.com/revanced/revanced-manager.git && cd revanced-manager
```
3. Get dependencies
```sh
flutter pub get
```
4. Generate temporary files
```sh
dart run slang
dart run build_runner build -d
```
5. Build the APK
```sh
flutter build apk
```
> [!NOTE]
> If the build fails due to authentication, you may need to authenticate to GitHub Packages.
> Create a PAT 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.
>
> Example `gradle.properties` file:
>
> ```properties
> gpr.user = user
> gpr.key = key
> ```

21
docs/README.md
View File

@ -1,21 +0,0 @@
# 💊 ReVanced Manager
This documentation explains how to use [ReVanced Manager](https://github.com/revanced/revanced-manager).
## 📖 Table of contents
0. [💼 Prerequisites](0_prerequisites.md)
1. [⬇️ Installation](1_installation.md)
2. [🛠️ Usage](2_usage.md)
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)
3. [❔ Troubleshooting](3_troubleshooting.md)
4. [🔨 Building from source](4_building.md)
## ⏭️ Start here
The next page will tell you about the prerequisites for using ReVanced Manager.
Continue: [💼 Prerequisites](0_prerequisites.md)