mirror of
https://github.com/ReVanced/revanced-manager.git
synced 2025-05-11 13:05:37 +02:00
Merge a5d09b2bf5 into 4d522664b6
This commit is contained in:
Pun Butrach
GitHub
commit
a30f589488
18 changed files with 422 additions and 103 deletions
111
CONTRIBUTING.md
Normal file
111
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,111 @@
|
|||
<p align="center">
|
||||
<picture>
|
||||
<source
|
||||
width="256px"
|
||||
media="(prefers-color-scheme: dark)"
|
||||
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
|
||||
>
|
||||
<img
|
||||
width="256px"
|
||||
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
|
||||
>
|
||||
</picture>
|
||||
<br>
|
||||
<a href="https://revanced.app/">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" />
|
||||
<img height="24px" src="assets/revanced-logo/revanced-logo.svg" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://github.com/ReVanced">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
|
||||
<img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="http://revanced.app/discord">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://reddit.com/r/revancedapp">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://t.me/app_revanced">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://x.com/revancedapp">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://www.youtube.com/@ReVanced">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<br>
|
||||
<br>
|
||||
Continuing the legacy of Vanced
|
||||
</p>
|
||||
|
||||
# 👋 Contribution guidelines
|
||||
|
||||
Welcome to contribution guidelines, this document contains
|
||||
everything you'll need to contribute to ReVanced Manager (and might even possibly apply to our other project like ReVanced Patches!)
|
||||
|
||||
There are many ways to contribute like writing docs and code, opening issues,
|
||||
helping people out in our community, translating or sponsoring our project, etc.
|
||||
|
||||
## 📖 Resources to help you get started
|
||||
|
||||
* The [documentation](/docs/developer/README.md) provides steps to build ReVanced Manager from source
|
||||
* Our [backlog](https://github.com/orgs/ReVanced/projects/12) is where we keep track of what we're working on
|
||||
* [Issues](https://github.com/ReVanced/revanced-manager/issues) are where we keep track of bugs and feature requests
|
||||
|
||||
## 🙏 Submitting a feature request
|
||||
|
||||
Features can be requested by opening an issue using the
|
||||
[feature request issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=feature-request&projects=&template=feature-issue.yml&title=feat%3A+%3Ctitle%3E).
|
||||
|
||||
> [!NOTE]
|
||||
> Requests can be accepted or rejected at the discretion of maintainers of ReVanced Manager.
|
||||
> Good motivation has to be provided for a request to be accepted.
|
||||
|
||||
## 🐞 Submitting a bug report
|
||||
|
||||
If you encounter a bug while using the ReVanced Manager app, open an issue using the
|
||||
[bug report issue template](https://github.com/ReVanced/revanced-manager/issues/new?assignees=&labels=bug&projects=&template=bug-issue.yml&title=bug%3A+%3Ctitle%3E).
|
||||
|
||||
## 🌐 Submitting translations
|
||||
|
||||
You can contribute translations at translate.revanced.app
|
||||
|
||||
> [!TIP]
|
||||
> * Try to keep the translated text roughly the same length as the original.
|
||||
> * Consider opting for gender-neutral words for language with variations of words based on gender.
|
||||
|
||||
## 🧑💻 Developing for ReVanced Manager
|
||||
|
||||
See the guidelines for developing for ReVanced Manager [here](/docs/developer/README.md)
|
||||
|
||||
## 🔒 Submitting a vulnerability
|
||||
|
||||
See the guideline for reporting security vulnerability [here](/SECURITY.md)
|
||||
|
||||
## 🤚 I don't want to do any of that but I want to contribute either way
|
||||
|
||||
You can still contribute by spreading positive word about us or if you'd like to sponsor us, checkout https://revanced.app/donate
|
||||
to learn more about how you can sponsor via GitHub, Open Collective, and cryptocurrencies.
|
||||
|
||||
❤️ Thank you for considering contributing to ReVanced Manager,
|
||||
ReVanced
|
||||
119
README.md
119
README.md
|
|
@ -1,55 +1,104 @@
|
|||
# ReVanced Manager (Compose Rewrite)
|
||||
<p align="center">
|
||||
<picture>
|
||||
<source
|
||||
width="256px"
|
||||
media="(prefers-color-scheme: dark)"
|
||||
srcset="assets/revanced-headline/revanced-headline-vertical-dark.svg"
|
||||
>
|
||||
<img
|
||||
width="256px"
|
||||
src="assets/revanced-headline/revanced-headline-vertical-light.svg"
|
||||
>
|
||||
</picture>
|
||||
<br>
|
||||
<a href="https://revanced.app/">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="assets/revanced-logo/revanced-logo.svg" />
|
||||
<img height="24px" src="assets/revanced-logo/revanced-logo.svg" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://github.com/ReVanced">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://i.ibb.co/dMMmCrW/Git-Hub-Mark.png" />
|
||||
<img height="24px" src="https://i.ibb.co/9wV3HGF/Git-Hub-Mark-Light.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="http://revanced.app/discord">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032563-d4e084b7-244e-4358-af50-26bde6dd4996.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://reddit.com/r/revancedapp">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032351-9d9d5619-8ef7-470a-9eec-2744ece54553.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://t.me/app_revanced">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032213-faf25ab8-0bc3-4a94-a730-b524c96df124.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://x.com/revancedapp">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/93124920/270180600-7c1b38bf-889b-4d68-bd5e-b9d86f91421a.png">
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/93124920/270108715-d80743fa-b330-4809-b1e6-79fbdc60d09c.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<a href="https://www.youtube.com/@ReVanced">
|
||||
<picture>
|
||||
<source height="24px" media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
||||
<img height="24px" src="https://user-images.githubusercontent.com/13122796/178032714-c51c7492-0666-44ac-99c2-f003a695ab50.png" />
|
||||
</picture>
|
||||
</a>
|
||||
<br>
|
||||
<br>
|
||||
Continuing the legacy of Vanced
|
||||
</p>
|
||||
|
||||
[](../../blob/main/LICENSE)
|
||||
[](https://github.com/ReVanced/revanced-manager/commits/compose-dev)
|
||||
[](https://github.com/ReVanced/revanced-manager/commits/compose-dev)
|
||||
# 💊 ReVanced Manager
|
||||
|
||||
_(Yet another)_ rewrite of the ReVanced Manager using Kotlin and Jetpack Compose.
|
||||
[](https://github.com/ReVanced/revanced-manager/actions/workflows/release.yml)
|
||||
[](#️-license)
|
||||
|
||||
## Design system
|
||||
Application to use ReVanced on Android
|
||||
|
||||
In this rewrite, we are adopting the latest Material Design principles and guidelines by using Material 3 and Material You.
|
||||
## ❓ About
|
||||
|
||||
Material Design is a design system developed by Google that provides a unified visual language for building beautiful and consistent user interfaces across all platforms and devices. Material You is an extension of Material Design that provides even more customization options for users, making it possible for them to personalize their device and create a unique look and feel.
|
||||
ReVanced Manager is an application that uses [ReVanced Patcher](https://github.com/revanced/revanced-patcher) to patch Android apps.
|
||||
|
||||
### Why Material 3?
|
||||
## 💪 Features
|
||||
|
||||
* **Consistent design language**
|
||||
* **Improved accessibility**
|
||||
* **Better user experience**
|
||||
Some of the features ReVanced Manager provides are:
|
||||
|
||||
By using Material 3 and Material You, we are ensuring that the app's user interface is consistent, customizable, accessible, and engaging for our users. This will help to improve the overall user experience and increase user satisfaction with the the manager.
|
||||
|
||||
## Technology stack
|
||||
|
||||
* Kotlin: Kotlin is a modern and concise programming language that is fully interoperable with Java and provides improved safety, readability, and maintainability compared to Java.
|
||||
* Jetpack Compose: Jetpack Compose is a modern UI toolkit for Android development that allows developers to build beautiful and performant user interfaces using declarative programming. It provides a unified and efficient way of building UI that is well-integrated with the Android framework.
|
||||
|
||||
## Why Kotlin and Compose?
|
||||
|
||||
* **Improved safety:** Kotlin provides improved safety compared to Java, which reduces the likelihood of common programming mistakes that can cause security vulnerabilities or crashes.
|
||||
* **Concise and readable code:** Kotlin's concise syntax and expressive type system make the code more readable, which makes it easier for developers to understand and maintain the codebase.
|
||||
* **Better performance:** Jetpack Compose uses the power of the Android framework to provide smooth and fast performance, which enhances the user experience.
|
||||
* **Modern and efficient UI development:** Jetpack Compose provides a modern and efficient way of building UI, which makes it easier for developers to create beautiful and performant user interfaces.
|
||||
- 💉 **Patch apps**: Apply any patch of your choice to Android apps
|
||||
- 📱 **Portable**: ReVanced Patcher that fits in your pocket
|
||||
- 🤗 **Simple UI**: Quickly understand the ins and outs of ReVanced Manager
|
||||
- 🛠️ **Customization**: Configurable API, custom sources, language, signing keystore, theme and more
|
||||
|
||||
## 🔽 Download
|
||||
|
||||
You can obtain ReVanced Manager by downloading it from either [revanced.app/download](https://revanced.app/download) or [GitHub Releases](https://github.com/ReVanced/revanced-manager/releases)
|
||||
You can get the most recent version of ReVanced Manager by downloading from
|
||||
the [ReVanced site](https://revanced.app/download).
|
||||
|
||||
## 📝 Prerequisites
|
||||
Learn how to use ReVanced Manager by following the [documentation](/docs).
|
||||
|
||||
For a list of prerequisites, refer to [docs/0_prerequisites.md](docs/0_prerequisites.md)
|
||||
## 📚 Everything else
|
||||
|
||||
## 🔴 Issues
|
||||
### 📙 Contributing
|
||||
|
||||
For suggestions and bug reports, open an issue [here](https://github.com/revanced/revanced-manager/issues/new/choose).
|
||||
Thank you for considering contributing to ReVanced Manager.
|
||||
|
||||
## 🌐 Translation
|
||||
The [contribution guidelines](CONTRIBUTING.md) provides information you'll need to open an issue, develop for ReVanced Manager and translations.
|
||||
|
||||
[](https://crowdin.com/project/revanced)
|
||||
### 📄 Documentation
|
||||
|
||||
We're accepting translations on [Crowdin](https://translate.revanced.app)
|
||||
You can find the documentation for ReVanced Manager [here](/docs).
|
||||
|
||||
## 🛠️ Building Manager from source
|
||||
## ⚖️ License
|
||||
|
||||
For instructions on how to build ReVanced Manager from source, refer to [docs/4_building.md](docs/4_building.md)
|
||||
ReVanced Manager is licensed under the GPLv3 license. Please see the [license file](LICENSE) for more information.
|
||||
[tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and modify ReVanced Manager as long as you track changes/dates in source files.
|
||||
Any modifications to ReVanced Manager must also be made available under the GPL, along with build & install instructions.
|
||||
|
|
|
|||
20
SECURITY.md
20
SECURITY.md
|
|
@ -64,14 +64,20 @@ This document describes how to report security vulnerabilities for ReVanced Mana
|
|||
|
||||
## 🚨 Reporting a Vulnerability
|
||||
|
||||
Please open an issue in our [advisory tracker](https://github.com/ReVanced/revanced-manager/security/advisories/new) or reach out privately to us on [Discord](https://discord.gg/revanced).
|
||||
Please open an issue in our [advisory tracker](https://github.com/ReVanced/revanced-manager/security/advisories/new)
|
||||
or reach out privately to us on [Discord](https://discord.gg/revanced).
|
||||
|
||||
If a vulnerability is confirmed and accepted, you can join our [Discord](https://discord.gg/revanced) server to receive a special contributor role.
|
||||
If a vulnerability is confirmed and accepted, they will be published and
|
||||
you can join our [Discord](https://discord.gg/revanced) server to receive a
|
||||
special contributor role.
|
||||
|
||||
### ⏳ Supported Versions
|
||||
|
||||
| Version | Branch | Supported |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------------ |
|
||||
|  | main | :white_check_mark: |
|
||||
|  | dev | :white_check_mark: |
|
||||
|  | compose-dev | :white_check_mark: |
|
||||
| Version | Branch | Supported |
|
||||
|------------------------------------------|---------------|--------------------|
|
||||
| ![Latest stable release][LatestRelBadge] | `main` | :white_check_mark: |
|
||||
| ![Latest version][LatestVerBadge] | `dev` | :white_check_mark: |
|
||||
| ![Latest version][LatestVerBadge] | `compose-dev` | :white_check_mark: |
|
||||
|
||||
[LatestRelBadge]: https://img.shields.io/github/v/release/ReVanced/revanced-manager?style=for-the-badge "Latest stable release"
|
||||
[LatestVerBadge]: https://img.shields.io/badge/version-latest-brightgreen?style=for-the-badge "Latest version"
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 2.8 KiB After Width: | Height: | Size: 2.8 KiB |
|
|
@ -1,10 +1,11 @@
|
|||
# 💼 Prerequisites
|
||||
|
||||
In order to use ReVanced Manager, certain requirements must be met.
|
||||
To use ReVanced Manager, certain requirements have to be met.
|
||||
|
||||
## 🤝 Requirements
|
||||
|
||||
- An Android device running Android 8 or higher
|
||||
- Android device running Android 8.0 or higher
|
||||
- **Optionally** Rooted Android device with latest version of [KernelSU](https://github.com/tiann/KernelSU) or [Magisk](https://github.com/topjohnwu/Magisk)
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
|
|
|
|||
|
|
@ -1,14 +1,26 @@
|
|||
# ⬇️ Installation
|
||||
|
||||
In order to use ReVanced on your Android device, ReVanced Manager must be installed.
|
||||
To use ReVanced on your Android device, ReVanced Manager have to be install,
|
||||
refer to the [Prerequisites](0_prerequisites.md) if haven't already.
|
||||
|
||||
## ✅ Installation steps
|
||||
## 🪜 Installation steps
|
||||
|
||||
1. Download the latest version of ReVanced Manager from [here](https://github.com/revanced/revanced-manager/releases/latest)
|
||||
1. Get the latest version of ReVanced Manager from the [ReVanced site][Official ReVanced Download].
|
||||
2. Install ReVanced Manager
|
||||
|
||||
### ✒️ Verifying authenticity of ReVanced Manager
|
||||
|
||||
> [!NOTE]
|
||||
> It's always advisable that you download from trusted sources like the [ReVanced site][Official ReVanced Download]
|
||||
> or GitHub releases as it's the safest way to download ReVanced without potential risk of malware.
|
||||
|
||||
To verify if your ReVanced Manager is provided without sign of tampering,
|
||||
we have signed the APK with hashes corresponding to `b6362c6ea7888efd15c0800f480786ad0f5b133b4f84e12d46afba5f9eac1223` *unless otherwise stated*.
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will guide you through using ReVanced Manager.
|
||||
|
||||
Continue: [🛠️ Usage](2_usage.md)
|
||||
|
||||
[Official ReVanced Download]: https://revanced.app/download
|
||||
|
|
|
|||
|
|
@ -8,16 +8,26 @@ The following pages will guide you through using ReVanced Manager to patch apps.
|
|||
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.
|
||||
5. Tap the 🪄 **Patch** button
|
||||
6. Tap on the 📲 **Install** button
|
||||
> [!Note]
|
||||
> If the **Install** Button isn't there, it could be that something went wrong. Refer to [3. ❔ Troubleshooting](3_troubleshooting.md)
|
||||
> [!Tip]
|
||||
> 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 bottom left corner.
|
||||
|
||||
[^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.
|
||||
[^1]: You need 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.
|
||||
|
||||
### Change patch selection and options
|
||||
|
||||
Before you can change the selection of patches, follow the step below to allow changing the selection of patches.
|
||||
|
||||
1. Tap ⚙️ Settings button in the top right corner
|
||||
2. Go to Advanced Settings
|
||||
3. Toggle "Allow changing patch selection" on
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will bring you back to the usage page.
|
||||
|
|
|
|||
|
|
@ -6,10 +6,13 @@ After patching an app, you may want to manage it. This page will guide you throu
|
|||
|
||||
1. Navigate to the Apps tab from the top navigation bar
|
||||
2. Select the app you want to manage
|
||||
3.
|
||||
|
||||
Inside you will be able to open, and uninstall the app within the manager,
|
||||
additionally you will be able to repatch the app by patching the app again, see [🧩 Patching apps](2_1_patching.md),
|
||||
and view all patches applied to the patched app.
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will bring you back to the usage page.
|
||||
|
||||
Continue: [🛠️ Usage](2_usage.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,25 @@ In order to keep up with the latest features and bug fixes, it is recommended to
|
|||
|
||||
## ✅ Updating steps
|
||||
|
||||
> Currently not implemented
|
||||
1. Tap the ↻ Update button in the top right corner right next to the ⚙️ Settings icon
|
||||
2. Tap the **Update** button in the bottom right corner
|
||||
3. Wait for the update to be downloaded
|
||||
4. Tap the **Install** button to install[^1]
|
||||
> [!Note]
|
||||
> If you see a prompt regarding your device is unable to install application for security reason
|
||||
> you may need to allow ReVanced Manager to install APK file on your device.
|
||||
> 1. Tap on Settings
|
||||
> 2. Toggle "Allow from this source" on
|
||||
5. Wait for installation prompt to show then tap **Install** again
|
||||
6. Open ReVanced Manager again to see the new version
|
||||
|
||||
## 🔎 Check for update
|
||||
|
||||
Usually ReVanced Manager always check update on first startup, so it's not need to manually check for update yourself.
|
||||
To trigger the check for update function follow the step bellow:
|
||||
|
||||
1. Go to ⚙️ Settings menu and ↻ Update section
|
||||
2. Tap on "Check for updates"
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
|
|
|
|||
|
|
@ -8,30 +8,44 @@ ReVanced Manager has settings that can be configured to your liking.
|
|||
|
||||
Specify the URL of the API to use. This is used to fetch ReVanced Patches and update ReVanced Manager.
|
||||
|
||||
Location: `⚙️ Settings -> Advanced -> API URL`
|
||||
|
||||
- ### 🧬 Sources
|
||||
|
||||
Override the API and change the source of ReVanced Patches.
|
||||
|
||||
- ### 🧪 Experimental ReVanced Patches support
|
||||
Location: `Patch bundles -> + Button`
|
||||
|
||||
- ### 🧪 Experimental patches
|
||||
|
||||
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.
|
||||
|
||||
Location: `⚙️ Settings -> Advanced -> Safeguards`
|
||||
|
||||
- ### 🧑🔬 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.
|
||||
|
||||
Location: `⚙️ Settings -> Advanced -> Safeguards`
|
||||
|
||||
- ### 🔑 Export, import or delete keystore
|
||||
|
||||
Manage the keystore used to sign patched apps.
|
||||
|
||||
- ### 📄 Export, import or reset ReVanced Patches selection
|
||||
Location: `⚙️ Settings -> Import & export -> Signing`
|
||||
|
||||
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.
|
||||
- ### 📄 Export, import or reset patch selection
|
||||
|
||||
Manage the ReVanced Patches selection. This is useful if you want to share your patch selection with others or reset it to the default selection.
|
||||
|
||||
Location: `⚙️ Settings -> Import & export -> Patches`
|
||||
|
||||
- ### ℹ️ About
|
||||
|
||||
View information about your device and ReVanced Manager. This includes the version of ReVanced Manager and supported architectures of your device.
|
||||
|
||||
Location: `⚙️ Settings -> About`
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will bring you back to the usage page.
|
||||
|
|
|
|||
|
|
@ -10,11 +10,19 @@ In case you encounter any issues while using ReVanced Manager, please refer to t
|
|||
|
||||
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.
|
||||
|
||||
- 🥛 Out Of Memory error
|
||||
|
||||
This indicates that your device is not giving ReVanced Manager enough memory to patch the app.
|
||||
|
||||
Turning on `⚙️ Settings -> Advanced -> toggle "Run Patcher in another process (experimental)"` may solve the issue.
|
||||
|
||||
- ❗️ 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.
|
||||
Alternatively, you can use [ReVanced CLI][ReVanced CLI GitHub]) to patch the app.
|
||||
|
||||
[ReVanced CLI GitHub]: https://github.com/revanced/revanced-cli
|
||||
|
||||
- 🚫 Non-root install is not possible with the current patches selection
|
||||
|
||||
|
|
@ -22,10 +30,14 @@ In case you encounter any issues while using ReVanced Manager, please refer to t
|
|||
|
||||
- 🚨 Patched app crashes on launch
|
||||
|
||||
Select the **Default** button when choosing patches.
|
||||
Try selecting the **Default** button when choosing patches, if the patched app still failed, file an issue at [ReVanced Patches][ReVanced Patches GitHub].
|
||||
|
||||
[ReVanced Patches GitHub]: https://github.com/revanced/revanced-patches
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will teach you how to build ReVanced Manager from source.
|
||||
You have successfully finished the guide for on how to use ReVanced Manager.
|
||||
|
||||
Continue: [🔨 Building from source](4_building.md)
|
||||
If you wish to review the Table of Content for how to use ReVanced Manager, feel free to do so.
|
||||
|
||||
Continue: [💊 ReVanced Manager](/docs/README.md)
|
||||
|
|
|
|||
|
|
@ -1,38 +0,0 @@
|
|||
# 🛠️ Building 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
|
||||
|
||||
2. Clone the repository
|
||||
|
||||
```sh
|
||||
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)
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
Release:
|
||||
```sh
|
||||
./gradlew assembleRelease -Psign
|
||||
```
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
# 💊 ReVanced Manager
|
||||
|
||||
This documentation explains how to use [ReVanced Manager](https://github.com/revanced/revanced-manager).
|
||||
This documentation explains how to use [ReVanced Manager](https://github.com/ReVanced/revanced-manager).
|
||||
|
||||
## 📖 Table of contents
|
||||
|
||||
|
|
@ -12,7 +12,10 @@ This documentation explains how to use [ReVanced Manager](https://github.com/rev
|
|||
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)
|
||||
|
||||
## 🧑💻 Developing for ReVanced Manager
|
||||
|
||||
Checkout the documentation for developer [here](developer/README.md).
|
||||
|
||||
## ⏭️ Start here
|
||||
|
||||
|
|
|
|||
28
docs/developer/0_prerequisites.md
Normal file
28
docs/developer/0_prerequisites.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
# 💼 Prerequisites
|
||||
|
||||
Here's everything you'll need to develop on ReVanced Manager
|
||||
|
||||
## 🤝 Recommended environment
|
||||
|
||||
- Any environment that is capable of running the latest Android Studio, latest Android SDK, and JDK 17 with at least 4 GB of memory for coding
|
||||
- Any devices with preferably the latest Android version or at least higher than the [`minSdk`](/app/build.gradle.kts) for testing
|
||||
- **Optionally** A device with root capabilities using the latest version of [KernelSU](https://github.com/tiann/KernelSU) or [Magisk](https://github.com/topjohnwu/Magisk)
|
||||
|
||||
## ⚙️ Setting up
|
||||
|
||||
### Authenticating to GitHub Registry
|
||||
|
||||
ReVanced Manager use dependency from the GitHub Registry (i.e., [ReVanced Patcher](https://github.com/ReVanced/revanced-patcher/packages)) and so your build may fail without authenticating to the service,
|
||||
to authenticate you must create a personal access token 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.
|
||||
|
||||
```properties
|
||||
gpr.user = username
|
||||
gpr.key = ghp_******************************
|
||||
```
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will guide you through developing for ReVanced Manager.
|
||||
|
||||
Continue: [🧑💻 Developing for ReVanced Manager](1_develop.md)
|
||||
25
docs/developer/1_develop.md
Normal file
25
docs/developer/1_develop.md
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
# 🧑💻 Developing for ReVanced Manager
|
||||
|
||||
ReVanced Manager is developed on Kotlin using [Jetpack Compose](https://developer.android.com/compose), here are some tips to help you get started.
|
||||
|
||||
## Code style
|
||||
|
||||
The styling is based on https://kotlinlang.org/docs/coding-conventions.html
|
||||
|
||||
## Commit
|
||||
|
||||
At ReVanced, we adopt a naming convention for commit called [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) so for example when you're adding a new feature you must add `feat: ` before the description of your commit.
|
||||
|
||||
## Building
|
||||
|
||||
To build ReVanced Manager, simply hit build button on your IDE or run:
|
||||
|
||||
```sh
|
||||
./gradlew assembleDebug
|
||||
```
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
The next page will guide you through developing for ReVanced Manager.
|
||||
|
||||
Continue: [🎉 Submitting your Pull Request](2_submitting.md)
|
||||
21
docs/developer/2_submitting.md
Normal file
21
docs/developer/2_submitting.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# 🎉 Submitting your Pull Request
|
||||
|
||||
> [!TIP]
|
||||
> We recommend that you discuss your changes with
|
||||
> the maintainers of ReVanced Manager before contributing.
|
||||
> This will help you determine whether your change is acceptable.
|
||||
|
||||
1. Fork the repository and create your branch from `dev`
|
||||
2. Commit your changes in [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) style
|
||||
3. Submit a pull request to the `dev` branch of the repository and reference issues that your pull request closes in the description of your pull request
|
||||
4. Our team will review your pull request and provide feedback. Once your pull request is approved, it will be merged into the `dev` branch and will be included in
|
||||
the next release of ReVanced Manager
|
||||
|
||||
## ⏭️ What's next
|
||||
|
||||
You have successfully finished the guide for developing for ReVanced Manager.
|
||||
|
||||
This next section will be verifying the authenticity of ReVanced Manager
|
||||
which may be relevant for store provider or those who's looking to verify prebuilt librar(ies).
|
||||
|
||||
Continue: [✒️ Verification and Authenticity of ReVanced Manager](3_verifying.md)
|
||||
19
docs/developer/3_verifying.md
Normal file
19
docs/developer/3_verifying.md
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
# ✒️ Verification and Authenticity of ReVanced Manager
|
||||
|
||||
> [!NOTE]
|
||||
> This information is more relevant to alternative store providers
|
||||
|
||||
To distribute ReVanced Manager safely and recommended way is to provide the users with a link to
|
||||
[1. ⬇️ Installation, ✒️ Verifying authenticity of ReVanced Manager (user-side)][installation authenticity].
|
||||
|
||||
The certificate SHA-256 of the APK will always be `b6362c6ea7888efd15c0800f480786ad0f5b133b4f84e12d46afba5f9eac1223` unless otherwise noted.
|
||||
|
||||
[installation authenticity]: /docs/1_installation.md#%EF%B8%8F-verifying-authenticity-of-revanced-manager
|
||||
|
||||
## `libaapt2.so`
|
||||
|
||||
ReVanced Manager includes prebuilt binaries of [`libaapt2.so`][location of libaapt2.so] from https://github.com/ReVanced/aapt2
|
||||
|
||||
which fixes issues on ARM32-based systems. Attestation is provided here: https://github.com/ReVanced/aapt2/attestations
|
||||
|
||||
[location of libaapt2.so]: /app/src/main/jniLibs/
|
||||
25
docs/developer/README.md
Normal file
25
docs/developer/README.md
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
# 💊 ReVanced Manager
|
||||
|
||||
> [!WARNING]
|
||||
> This guide is for people who want to develop for ReVanced Manager, may feature technical words or jargons.
|
||||
> For regular user you may want to view this [documentation](/docs/README.md) instead.
|
||||
|
||||
This documentation explains how to develop for [ReVanced Manager](https://github.com/ReVanced/revanced-manager).
|
||||
|
||||
## 📖 Table of contents
|
||||
|
||||
## Developing
|
||||
|
||||
0. [💼 Prerequisites](0_prerequisites.md)
|
||||
1. [🧑💻 Developing for ReVanced Manager](1_developing.md)
|
||||
2. [🎉 Submitting your Pull Request](2_submitting.md)
|
||||
|
||||
## Transparency
|
||||
|
||||
1. [✒️ Verification and Authenticity of ReVanced Manager](3_verifying.md)
|
||||
|
||||
## ⏭️ Start here
|
||||
|
||||
The next page will tell you about the prerequisites for developing for ReVanced Manager.
|
||||
|
||||
Continue: [💼 Prerequisites](0_prerequisites.md)
|
||||
Loading…
Add table
Add a link
Reference in a new issue