mirror of
https://github.com/revanced/revanced-manager.git
synced 2025-06-12 20:57:36 +02:00
docs: Fix consistency issues with other repositories (#1707)
This commit is contained in:
oSumAtrIX
@ -1,16 +1,16 @@
|
||||
# 💼 Prerequisites
|
||||
|
||||
In order to use ReVanced Manager, certain requirements must be met.
|
||||
To use ReVanced Manager, you need to fulfill certain requirements.
|
||||
|
||||
## 🤝 Requirements
|
||||
|
||||
- An Android device running Android 8 or higher
|
||||
- Any device architecture except ARMv7[^1]
|
||||
|
||||
[^1]: This constraint only applies to patches, that require patching APK resources which is why some patches may or may not work on ARMv7 architecture. You can find out, which architectures your device supports here: [⚙️ Configuring ReVanced Manager](2_4_settings.md#%E2%84%B9%EF%B8%8F-about).
|
||||
[^1]: Patching on ARMv7 is limited to bytecode patching but may work in certain circumstances for resource patching. You can check your device architecture in ReVanced Manager settings.
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will guide you through patching an app.
|
||||
The next page will explain how to install ReVanced Manager.
|
||||
|
||||
Continue: [⬇️ Installation](1_installation.md)
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
# ⬇️ Installation
|
||||
|
||||
In order to use ReVanced on your Android device, ReVanced Manager must be installed.
|
||||
To use ReVanced on your Android device, ReVanced Manager must be first installed.
|
||||
|
||||
## ✅ 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)
|
||||
2. Install ReVanced Manager
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will guide you through using ReVanced Manager.
|
||||
The next page explain how to use ReVanced Manager to update ReVanced Manager and manage or patch apps.
|
||||
|
||||
Continue: [🛠️ Usage](2_usage.md)
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# 🧩 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
|
||||
|
||||
@ -8,13 +8,13 @@ The following pages will guide you through using ReVanced Manager to patch apps.
|
||||
2. Tap on the **Select an app** card
|
||||
3. Choose an app to patch[^1]
|
||||
|
||||
> 💡 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
|
||||
|
||||
> ℹ️ 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
|
||||
@ -25,12 +25,12 @@ The following pages will guide you through using ReVanced Manager to patch apps.
|
||||
|
||||
5. Tap on the **Done** then **Patch** button
|
||||
|
||||
> ⚠️ Warning
|
||||
> ⚠️ Warning
|
||||
> The patching process may take ~5 minutes. Exiting the app may cancel patching or increase the time it takes to patch significantly.
|
||||
|
||||
6. Tap on the **Install** button
|
||||
|
||||
> ℹ️ Note
|
||||
> ℹ️ 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 option in the bottom left corner.
|
||||
|
||||
@ -40,6 +40,6 @@ The following pages will guide you through using ReVanced Manager to patch apps.
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will bring you back to the usage page.
|
||||
The next page will lead back to the usage page.
|
||||
|
||||
Continue: [🛠️ Usage](2_usage.md)
|
||||
|
||||
@ -1,15 +1,15 @@
|
||||
# 🧰 Managing patched apps
|
||||
|
||||
After patching an app, you may want to manage it. This page will guide you through managing patched apps.
|
||||
Learn how to view, open and uninstall patched apps.
|
||||
|
||||
## ✅ Steps to manage 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 one of the options from the menu
|
||||
3. Choose any of the options from the menu to view, open or uninstall the app
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will bring you back to the usage page.
|
||||
The next page will lead back to the usage page.
|
||||
|
||||
Continue: [🛠️ Usage](2_usage.md)
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# 🔄 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.
|
||||
Learn how to update ReVanced Manager.
|
||||
|
||||
## ✅ Updating steps
|
||||
|
||||
@ -9,6 +9,6 @@ In order to keep up with the latest features and bug fixes, it is recommended to
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will bring you back to the usage page.
|
||||
The next page will lead back to the usage page.
|
||||
|
||||
Continue: [🛠️ Usage](2_usage.md)
|
||||
|
||||
@ -1,52 +1,65 @@
|
||||
# ⚙️ Configuring ReVanced Manager
|
||||
|
||||
ReVanced Manager has settings that can be configured to your liking.
|
||||
Learn how to configure ReVanced Manager.
|
||||
|
||||
## 🎛️ Essential settings
|
||||
|
||||
- ### 🪛 Allow changing patch selection
|
||||
|
||||
Allows the user to change the patch selection from the default 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.
|
||||
|
||||
- ### 🔍 Version compatibility check
|
||||
> ⚠️ Warning
|
||||
> Changing the selection may cause cause unexpected issues. Unless you know what you are doing, it is recommended to keep this disabled.
|
||||
|
||||
Constrains patches to supported app versions. Disable this to patch any version of an app.
|
||||
- ### 📦 Require suggested app version
|
||||
|
||||
> [!WARNING]
|
||||
> Disabling this may cause issues if the patches are not compatible with the app version.
|
||||
By default, ReVanced Manager allows you to patch an app if the suggested version to patch matches the app you selected. Disabling this will allow you to patch an app even if the suggested version does not match 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 allows 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 app version 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
|
||||
|
||||
Reveals patches which can be applied to any app.
|
||||
By default, ReVanced Manager only shows patches that are compatible with specifc apps. Enabling this will show patches that are intended to work on all apps.
|
||||
|
||||
> [!WARNING]
|
||||
> These patches may not work on all apps.
|
||||
|
||||
- ### 🧬 Sources
|
||||
|
||||
Override the API and download patches from a different source.
|
||||
> ⚠️ Warning
|
||||
> Patches that are intended to work on all apps may not work on all apps. Unless you know what you are doing, it is recommended to keep this disabled.
|
||||
|
||||
- ### 🔗 API URL
|
||||
|
||||
API to use to fetch updates and patches from.
|
||||
Configure the API URL to use. The API is used to download updates and patches.
|
||||
|
||||
- ### 💾 Imports & Exports
|
||||
- ### 🧬 Use alternative source
|
||||
|
||||
You can import, export or reset the following settings:
|
||||
Use alternative sources for patches and integrations instead of the API.
|
||||
|
||||
- 🔑 Keystore
|
||||
- 📄 Patch selection
|
||||
- ⚙️ Patch options
|
||||
> ℹ️ Note
|
||||
> ReVanced Manager will still use the API for updates.
|
||||
|
||||
> [!NOTE]
|
||||
> This is particularly useful if you want to backup or reset your settings.
|
||||
- ### 💾 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
|
||||
|
||||
> ℹ️ 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 supported architectures of your device.
|
||||
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 bring you back to the usage page.
|
||||
The next page will lead back to the usage page.
|
||||
|
||||
Continue: [🛠️ Usage](2_usage.md)
|
||||
Continue: [🛠️ Usage](2_usage.md)
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# 🛠️ Usage
|
||||
|
||||
The following pages will guide you through using ReVanced Manager to patch apps, manage patched apps, and update ReVanced Manager.
|
||||
Learn how to use ReVanced Manager to manage and patch apps or update ReVanced Manager.
|
||||
|
||||
## 📖 Table of contents
|
||||
|
||||
@ -11,6 +11,6 @@ The following pages will guide you through using ReVanced Manager to patch apps,
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will guide you through troubleshooting ReVanced Manager.
|
||||
The next page will explain how to troubleshoot issues with ReVanced Manager.
|
||||
|
||||
Continue: [❔ Troubleshooting](3_troubleshooting.md)
|
||||
|
||||
@ -1,26 +1,27 @@
|
||||
# ❔ Troubleshooting
|
||||
|
||||
In case you encounter any issues while using ReVanced Manager, please refer to this page for possible solutions.
|
||||
In case you encounter any issues while using ReVanced Manager, this page will help you troubleshoot them.
|
||||
|
||||
- 💉 Patching fails with an error
|
||||
- 💉 Common issues during or after patching
|
||||
|
||||
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.
|
||||
- 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 may not work under certain circumstances. In such a case, patch a full APK.
|
||||
|
||||
Your device may otherwise be unsupported. Please look at 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.
|
||||
- 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
|
||||
|
||||
Select the **Default** button when choosing patches.
|
||||
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
|
||||
|
||||
|
||||
@ -1,36 +1,29 @@
|
||||
# 🛠️ Building from source
|
||||
|
||||
This page will guide you through building ReVanced Manager 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)
|
||||
1. Setup the Flutter environment for your [platform](https://docs.flutter.dev/get-started/install)
|
||||
|
||||
2\. Clone the repository
|
||||
2. Clone the repository
|
||||
|
||||
```sh
|
||||
git clone https://github.com/revanced/revanced-manager.git && cd revanced-manager
|
||||
```
|
||||
3\. Get dependencies
|
||||
|
||||
3. Get dependencies
|
||||
|
||||
```sh
|
||||
flutter pub get
|
||||
```
|
||||
|
||||
4\. Generate translation file
|
||||
4. Generate temporary files
|
||||
|
||||
```sh
|
||||
dart run slang
|
||||
```
|
||||
|
||||
5\. Delete conflicting outputs
|
||||
|
||||
> [!TIP]
|
||||
> Must be run every time you sync your local repository with the remote repository.
|
||||
|
||||
```sh
|
||||
dart run build_runner build --delete-conflicting-outputs
|
||||
```
|
||||
|
||||
6\. Build the APK
|
||||
5. Build the APK
|
||||
|
||||
```sh
|
||||
flutter build apk
|
||||
|
||||
Reference in New Issue
Block a user