d7cd1ff142
*Total -- 990.86kb -> 771.48kb (22.14%) /docs/images/flashfire.png -- 223.55kb -> 153.39kb (31.39%) /docs/images/repo_description.png -- 38.55kb -> 27.31kb (29.15%) /docs/images/manager_reboot.png -- 147.43kb -> 111.50kb (24.37%) /docs/images/install_inactive_slot.png -- 123.15kb -> 99.79kb (18.97%) /docs/images/restore_img.png -- 134.17kb -> 109.22kb (18.59%) /docs/images/disable_auto_ota.png -- 160.04kb -> 132.05kb (17.49%) /docs/images/ota_done.png -- 163.97kb -> 138.22kb (15.71%) |
||
---|---|---|
app | ||
chromeos | ||
docs | ||
gradle/wrapper | ||
native | ||
scripts | ||
snet | ||
utils | ||
.gitattributes | ||
.gitignore | ||
.gitmodules | ||
build.gradle | ||
build.py | ||
config.prop.sample | ||
gradle.properties | ||
gradlew | ||
gradlew.bat | ||
LICENSE | ||
README.MD | ||
settings.gradle |
Magisk
Building Environment Requirements
- Python 3.5+: run
build.py
script - Java Development Kit (JDK) 8: Compile Magisk Manager and sign zips
- Latest Android SDK: set
ANDROID_HOME
environment variable to the path to Android SDK - Android NDK: Install NDK along with SDK (
$ANDROID_HOME/ndk-bundle
), or optionally specify a custom pathANDROID_NDK_HOME
- (Windows Only) Python package Colorama: Install with
pip install colorama
, used for ANSI color codes
Building Notes and Instructions
- Building is supported on macOS, Linux, and Windows using the custom NDK: FrankeNDK.
- Set configurations in
config.prop
. A sample fileconfig.prop.sample
is provided as an example. - Run
build.py
with argument-h
to see the built-in help message. The-h
option also works for each supported actions, e.g../build.py binary -h
- By default,
build.py
build binaries and Magisk Manager in debug mode. If you want to build Magisk Manager in release mode (via the-r, --release
flag), you need a Java Keystore filerelease-key.jks
(onlyJKS
format is supported) to sign APKs and zips. For more information, check out Google's Official Documentation.
Documentation
License
Magisk, including all git submodules are free software:
you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.