TheArchive/Magisk
1
0
Fork 0
mirror of https://github.com/topjohnwu/Magisk.git synced 2024-11-27 12:05:30 +00:00
Code Issues Packages Projects Releases Wiki Activity
The Magic Mask for Android
2,100 Commits 1 Branch 138 Tags 106 MiB
C++ 36.9%
Kotlin 30.1%
Rust 16.5%
Java 9%
Shell 4.8%
Other 2.6%
64601baa76
Go to file
topjohnwu 64601baa76 Update Magisk Manager README
2018-08-30 04:03:14 -04:00
app Update Magisk Manager README 2018-08-30 04:03:14 -04:00
chromeos Massive build script refactor 2017-06-03 20:31:02 +08:00
docs fix typos 2018-06-19 14:28:09 -07:00
gradle/wrapper Update Gradle wrapper to 4.6 2018-04-22 03:09:02 +08:00
native Update to BusyBox 1.29.2 2018-08-13 01:30:15 +08:00
scripts Keep dm/avb-verity when device is using system_root_image 2018-08-29 00:40:14 -04:00
snet Update snet extension 2018-08-22 11:50:21 +08:00
utils Sign release zips with release-key.jks 2018-08-05 02:29:40 +08:00
.gitattributes Build everything ourselves 2017-08-24 12:14:17 +08:00
.gitignore Update SafetyNet extension implementation 2018-06-10 02:35:03 +08:00
.gitmodules Remove magiskpolicy as submodule 2018-07-18 18:43:36 +08:00
build.gradle Update snet extension 2018-08-22 11:50:21 +08:00
build.py Fix build scripts 2018-08-21 00:31:41 +08:00
config.prop.sample Read props directly in Gradle 2018-08-20 12:02:38 +08:00
gradle.properties Disable config ondemand when using Gradle > 4.6 2018-05-26 17:35:02 +08:00
gradlew Update Gradle wrapper to 4.6 2018-04-22 03:09:02 +08:00
gradlew.bat Update Gradle wrapper to 4.6 2018-04-22 03:09:02 +08:00
LICENSE Use GPL v3 license and update copyright messages 2017-04-22 17:12:54 +08:00
README.MD Switch to FrankeNDK for building native 2018-08-11 18:46:55 +08:00
settings.gradle Rename module core to native 2018-01-27 09:11:28 +08:00

README.MD

Magisk

Building Environment Requirements

  1. Python 3.5+: run build.py script
  2. Java Development Kit (JDK) 8: Compile Magisk Manager and sign zips
  3. Latest Android SDK: set ANDROID_HOME environment variable to the path to Android SDK
  4. Android NDK: Install NDK along with SDK ($ANDROID_HOME/ndk-bundle), or optionally specify a custom path ANDROID_NDK_HOME
  5. (Windows Only) Python package Colorama: Install with pip install colorama, used for ANSI color codes

Building Notes and Instructions

  1. Building is supported on macOS, Linux, and Windows using the custom NDK: FrankeNDK.
  2. Set configurations in config.prop. A sample file config.prop.sample is provided as an example.
  3. 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
  4. 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 file release-key.jks (only JKS format is supported) to sign APKs and zips. For more information, check out Google's Official Documentation.

Documentation

Link to 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/>.