MarcoBuster/Magisk
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
b8bd83ba05
Magisk/README.MD
topjohnwu c6d2bf577f Massive building system rewrite
2018-05-13 03:04:40 +08:00

3.1 KiB
Raw Blame History

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
  5. (Windows Only) Python package Colorama: Install with pip install colorama, used for ANSI color codes

Building Notes and Instructions

  1. Building is tested on macOS, Ubuntu, and Windows 10 using the latest stable NDK and NDK r10e. Officially released binaries were built with NDK r10e.
  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 will build binaries and Magisk Manager in debug mode. If you want to build Magisk Manager in release mode (through the --release flag), you will need to place a Java Keystore file at release-key.jks to sign Magisk Manager's APK. For more information, check out Google's Official 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/>.

Credits

MagiskManager (app)

  • Copyright 2016-2018, John Wu (@topjohnwu)
  • All contributors and translators on Github

MagiskSU (native/jni/su)

  • Copyright 2016-2018, John Wu (@topjohnwu)
  • Copyright 2015, Pierre-Hugues Husson (phh@phh.me)
  • Copyright 2013, Koushik Dutta (@koush)
  • Copyright 2010, Adam Shanks (@ChainsDD)
  • Copyright 2008, Zinx Verituse (@zinxv)

MagiskPolicy (native/jni/magiskpolicy)

  • Copyright 2016-2018, John Wu (@topjohnwu)
  • Copyright 2015, Pierre-Hugues Husson (phh@phh.me)
  • Copyright 2015, Joshua Brindle (@joshua_brindle)

MagiskHide (native/jni/magiskhide)

  • Copyright 2016-2018, John Wu (@topjohnwu)
  • Copyright 2016, Pierre-Hugues Husson (phh@phh.me)

resetprop (native/jni/resetprop)

  • Copyright 2016-2018 John Wu (@topjohnwu)
  • Copyright 2016 nkk71 (nkk71x@gmail.com)

External Dependencies (native/jni/external)

  • Makefile for busybox, generated by ndk-busybox-kitchen
  • Each dependencies has its own license/copyright information in each subdirectory.
    All of them are either GPL or GPL compatible.

Others Not Mentioned

  • Copyright 2016-2018, John Wu (@topjohnwu)