androidacy-user
2 years ago
parent
d282e7c5ac
commit
6430a4114d
@ -1,189 +1,83 @@
|
||||
# Androidacy Module Manager
|
||||
|
||||
### Developed by Androidacy. Find us on the web [here](https://www.androidacy.com/?utm_source=fox-readme&utm_medium=web&utm_campaign=github).
|
||||
## Introduction
|
||||
|
||||
<sub>We'd like to thank Fox2Code for his initial work on the app. This app was previously known as Fox's Magisk Module Manager (FoxMMM) and may still be referred to as that. Androidacy thanks Fox2Code for their initial work on this app, and wishes him the best in his future endeavours.</sub>
|
||||
### Developed by Androidacy
|
||||
|
||||
[](https://www.androidacy.com/downloads/?view=FoxMMM)
|
||||
Explore our diverse range of offerings on our [official website](https://www.androidacy.com/?utm_source=fox-readme&utm_medium=web&utm_campaign=github-readme).
|
||||
|
||||
## About
|
||||
<sub>Originally known as Fox's Magisk Module Manager (FoxMMM), we thank Fox2Code for the foundational work.</sub>
|
||||
|
||||
The official Magisk Manager app has dropped it's support for downloading online modules, leaving users without a way to easily search for and download them. This app was created to help users download and install modules, and manage their own modules. We pride ourselves on our code quality, ease of use, and our commitment to the community.
|
||||
[](https://www.androidacy.com/downloads/?view=FoxMMM&utm_source=fox-readme&utm_medium=web&utm_campaign=github-readme)
|
||||
|
||||
**This app is not officially supported by Magisk, KernelSU, Google, or in any way affiliated with the above**
|
||||
## Overview and Purpose
|
||||
|
||||
**The modules shown in this app are not affiliated with this app or Magisk**.
|
||||
The Androidacy Module Manager serves as a robust alternative to the official Magisk Manager app, which has discontinued support for online module downloads.
|
||||
|
||||
## Features
|
||||
- Download and install modules
|
||||
- Manage your own modules
|
||||
- Search for and download modules
|
||||
- Supports custom repos
|
||||
- Separate lists of local and remote modules
|
||||
- Check for module updates automatically
|
||||
- Monet theming
|
||||
- Fully MD3 themed
|
||||
- Easy to use
|
||||
- (Androidacy Repo only) Automatic VirusTotal scans
|
||||
- (Androidacy Repo only) Module reviews
|
||||
- (Androidacy Repo only) Revenue sharing program
|
||||
- (Coming soon) Repo creation wizard
|
||||
- (Coming soon) Module creator
|
||||
**Disclaimer:** This application is not officially endorsed by Magisk, KernelSU, Google, or any other affiliated entities.
|
||||
|
||||
## Community
|
||||
## Comprehensive Feature Set
|
||||
|
||||
[](https://telegram.dog/androidacy_discussions)
|
||||
- **Module Management:** Download, install, and manage your modules.
|
||||
- **Search Functionality:** Find new modules.
|
||||
- **Custom Repository Support:** Add your own repositories.
|
||||
- **Automatic Updates:** Keeps your system up-to-date.
|
||||
- **Theming:** Monet theming.
|
||||
- **User Interface:** Material Design 3 (MD3) compliant.
|
||||
|
||||
<a href="http://translate.nift4.org/engage/foxmmm/">
|
||||
<img src="http://translate.nift4.org/widgets/foxmmm/-/287x66-white.png" alt="Translation status" />
|
||||
</a>
|
||||
### Exclusive to Androidacy Repository
|
||||
|
||||
## Screenshots
|
||||
- **Security:** Automatic VirusTotal scans.
|
||||
- **Community Engagement:** Module reviews.
|
||||
- **Revenue Sharing:** Financially rewards module developers.
|
||||
- **Ad-Supported:** Ads allow us to keep this app and our repository free, but can be removed with a subscription. [Subscribe Now](https://www.androidacy.com/membership-join/?utm_source=fox-readme&utm_medium=web&utm_campaign=github-readme)
|
||||
|
||||
Main activity:
|
||||
### Future Updates
|
||||
|
||||
| Dark theme | Light theme |
|
||||
|:-----------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|
|
||||
| [<img src="docs/screenshot-dark.jpg" width="250"/>](docs/screenshot-dark.jpg) | [<img src="docs/screenshot-light.jpg" width="250"/>](docs/screenshot-light.jpg) |
|
||||
- Repository Creation Wizard
|
||||
- Module Creation Tool
|
||||
|
||||
## Requirements
|
||||
### Default Repositories
|
||||
|
||||
### Minimum / Recommended:
|
||||
- [Androidacy](https://www.androidacy.com/magisk-modules-repository/?utm_source=fox-readme&utm_medium=web&utm_campaign=github-readme): Fast, optimized, and secure. The official Androidacy repository. May display non-intrusive ads.
|
||||
- [Magisk Alt Repo](https://github.com/Magisk-Modules-Alt-Repo/): A community-driven repository for Magisk modules. Not affiliated with Magisk or Topjohnwu, and may contain low-quality or malicious modules.
|
||||
|
||||
- Android: 8.0+ / Android 9.0+
|
||||
- Magisk: 21.0+ / Magisk 24.0+
|
||||
- KernelSU **(experimental)**: 0.5.0+ / latest
|
||||
- An internet connection / A stable wifi connection
|
||||
## Community Engagement and Support
|
||||
|
||||
Note: This app may require the use of a VPN in countries with a state wide firewall.
|
||||
Join our [Telegram Group](https://telegram.dog/androidacy_discussions?utm_source=fox-readme&utm_medium=web&utm_campaign=github-readme).
|
||||
|
||||
## Installation
|
||||
## System Requirements
|
||||
|
||||
To install the app go to [our website](https://www.androidacy.com/downloads/?view=FoxMMM),
|
||||
and download and install the latest `.apk` for your architecture on your device.
|
||||
### Minimum and Recommended Specifications
|
||||
|
||||
## Repositories Available
|
||||
- **Android OS:** 8.0 / 9.0+
|
||||
- **Magisk:** 21.0 / 24.0+
|
||||
- **KernelSU (Experimental Support):** 0.5.0+ / Latest
|
||||
- **Internet Connectivity:** Required / Stable Wi-Fi Recommended
|
||||
|
||||
#### Please note that we reserve the right to add, remove, and change default repos at any time, and the inclusion of any repo does not equate endorsement or any agreement with or of said repo.
|
||||
> **Note:** A VPN may be required in certain regions.
|
||||
|
||||
The app currently use the below repos as module sources, each with their own benefits and
|
||||
drawbacks. Note that the app developers do not actively monitor any repos, and downloading or
|
||||
installing from them is at the user's own risk. Default repos can be enabled or disabled in-app.
|
||||
## Installation Guidelines
|
||||
|
||||
#### [Androidacy](https://www.androidacy.com/magisk-modules-repository/?utm_source=fox-readme&utm_medium=web&utm_campagin=github)
|
||||
Visit [our website](https://www.androidacy.com/downloads/?view=FoxMMM&utm_source=fox-readme&utm_medium=web&utm_campaign=github-readme) to download the latest `.apk`.
|
||||
|
||||
- Accepting new
|
||||
modules [here](https://www.androidacy.com/module-repository-applications/?utm_source=fox-readme&utm_medium=web&utm_campagin=github)
|
||||
- Modules downloadable easily outside the app
|
||||
- Rigorously reviewed and tested modules
|
||||
- Officially supported by AMM
|
||||
- May show ads to help cover infrastructure costs. Can be removed with subscription.
|
||||
- [Read more](https://www.androidacycom/doing-it-alone-the-what-the-how-and-the-why/?utm_source=fox-readme&utm_medium=web&utm_campagin=github)
|
||||
| [Privacy policy](https://www.androidacy.com/privacy/?utm_source=fox-readme&utm_medium=web&utm_campagin=github)
|
||||
- Added features like module reviews, automatic VirusTotal scans, and more.
|
||||
- Pays module developers for their work as part of the Revenue Sharing Program
|
||||
## Developer Guidelines
|
||||
|
||||
**Support:**
|
||||
Consult our [Developer Documentation](docs/DEVELOPERS.md?utm_source=fox-readme&utm_medium=web&utm_campaign=github-readme).
|
||||
|
||||
  [](https://telegram.dog/androidacy_discussions)
|
||||
## Translation Contributions
|
||||
|
||||
#### [Magisk Alt Repo](https://github.com/Magisk-Modules-Alt-Repo)
|
||||
Visit our [Weblate page](https://translate.nift4.org/engage/foxmmm/?utm_source=fox-readme&utm_medium=web&utm_campaign=github-readme). Advanced users may also send us a pull request on GitHub.
|
||||
|
||||
- Accepting new modules [here](https://github.com/Magisk-Modules-Alt-Repo/submission)
|
||||
- Less restrictive than the original repo
|
||||
- May have lower quality, untested, or otherwise broken modules due to their policies or lack
|
||||
thereof.
|
||||
- Officially supported by AMM
|
||||
- Disabled by default and no longer recommended. Kept as an alternative for those who want it
|
||||
## Legal and Compliance
|
||||
|
||||
**Support:**
|
||||
|
||||
  [](https://github.com/Magisk-Modules-Alt-Repo/submission/issues)
|
||||
By using this application, you agree to abide by our [Terms of Service](https://www.androidacy.com/terms/?utm_source=fox-readme&utm_medium=web&utm_campaign=github-readme), our [LICENSE](LICENCE?utm_source=fox-readme&utm_medium=web&utm_campaign=github-readme) and the [EULA](https://www.androidacy.com/foxmmm-eula/?utm_source=fox-readme&utm_medium=web&utm_campaign=github-readme). **If you do not agree to any of those terms, you are to discontinue usage of the app immediately.**
|
||||
|
||||
**Please do not use GitHub issues for help or questions. GitHub issues are specifically for bug
|
||||
reporting and general app feedback.**
|
||||
## Disclaimer
|
||||
|
||||
If a module is in multiple repos, the manager will just pick the most up to date version of the
|
||||
module, if a module is in multiple repos it will just use first registered repo.
|
||||
|
||||
## For developers
|
||||
THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU.
|
||||
|
||||
The manager can read a few new meta keys to allow modules to customize their own entry
|
||||
|
||||
It also use `minApi`, `maxApi` and `minMagisk` in the `module.prop` to detect compatibility
|
||||
And support the `support` and `donate` properties to allow them to add their own support links
|
||||
And if you want to be event fancier you can setup `config` to your own config app.
|
||||
(Note: the manager use fallback values for some modules, see developer documentation for more info)
|
||||
|
||||
It also add new ways to control the installer ui via a new `#!` command system
|
||||
It allows module developers to craft a more customizable install experience.
|
||||
|
||||
If you created and uploaded a module and it doesn't appear in your module list you can disable
|
||||
the low quality filter in the app settings after enabling developer mode. **Ideally, we recommend you to fix your module metadata rather than disabling that filter.**
|
||||
|
||||
For more information please check the [developer documentation](docs/DEVELOPERS.md)
|
||||
|
||||
## Help us make our app more accessible!
|
||||
|
||||
**We need your help!** The app has started lagging behind in translations, and we need your help to
|
||||
catch up! As a reminder, translations are required to be at 60% or more to be included in the app.
|
||||
|
||||
### Weblate (recommended)
|
||||
|
||||
We use Weblate for
|
||||
translations: [https://translate.nift4.org/engage/foxmmm/](https://translate.nift4.org/engage/foxmmm/)
|
||||
|
||||
- You can create an account and start translating
|
||||
- You may need to check your spam folder for the confirmation email
|
||||
|
||||
### GitHub method (advanced users)
|
||||
|
||||
See [`app/src/main/res/values/strings.xml`](https://github.com/Androidacy/MagiskModuleManager/blob/master/app/src/main/res/values/strings.xml)
|
||||
|
||||
If your language is right to left don't forget to set `lang_support_rtl` to `true`.
|
||||
|
||||
Translators do not need to have any previous coding experience.
|
||||
|
||||
## Add your own repos
|
||||
|
||||
See [the documentation](docs/add-repo.md).
|
||||
|
||||
## Issues with a repo
|
||||
|
||||
If you have a problem with a repo, please contact the repo owner **first**. If you are unable to
|
||||
reach them or they are not willing to help, you can contact us as a last resort.
|
||||
|
||||
_The developers of this app are unable to help with any issues arising from use or installation of
|
||||
modules, and may be of limited help with issues arising from a specific repo._
|
||||
|
||||
Default repo owners:
|
||||
|
||||
- Androidacy: [Telegram](https://telegram.dog/androidacy_discussions)
|
||||
- Magisk-Modules-Alt-Repo: [GitHub](https://github.com/Magisk-Modules-Alt-Repo/submission/issues)
|
||||
|
||||
Custom repos may have their own support channels, and we are unable to provide any support
|
||||
whatsoever for them, outside of direct implementation bugs.
|
||||
|
||||
## License
|
||||
|
||||
Androidacy Module Manager, the icon, and names are copyright
|
||||
2021-present [Fox2Code](https://github.com/Fox2Code). The Androidacy name(s), logo, integration, and
|
||||
later portions of the code are copyright
|
||||
2022-present [Androidacy](https://www.androidacy.com/?utm_source=fox-repo&utm_medium=web). See
|
||||
[LICENSE](LICENCE) for details. Library licenses can be found in the licenses section of the app.
|
||||
|
||||
Modules and their files, names, and other assets are not covered by this license or other
|
||||
agreements, and are not warranted, checked, or otherwise guaranteed by the authors of this app, and may have their own licenses, agreements, and terms, of which the author(s) of this app do not check or have any responsibility for.
|
||||
|
||||
Some third party backend services may have additional terms, please check their
|
||||
terms of service before
|
||||
using them.
|
||||
|
||||
## EULA
|
||||
|
||||
The EULA can be found [here](https://www.androidacy.com/foxmmm-eula/). By downloading, installing,
|
||||
or using this app you agree to the supplemental terms of the EULA.
|
||||
|
||||
**IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR AN CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.**
|
||||
> **Copyright © 2023 Androidacy. All rights reserved.**
|
||||
|
||||
@ -1,47 +1,63 @@
|
||||
## Adding custom repositories
|
||||
# How to Add Custom Repositories to Androidacy Module Manager
|
||||
|
||||
You have two options:
|
||||
## Table of Contents
|
||||
|
||||
### Option 1: Add your repo to the app for yourself:
|
||||
- [Introduction](#introduction)
|
||||
- [Adding a Repo for Personal Use](#adding-a-repo-for-personal-use)
|
||||
- [Adding a Repo for Public Use](#adding-a-repo-for-public-use)
|
||||
- [How to Apply for Inclusion](#how-to-apply)
|
||||
|
||||
1. You need the modules.json link of your repo, if you don't have one please contact the repo owner.
|
||||
2. Open the app and go to the settings.
|
||||
3. Go to repos at the top.
|
||||
4. Scroll to the bottom and click on the "Add repo" button.
|
||||
5. Paste the modules.json link and click on the "Add" button.
|
||||
6. You can now download modules from your repo.
|
||||
## Introduction
|
||||
|
||||
### Option 2: Add your repo to the app for everyone:
|
||||
This guide shows you how to add custom repositories to the Androidacy Module Manager (AMM). There are two ways to do this:
|
||||
|
||||
To add you own repo to AMM it need to follow theses conditions:
|
||||
1. **Adding a Repo for Personal Use**: This is for individual users who want to add a specific repo just for themselves.
|
||||
2. **Adding a Repo for Public Use**: This is for repo owners who want their repo to be available to all AMM users.
|
||||
|
||||
- The module repo or at least one of it's owners must be known.
|
||||
- Modules in the repo must be monitored, and malicious modules must be removed.
|
||||
- Module repo must have a valid, working, automatically or frequently updated `modules.json`
|
||||
([Example](https://github.com/Magisk-Modules-Alt-Repo/json/blob/main/modules.json))
|
||||
## Adding a Repo for Personal Use
|
||||
|
||||
These guidelines are not mandatory, but not following them may result in your repo being removed or
|
||||
not being added in the first place.
|
||||
### Steps
|
||||
|
||||
1. **Get the URL**: You need the `modules.json` link of the repo you want to add. If you don't have it, ask the repo owner.
|
||||
2. **Open the App**: Go to the settings in the AMM app.
|
||||
3. **Find Repos**: Click on the 'Repos' option at the top of the settings.
|
||||
4. **Add New Repo**: Scroll down and click the 'Add repo' button.
|
||||
5. **Enter the URL**: Paste the `modules.json` link and click 'Add'.
|
||||
|
||||
> **Note**: Some features might not work fully with custom repos.
|
||||
|
||||
## Adding a Repo for Public Use
|
||||
|
||||
### Requirements
|
||||
|
||||
**In short:**
|
||||
|
||||
- **Known Owner**: The repo or one of its owners should be well-known.
|
||||
- **Safe Modules**: The repo should actively remove any harmful modules.
|
||||
- **Updated Data**: The repo must have an up-to-date `modules.json` file.
|
||||
|
||||
**In detail:**
|
||||
<details>
|
||||
<summary>Click to see the guidelines</summary>
|
||||
|
||||
- Repos must process and take-down off their repo module where it's removal was provably
|
||||
requested by
|
||||
their
|
||||
original author
|
||||
- Repos may not collect and/or distribute any personally identifiable data (including IP
|
||||
addresses) without
|
||||
informing
|
||||
users
|
||||
that they do so and offering a way to opt out
|
||||
- Modules owners must be aware that their modules are being hosted on the repository and/or have a
|
||||
way to remove their modules from the repository
|
||||
- Modules owners must be aware of any change made of the distributed version of their modules.
|
||||
- Repos should make an effort to keep users safe, via a review process, or by using a
|
||||
whitelist/blacklist
|
||||
<summary>Click to expand full guidelines</summary>
|
||||
|
||||
- **Author Approval**: Repos should only host modules if the original author agrees or the license permits. If repository uses automated tools to add modules, they should have an opt out process or a way to request removal.
|
||||
- **Privacy**: Don't collect personal data without telling users. Data used for advertising and analytics should be anonymized where possible, or otherwise declared in accordance with applicable laws.
|
||||
- **Transparency**: Let module owners know if their module is on your repo and if you make any changes to it. This can be done by including a searchable list of modules on your website.
|
||||
- **Safety**: Try to keep users safe by reviewing modules or using a whitelist/blacklist. Reasonable measures should be taken to prevent malware and other harmful modules from being hosted, and to protect other's intellectual property.
|
||||
|
||||
</details>
|
||||
|
||||
In all scenarios, insofar that their policies are not in conflict with the above, the repo owner's
|
||||
poloicies take precedence over the above guidelines. We encourage users to check the guidelines of
|
||||
the repo they are using.
|
||||
_**Note**: Repo owners can have their own rules, but they should not conflict with these guidelines. Always check the repo's own guidelines. In addition, these are just guidelines, and Androidacy reserves the right to remove any repo or refuse to add any repo for any reason whatsoever._
|
||||
|
||||
### How to Apply
|
||||
|
||||
If your repo meets these requirements, open an issue with:
|
||||
|
||||
- **Repo Name**: The name of your repo.
|
||||
- **Website**: The official website of the repo.
|
||||
- **Contact**: A way to contact you, like email or Telegram.
|
||||
- **How to Add**: Steps or documentation on how to add the repo to AMM.
|
||||
|
||||
**Note**: Each repo will be reviewed on a case-by-case basis. Meeting these guidelines does not guarantee inclusion in AMM.
|
||||
|
||||
> Copyright © 2023 Androidacy. All Rights Reserved.
|
||||
|
||||
Loading…
Reference in New Issue