Skip to content
This repository was archived by the owner on May 4, 2023. It is now read-only.

Commit 8adca83

Browse files
committed
Improve wording, add funding
1 parent fa24cea commit 8adca83

File tree

3 files changed

+19
-15
lines changed

3 files changed

+19
-15
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
custom: ["https://www.paypal.com/paypalme/fox2code"]

DEVELOPERS.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,15 @@
33
Note: This doc assume you already read the
44
[official Magisk module developer guide](https://topjohnwu.github.io/Magisk/guides.html)
55

6-
Also note that *Fox's Magisk Module Manager* will be shorten to fox *Fox's Mmm* in this doc
7-
8-
Index:
6+
Index:
97
- [Properties](DEVELOPERS.md#properties)
108
- [Installer commands](DEVELOPERS.md#installer-commands)
119

1210
## Properties
1311

1412
In addition to the following magisk properties
1513
```properties
14+
# Magisk supported properties
1615
id=<string>
1716
name=<string>
1817
version=<string>
@@ -21,7 +20,7 @@ author=<string>
2120
description=<string>
2221
```
2322

24-
This the app manager support these new properties
23+
This the manager support these new properties
2524
```properties
2625
# Fox's Mmm supported properties
2726
minApi=<int>
@@ -39,12 +38,13 @@ config=<package>
3938
- `support` support link to direct users when they need support for you modules
4039
- `donate` donate link to direct users to where they can financially support your project
4140
- `config` package name of the application that configure your module
42-
(Note: Locally installed module don't show the button on the install screen)
41+
(Note: The icon won't appear in the module list if the module and target app is not installed)
4342

4443
Note: Fox's Mmm use fallback
4544
[here](app/src/main/java/com/fox2code/mmm/utils/PropUtils.java#L21)
4645
for some modules
47-
Theses values are only used if not defined in the `module.prop` files
46+
Theses values are only used if not defined in the `module.prop` files
47+
So the original module maker can still override them
4848

4949
## Installer commands
5050

@@ -56,7 +56,8 @@ All the commands start with it `#!`, by default the manager process command as l
5656
unless `#!useExt` is sent to indicate that the app is ready to use commands
5757

5858
Commands:
59-
- `useExt`: Enable the execution of commands
59+
- `useExt`: Tell the manager you would like to use commands
60+
(Note: Any command executed before this one will just appear as log in the console)
6061
- `addLine <arg>`: Add line to the terminal, this commands can be useful if
6162
you want to display text that start with `#!` inside the terminal
6263
- `setLastLine <arg>`: Set the last line of text displayed in the terminal
@@ -66,9 +67,8 @@ Commands:
6667
- `showLoading`: Show an indeterminate progress bar
6768
(Note: the bar is automatically hidden when the install finish)
6869
- `hideLoading`: Hide the indeterminate progress bar if previously shown
69-
- `setSupportLink <url>`: Set support link when loading finishes
70-
(Note: It override the config button if loaded from repo, it's recommended
71-
to only use this command when the script fail, or don't have any config app)
70+
- `setSupportLink <url>`: Set support link to show when the install finish
71+
(Note: Modules installed from repo will not show the config button if a link is set)
7272

7373
Note:
7474
The current behavior with unknown command is to ignore them,
@@ -91,6 +91,7 @@ And there is an instance of it in use
9191
mmm_exec showLoading
9292
ui_print "The installer doesn't support mmm_exec"
9393
mmm_exec setLastLine "The installer support mmm_exec"
94+
# Wait simulate module doing something
9495
sleep 5
9596
mmm_exec hideLoading
9697
mmm_exec setSupportLink https://github.com/Fox2Code/FoxMagiskModuleManager

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# Fox's Magisk Module Manager
22

33
The official Magisk is dropping support to download online modules...
4-
So I made my own app to do that!
4+
So I made my own app to do that! :3
55

66
**This app is not officially supported by Magisk or it's developers**
77

88
## For users
99

10-
Related commits:
10+
Related commits:
1111
- [`Remove online section in modules fragment`](https://github.com/topjohnwu/Magisk/commit/f5c982355a2e3380b2b64af4b0caa8f4f7cf9157)
1212
- [`Cleanup unused code`](https://github.com/topjohnwu/Magisk/commit/8d59caf635591eb23813d75601039bb138f5716b)
1313

14+
Note: These changes didn't hit canary, beta, or release yet.
15+
1416
The app currently use these two repo as their modules sources:
15-
[https://github.com/Magisk-Modules-Alt-Repo](https://github.com/Magisk-Modules-Alt-Repo)
17+
[https://github.com/Magisk-Modules-Alt-Repo](https://github.com/Magisk-Modules-Alt-Repo)
1618
[https://github.com/Magisk-Modules-Repo](https://github.com/Magisk-Modules-Repo)
1719

1820
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
2224

2325
## For developers
2426

25-
The manager add and read new meta keys to modules
27+
The manager can read new meta keys to allow modules to customize their entry
2628

2729
It use `module.prop` the `minApi=<int>` and `minMagisk=<int>` properties to detect compatibility
2830
And use the `support=<url>` and `donate=<url>` key to detect module related links
2931

30-
It also add new ways to control the installer ui via a new command system
32+
It also add new ways to control the installer ui via a new `#!` command system
3133

3234
For more information please check the [developer documentation](DEVELOPERS.md)
3335

0 commit comments

Comments
 (0)