From 8adca83f5ffb3b9090257fa7e88b2ddd157757d9 Mon Sep 17 00:00:00 2001 From: Fox2Code Date: Fri, 1 Oct 2021 23:21:05 +0200 Subject: [PATCH] Improve wording, add funding --- .github/FUNDING.yml | 1 + DEVELOPERS.md | 21 +++++++++++---------- README.md | 12 +++++++----- 3 files changed, 19 insertions(+), 15 deletions(-) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..41ed359 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +custom: ["https://www.paypal.com/paypalme/fox2code"] diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 8d62c8c..6be2d48 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -3,9 +3,7 @@ Note: This doc assume you already read the [official Magisk module developer guide](https://topjohnwu.github.io/Magisk/guides.html) -Also note that *Fox's Magisk Module Manager* will be shorten to fox *Fox's Mmm* in this doc - -Index: +Index: - [Properties](DEVELOPERS.md#properties) - [Installer commands](DEVELOPERS.md#installer-commands) @@ -13,6 +11,7 @@ Index: In addition to the following magisk properties ```properties +# Magisk supported properties id= name= version= @@ -21,7 +20,7 @@ author= description= ``` -This the app manager support these new properties +This the manager support these new properties ```properties # Fox's Mmm supported properties minApi= @@ -39,12 +38,13 @@ config= - `support` support link to direct users when they need support for you modules - `donate` donate link to direct users to where they can financially support your project - `config` package name of the application that configure your module - (Note: Locally installed module don't show the button on the install screen) + (Note: The icon won't appear in the module list if the module and target app is not installed) Note: Fox's Mmm use fallback [here](app/src/main/java/com/fox2code/mmm/utils/PropUtils.java#L21) for some modules -Theses values are only used if not defined in the `module.prop` files +Theses values are only used if not defined in the `module.prop` files +So the original module maker can still override them ## Installer commands @@ -56,7 +56,8 @@ All the commands start with it `#!`, by default the manager process command as l unless `#!useExt` is sent to indicate that the app is ready to use commands Commands: -- `useExt`: Enable the execution of commands +- `useExt`: Tell the manager you would like to use commands + (Note: Any command executed before this one will just appear as log in the console) - `addLine `: Add line to the terminal, this commands can be useful if you want to display text that start with `#!` inside the terminal - `setLastLine `: Set the last line of text displayed in the terminal @@ -66,9 +67,8 @@ Commands: - `showLoading`: Show an indeterminate progress bar (Note: the bar is automatically hidden when the install finish) - `hideLoading`: Hide the indeterminate progress bar if previously shown -- `setSupportLink `: Set support link when loading finishes - (Note: It override the config button if loaded from repo, it's recommended - to only use this command when the script fail, or don't have any config app) +- `setSupportLink `: Set support link to show when the install finish + (Note: Modules installed from repo will not show the config button if a link is set) Note: The current behavior with unknown command is to ignore them, @@ -91,6 +91,7 @@ And there is an instance of it in use mmm_exec showLoading ui_print "The installer doesn't support mmm_exec" mmm_exec setLastLine "The installer support mmm_exec" +# Wait simulate module doing something sleep 5 mmm_exec hideLoading mmm_exec setSupportLink https://github.com/Fox2Code/FoxMagiskModuleManager diff --git a/README.md b/README.md index 2d66c92..d3f6ad9 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,20 @@ # Fox's Magisk Module Manager The official Magisk is dropping support to download online modules... -So I made my own app to do that! +So I made my own app to do that! :3 **This app is not officially supported by Magisk or it's developers** ## For users -Related commits: +Related commits: - [`Remove online section in modules fragment`](https://github.com/topjohnwu/Magisk/commit/f5c982355a2e3380b2b64af4b0caa8f4f7cf9157) - [`Cleanup unused code`](https://github.com/topjohnwu/Magisk/commit/8d59caf635591eb23813d75601039bb138f5716b) +Note: These changes didn't hit canary, beta, or release yet. + The app currently use these two repo as their modules sources: -[https://github.com/Magisk-Modules-Alt-Repo](https://github.com/Magisk-Modules-Alt-Repo) +[https://github.com/Magisk-Modules-Alt-Repo](https://github.com/Magisk-Modules-Alt-Repo) [https://github.com/Magisk-Modules-Repo](https://github.com/Magisk-Modules-Repo) As the main repo may shutting down due to the main app no longer supporting it. @@ -22,12 +24,12 @@ If a module is in both repo, the manager will just pick the most up to date vers ## For developers -The manager add and read new meta keys to modules +The manager can read new meta keys to allow modules to customize their entry It use `module.prop` the `minApi=` and `minMagisk=` properties to detect compatibility And use the `support=` and `donate=` key to detect module related links -It also add new ways to control the installer ui via a new command system +It also add new ways to control the installer ui via a new `#!` command system For more information please check the [developer documentation](DEVELOPERS.md)