Skip to content

Commit 60360fb

Browse files
committed
Initial commit
0 parents  commit 60360fb

File tree

106 files changed

+101401
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+101401
-0
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
*.iml
2+
.gradle
3+
/local.properties
4+
/.idea/
5+
.DS_Store
6+
/build
7+
/captures
8+
.externalNativeBuild
9+
.cxx
10+
local.properties

DEVELOPERS.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Fox's Magisk Module Manager (Developer documentation)
2+
3+
Note: This doc assume you already read the
4+
[official Magisk module developer guide](https://topjohnwu.github.io/Magisk/guides.html)
5+
6+
Also note that *Fox's Magisk Module Manager* will be shorten to fox *Fox's Mmm* in this doc
7+
8+
Index:
9+
- [Properties](DEVELOPERS.md#properties)
10+
- [Installer commands](DEVELOPERS.md#installer-commands)
11+
12+
## Properties
13+
14+
In addition to the following magisk properties
15+
```properties
16+
id=<string>
17+
name=<string>
18+
version=<string>
19+
versionCode=<int>
20+
author=<string>
21+
description=<string>
22+
```
23+
24+
This the app manager support these new properties
25+
```properties
26+
# Fox's Mmm supported properties
27+
minApi=<int>
28+
minMagisk=<int>
29+
support=<url>
30+
donate=<url>
31+
config=<package>
32+
```
33+
(Note: All urls must start with `https://`, or else will be ignored)
34+
35+
- `minApi` tell the manager which is the minimum SDK version required for the module
36+
(See: [Codenames, Tags, and Build Numbers](https://source.android.com/setup/start/build-numbers))
37+
- `minMagisk` tell the manager which is the minimum Magisk version required for the module
38+
(Often for magisk `xx.y` the version code is `xxy00`)
39+
- `support` support link to direct users when they need support for you modules
40+
- `donate` donate link to direct users to where they can financially support your project
41+
- `config` package name of the application that configure your module
42+
(Note: Locally installed module don't show the button on the install screen)
43+
44+
Note: Fox's Mmm use fallback
45+
[here](app/src/main/java/com/fox2code/mmm/utils/PropUtils.java)
46+
for some modules
47+
Theses values are only used if not defined in the `module.prop` files
48+
49+
## Installer commands
50+
51+
The Fox's Mmm also allow better control over it's installer interface
52+
53+
Fox's Mmm defined the variable `MMM_EXT_SUPPORT` to expose it's extension support
54+
55+
All the commands start with it `#!`, by default the manager process command as log output
56+
unless `#!useExt` is sent to indicate that the app is ready to use commands
57+
58+
Commands:
59+
- `useExt`: Enable the execution of commands
60+
- `addLine <arg>`: Add line to the terminal, this commands can be useful if
61+
you want to display text that start with `#!` inside the terminal
62+
- `setLastLine <arg>`: Set the last line of text displayed in the terminal
63+
- `clearTerminal`: Clear the terminal of any text, making it empty
64+
- `scrollUp`: Scroll up at the top of the terminal
65+
- `scrollDown`: Scroll down at the bottom of the terminal
66+
- `showLoading`: Show an indeterminate progress bar
67+
(Note: the bar is automatically hidden when the install finish)
68+
- `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)
72+
73+
Note:
74+
The current behavior with unknown command is to ignore them,
75+
I may add or remove commands in the future depending of how they are used
76+
77+
A wrapper script to use theses commands could be
78+
```sh
79+
if [ -n "$MMM_EXT_SUPPORT" ]; then
80+
ui_print "#!useExt"
81+
mmm_exec() {
82+
ui_print "$(echo "#!$@")"
83+
}
84+
else
85+
mmm_exec() { true; }
86+
fi
87+
```
88+
And there is an instance of it in use
89+
```sh
90+
# mmm_exec only take effect if inside the loader
91+
mmm_exec showLoading
92+
ui_print "The installer doesn't support mmm_exec"
93+
mmm_exec setLastLine "The installer support mmm_exec"
94+
sleep 5
95+
mmm_exec hideLoading
96+
mmm_exec setSupportLink https://github.com/Fox2Code/FoxMagiskModuleManager
97+
```
98+
99+
You may look at the [example module](example_module) code or
100+
download the [module zip](example_module.zip) and try it yourself
101+
102+
Have fun with the API making the user install experience a unique experience
103+
104+
Also there is the source of the app icon
105+
[here](https://romannurik.github.io/AndroidAssetStudio/icons-launcher.html#foreground.type=clipart&foreground.clipart=extension&foreground.space.trim=0&foreground.space.pad=0.25&foreColor=rgb(255%2C%20255%2C%20255)&backColor=rgb(255%2C%20152%2C%200)&crop=0&backgroundShape=circle&effects=elevate&name=ic_launcher)
106+
.

LICENCE

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Fox's Magisk Module Manager
2+
3+
The official Magisk is dropping support to download online modules...
4+
So I made my own app to do that!
5+
6+
**This app is not officially supported by Magisk or it's developers**
7+
8+
# For users
9+
10+
Related commits:
11+
- [Remove online section in modules fragment](https://github.com/topjohnwu/Magisk/commit/f5c982355a2e3380b2b64af4b0caa8f4f7cf9157)
12+
- [Cleanup unused code](https://github.com/topjohnwu/Magisk/commit/8d59caf635591eb23813d75601039bb138f5716b)
13+
- [Remove DoH](https://github.com/topjohnwu/Magisk/commit/acf25aa4d31ee221354019daa097ccff579b8704)
14+
*(Note: DoH was used to fix modules Downloads by preventing MiTM on DNS queries)*
15+
16+
The app currently use these two repo as their modules sources:
17+
[https://github.com/Magisk-Modules-Alt-Repo](https://github.com/Magisk-Modules-Alt-Repo)
18+
[https://github.com/Magisk-Modules-Repo](https://github.com/Magisk-Modules-Repo)
19+
20+
As the main repo may shutting down due to the main app no longer supporting it,
21+
I recommend submitting your modules [here](https://github.com/Magisk-Modules-Alt-Repo/submission) instead
22+
23+
If a module is in both repo, the manager will just pick the most up to date version of the module
24+
25+
# For developers
26+
27+
The manager add and read new meta keys to modules
28+
29+
It use `module.prop` the `minApi` and `minMagisk` properties to detect compatibility
30+
And use the `support` and `donate` key to detect module related links
31+
32+
It also add new ways to control the installer ui via a new command system
33+
34+
For more information please check the [developer documentation](DEVELOPERS.md)

app/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/build
2+
/release

app/build.gradle

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
plugins {
2+
id 'com.android.application'
3+
id 'com.mikepenz.aboutlibraries.plugin'
4+
}
5+
6+
android {
7+
compileSdk 30
8+
9+
defaultConfig {
10+
applicationId "com.fox2code.mmm"
11+
minSdk 21
12+
targetSdk 30
13+
versionCode 1
14+
versionName "0.0.1"
15+
16+
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
17+
}
18+
19+
buildTypes {
20+
release {
21+
minifyEnabled true
22+
shrinkResources true
23+
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
24+
}
25+
debug {
26+
applicationIdSuffix '.debug'
27+
debuggable true
28+
}
29+
}
30+
compileOptions {
31+
sourceCompatibility JavaVersion.VERSION_1_8
32+
targetCompatibility JavaVersion.VERSION_1_8
33+
}
34+
}
35+
36+
aboutLibraries {
37+
additionalLicenses {
38+
LGPL_3_0_only
39+
}
40+
}
41+
42+
dependencies {
43+
// UI
44+
implementation 'androidx.appcompat:appcompat:1.3.1'
45+
implementation 'androidx.preference:preference:1.1.1'
46+
implementation 'androidx.constraintlayout:constraintlayout:2.1.0'
47+
implementation 'androidx.recyclerview:recyclerview:1.2.1'
48+
implementation 'androidx.swiperefreshlayout:swiperefreshlayout:1.1.0'
49+
implementation 'com.google.android.material:material:1.4.0'
50+
implementation "com.mikepenz:aboutlibraries:${latestAboutLibsRelease}"
51+
52+
// Utils
53+
implementation 'com.squareup.okhttp3:okhttp-dnsoverhttps:4.9.1'
54+
implementation 'com.github.topjohnwu.libsu:io:3.1.2'
55+
56+
// Markdown
57+
implementation "io.noties.markwon:core:4.6.2"
58+
implementation "io.noties.markwon:html:4.6.2"
59+
implementation "io.noties.markwon:image:4.6.2"
60+
implementation "com.caverock:androidsvg:1.4"
61+
62+
// Test
63+
testImplementation 'junit:junit:4.+'
64+
androidTestImplementation 'androidx.test.ext:junit:1.1.3'
65+
androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
66+
}

0 commit comments

Comments
 (0)