Improve wording, add funding

pull/27/head
Fox2Code 5 years ago
parent fa24ceab46
commit 8adca83f5f

@ -0,0 +1 @@
custom: ["https://www.paypal.com/paypalme/fox2code"]

@ -3,8 +3,6 @@
Note: This doc assume you already read the Note: This doc assume you already read the
[official Magisk module developer guide](https://topjohnwu.github.io/Magisk/guides.html) [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) - [Properties](DEVELOPERS.md#properties)
- [Installer commands](DEVELOPERS.md#installer-commands) - [Installer commands](DEVELOPERS.md#installer-commands)
@ -13,6 +11,7 @@ Index:
In addition to the following magisk properties In addition to the following magisk properties
```properties ```properties
# Magisk supported properties
id=<string> id=<string>
name=<string> name=<string>
version=<string> version=<string>
@ -21,7 +20,7 @@ author=<string>
description=<string> description=<string>
``` ```
This the app manager support these new properties This the manager support these new properties
```properties ```properties
# Fox's Mmm supported properties # Fox's Mmm supported properties
minApi=<int> minApi=<int>
@ -39,12 +38,13 @@ config=<package>
- `support` support link to direct users when they need support for you modules - `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 - `donate` donate link to direct users to where they can financially support your project
- `config` package name of the application that configure your module - `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 Note: Fox's Mmm use fallback
[here](app/src/main/java/com/fox2code/mmm/utils/PropUtils.java#L21) [here](app/src/main/java/com/fox2code/mmm/utils/PropUtils.java#L21)
for some modules 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 ## 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 unless `#!useExt` is sent to indicate that the app is ready to use commands
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 <arg>`: Add line to the terminal, this commands can be useful if - `addLine <arg>`: Add line to the terminal, this commands can be useful if
you want to display text that start with `#!` inside the terminal you want to display text that start with `#!` inside the terminal
- `setLastLine <arg>`: Set the last line of text displayed in the terminal - `setLastLine <arg>`: Set the last line of text displayed in the terminal
@ -66,9 +67,8 @@ Commands:
- `showLoading`: Show an indeterminate progress bar - `showLoading`: Show an indeterminate progress bar
(Note: the bar is automatically hidden when the install finish) (Note: the bar is automatically hidden when the install finish)
- `hideLoading`: Hide the indeterminate progress bar if previously shown - `hideLoading`: Hide the indeterminate progress bar if previously shown
- `setSupportLink <url>`: Set support link when loading finishes - `setSupportLink <url>`: Set support link to show when the install finish
(Note: It override the config button if loaded from repo, it's recommended (Note: Modules installed from repo will not show the config button if a link is set)
to only use this command when the script fail, or don't have any config app)
Note: Note:
The current behavior with unknown command is to ignore them, 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 mmm_exec showLoading
ui_print "The installer doesn't support mmm_exec" ui_print "The installer doesn't support mmm_exec"
mmm_exec setLastLine "The installer support mmm_exec" mmm_exec setLastLine "The installer support mmm_exec"
# Wait simulate module doing something
sleep 5 sleep 5
mmm_exec hideLoading mmm_exec hideLoading
mmm_exec setSupportLink https://github.com/Fox2Code/FoxMagiskModuleManager mmm_exec setSupportLink https://github.com/Fox2Code/FoxMagiskModuleManager

@ -1,7 +1,7 @@
# Fox's Magisk Module Manager # Fox's Magisk Module Manager
The official Magisk is dropping support to download online modules... 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** **This app is not officially supported by Magisk or it's developers**
@ -11,6 +11,8 @@ Related commits:
- [`Remove online section in modules fragment`](https://github.com/topjohnwu/Magisk/commit/f5c982355a2e3380b2b64af4b0caa8f4f7cf9157) - [`Remove online section in modules fragment`](https://github.com/topjohnwu/Magisk/commit/f5c982355a2e3380b2b64af4b0caa8f4f7cf9157)
- [`Cleanup unused code`](https://github.com/topjohnwu/Magisk/commit/8d59caf635591eb23813d75601039bb138f5716b) - [`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: 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) [https://github.com/Magisk-Modules-Repo](https://github.com/Magisk-Modules-Repo)
@ -22,12 +24,12 @@ If a module is in both repo, the manager will just pick the most up to date vers
## For developers ## 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=<int>` and `minMagisk=<int>` properties to detect compatibility It use `module.prop` the `minApi=<int>` and `minMagisk=<int>` properties to detect compatibility
And use the `support=<url>` and `donate=<url>` key to detect module related links And use the `support=<url>` and `donate=<url>` 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) For more information please check the [developer documentation](DEVELOPERS.md)

Loading…
Cancel
Save