Update Magisk Manager

Close #381

.gitattributes

@@ -8,9 +8,11 @@
 
 # Declare files that will always have CRLF line endings on checkout.
 *.cmd text eol=crlf
+*.bat text eol=crlf
 
 # Denote all files that are truly binary and should not be modified.
-binaries/** binary
+chromeos/** binary
 *.jar binary
 *.exe binary
 *.apk binary
+*.png binary

.gitignore

@@ -1,22 +1,16 @@
-obj/
-libs/
+out
 *.zip
+*.jks
+*.apk
 
-# Copied binaries
-zip_static/arm/*
-zip_static/arm64/*
-zip_static/x86/*
-zip_static/x64/*
-zip_static/chromeos/*
-uninstaller/arm/*
-uninstaller/arm64/*
-uninstaller/x86/*
-uninstaller/x64/*
-uninstaller/chromeos/*
+# Built binaries
 ziptools/zipadjust
 
-# Generated scripts
-uninstaller/common/
-zip_static/common/*.sh
-zip_static/common/*.rc
-zip_static/META-INF/com/google/android/update-binary
+# Android Studio / Gradle
+*.iml
+.gradle
+/local.properties
+/.idea
+/build
+/captures
+.externalNativeBuild

.gitmodules

@@ -1,12 +1,27 @@
-[submodule "jni/selinux"]
-	path = jni/selinux
+[submodule "selinux"]
+	path = native/jni/external/selinux
 	url = https://github.com/topjohnwu/selinux.git
-[submodule "jni/su"]
-	path = jni/su
+[submodule "su"]
+	path = native/jni/su
 	url = https://github.com/topjohnwu/MagiskSU.git
-[submodule "jni/ndk-compression"]
-	path = jni/ndk-compression
-	url = https://github.com/topjohnwu/ndk-compression.git
-[submodule "jni/magiskpolicy"]
-	path = jni/magiskpolicy
+[submodule "magiskpolicy"]
+	path = native/jni/magiskpolicy
 	url = https://github.com/topjohnwu/magiskpolicy.git
+[submodule "MagiskManager"]
+	path = app
+	url = https://github.com/topjohnwu/MagiskManager.git
+[submodule "busybox"]
+	path = native/jni/external/busybox
+	url = https://github.com/topjohnwu/ndk-busybox.git
+[submodule "dtc"]
+	path = native/jni/external/dtc
+	url = https://github.com/dgibson/dtc
+[submodule "lz4"]
+	path = native/jni/external/lz4
+	url = https://github.com/lz4/lz4.git
+[submodule "bzip2"]
+	path = native/jni/external/bzip2
+	url = https://github.com/nemequ/bzip2.git
+[submodule "xz"]
+	path = native/jni/external/xz
+	url = https://github.com/xz-mirror/xz.git

README.MD

@@ -1,11 +1,79 @@
 # Magisk
-### Static binaries included:  
-* Busybox: http://forum.xda-developers.com/android/software-hacking/tool-busybox-flashable-archs-t3348543
 
-### How to build Magisk
-1. Download and install NDK
-2. Add the NDK directory into PATH  
-To check if the PATH is set correctly, try calling `which ndk-build` (`where ndk-build` on Windows) and see if it shows the NDK directory
-3. Unix-like users (e.g. Linux & MacOS) please execute `build.sh` through shell  
-Windows users please execute `build.cmd` through cmd
-4. The scripts will show you further details
+## How to build Magisk
+
+#### Building has been tested on 3 major platforms: macOS, Ubuntu, Windows 10
+
+### 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: `ANDROID_HOME` environment variable should point to the Android SDK folder
+4. Android NDK: Install NDK along with SDK (`$ANDROID_HOME/ndk-bundle`), or specify custom path `ANDROID_NDK`
+5. (Windows Only) Python package Colorama: Install with `pip install colorama`, used for ANSI color codes
+
+### Instructions and Notes
+1. Magisk can be built with the latest NDK (r16 as of writing), however binaries released officially will be built with NDK r10e due to ELF incompatibilities with the binaries built from the newer NDKs.
+2. The easiest way to setup the environment is by importing the folder as an Android Studio project. The IDE will download required components and construct the environment for you. You still have to set the `ANDROID_HOME` environment variable to point to the SDK path.
+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. Build everything with `build.py`, don't directly call `gradlew` or `ndk-build`, since most requires special setup / dependencies.
+5. 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 flag `--release`), you will need to place a Java Keystore file at `release_signature.jks` to sign Magisk Manager's APK. For more information, check out [Google's Official Documentation](https://developer.android.com/studio/publish/app-signing.html#signing-manually).
+
+
+## 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](https://github.com/topjohnwu/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)

build.cmd

@@ -1,182 +0,0 @@
-@ECHO OFF
-SETLOCAL ENABLEEXTENSIONS
-SET me=%~nx0
-SET parent=%~dp0
-SET tab=	
-SET OK=
-
-CD %parent%
-
-call :%~1 "%~2"
-IF NOT DEFINED OK CALL :usage
-
-EXIT /B %ERRORLEVEL%
-
-:usage
-  ECHO %me% all ^<version name^>
-  ECHO %tab%Build binaries, zip, and sign Magisk
-  ECHO %tab%This is equlivant to first ^<build^>, then ^<zip^>
-  ECHO %me% clean
-  ECHO %tab%Cleanup compiled / generated files
-  ECHO %me% build
-  ECHO %tab%Build the binaries with ndk
-  ECHO %me% zip ^<version name^>
-  ECHO %tab%Zip and sign Magisk
-  ECHO %me% uninstaller
-  ECHO %tab%Zip and sign the uninstaller
-  EXIT /B 1
-
-:all
-  SET OK=y
-  IF [%~1] == [] (
-    CALL :error "Missing version number"
-    CALL :usage
-    EXIT /B %ERRORLEVEL%
-  )
-  CALL :build
-  CALL :zip "%~1"
-  EXIT /B %ERRORLEVEL%
-
-:build
-  SET OK=y
-  ECHO ************************
-  ECHO * Building binaries
-  ECHO ************************
-  FOR /F "tokens=* USEBACKQ" %%F IN (`where ndk-build`) DO (
-    IF [%%F] == [] (
-      CALL :error "Please add ndk-build to PATH!"
-      EXIT /B 1
-    )
-  )
-  CALL ndk-build -j4 || CALL :error "Magisk binary tools build failed...."
-  IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
-  ECHO ************************
-  ECHO * Copying binaries
-  ECHO ************************
-  CALL :mkcp libs\armeabi-v7a\* zip_static\arm
-  CALL :mkcp libs\arm64-v8a\* zip_static\arm64
-  CALL :mkcp libs\x86\* zip_static\x86
-  CALL :mkcp libs\x86_64\* zip_static\x64
-  CALL :mkcp libs\armeabi-v7a\magiskboot uninstaller\arm
-  CALL :mkcp libs\arm64-v8a\magiskboot uninstaller\arm64
-  CALL :mkcp libs\x86\magiskboot uninstaller\x86
-  CALL :mkcp libs\x86_64\magiskboot uninstaller\x64
-  EXIT /B %ERRORLEVEL%
-
-:clean
-  SET OK=y
-  ECHO ************************
-  ECHO * Cleaning up
-  ECHO ************************
-  CALL ndk-build clean
-  2>NUL RMDIR /S /Q zip_static\arm
-  2>NUL RMDIR /S /Q zip_static\arm64
-  2>NUL RMDIR /S /Q zip_static\x86
-  2>NUL RMDIR /S /Q zip_static\x64
-  2>NUL RMDIR /S /Q zip_static\chromeos
-  2>NUL DEL zip_static\META-INF\com\google\android\update-binary
-  2>NUL DEL zip_static\common\*.sh
-  2>NUL DEL zip_static\common\*.rc
-  2>NUL RMDIR /S /Q uninstaller\common
-  2>NUL RMDIR /S /Q uninstaller\arm
-  2>NUL RMDIR /S /Q uninstaller\arm64
-  2>NUL RMDIR /S /Q uninstaller\x86
-  2>NUL RMDIR /S /Q uninstaller\x64
-  2>NUL RMDIR /S /Q uninstaller\chromeos
-  EXIT /B 0
-
-:zip
-  SET OK=y
-  IF [%~1] == [] (
-    CALL :error "Missing version number"
-    CALL :usage
-    EXIT /B %ERRORLEVEL%
-  )
-  IF NOT EXIST "zip_static\arm\magiskboot" CALL :error "Missing binaries! Please run '%me% build' before zipping!"
-  IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
-  ECHO ************************
-  ECHO * Adding version info
-  ECHO ************************
-  powershell.exe -nologo -noprofile -command "(gc -Raw scripts\flash_script.sh) -replace 'MAGISK_VERSION_STUB', 'Magisk v%~1 Boot Image Patcher' | sc zip_static\META-INF\com\google\android\update-binary"
-  powershell.exe -nologo -noprofile -command "(gc -Raw scripts\magic_mask.sh) -replace 'MAGISK_VERSION_STUB', 'setprop magisk.version \"%~1\"' | sc zip_static\common\magic_mask.sh"
-  ECHO ************************
-  ECHO * Copying Files
-  ECHO ************************
-  COPY /Y scripts\custom_ramdisk_patch.sh zip_static\common\custom_ramdisk_patch.sh
-  COPY /Y scripts\init.magisk.rc zip_static\common\init.magisk.rc
-  COPY /Y binaries\busybox-arm zip_static\arm\busybox
-  COPY /Y binaries\busybox-arm64 zip_static\arm64\busybox
-  COPY /Y binaries\busybox-x86 zip_static\x86\busybox
-  COPY /Y binaries\busybox-x64 zip_static\x64\busybox
-  CALL :mkcp binaries\chromeos zip_static\chromeos
-  ECHO ************************
-  ECHO * Zipping Magisk v%~1
-  ECHO ************************
-  CD zip_static
-  2>NUL DEL "..\Magisk-v%~1.zip"
-  ..\ziptools\win_bin\zip "..\Magisk-v%~1.zip" -r .
-  CD ..\
-  CALL :sign_zip "Magisk-v%~1.zip"
-  EXIT /B %ERRORLEVEL%
-
-:uninstaller
-  SET OK=y
-  IF NOT EXIST "uninstaller\arm\magiskboot" CALL :error "Missing binaries! Please run '%me% build' before zipping!"
-  IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
-  ECHO ************************
-  ECHO * Copying Files
-  ECHO ************************
-  CALL :mkcp scripts\magisk_uninstaller.sh uninstaller\common
-  COPY /Y binaries\busybox-arm uninstaller\arm\busybox
-  COPY /Y binaries\busybox-arm64 uninstaller\arm64\busybox
-  COPY /Y binaries\busybox-x86 uninstaller\x86\busybox
-  COPY /Y binaries\busybox-x64 uninstaller\x64\busybox
-  CALL :mkcp binaries\chromeos uninstaller\chromeos
-  ECHO ************************
-  ECHO * Zipping uninstaller
-  ECHO ************************
-  FOR /F "tokens=* USEBACKQ" %%F IN (`ziptools\win_bin\date "+%%Y%%m%%d"`) DO (set timestamp=%%F)
-  CD uninstaller
-  2>NUL DEL "../Magisk-uninstaller-%timestamp%.zip"
-  ..\ziptools\win_bin\zip "../Magisk-uninstaller-%timestamp%.zip" -r .
-  CD ..\
-  CALL :sign_zip "Magisk-uninstaller-%timestamp%.zip"
-  EXIT /B %ERRORLEVEL%
-
-:sign_zip
-  IF NOT EXIST "ziptools\win_bin\zipadjust.exe" (
-    ECHO ************************
-    ECHO * Compiling ZipAdjust
-    ECHO ************************
-    gcc -o ziptools\win_bin\zipadjust ziptools\src\*.c -lz || CALL :error "ZipAdjust Build failed...."
-    IF %ERRORLEVEL% NEQ 0 EXIT /B %ERRORLEVEL%
-  )
-  SET basename="%~1"
-  SET basename="%basename:.zip=%"
-  ECHO ************************
-  ECHO * First sign %~1
-  ECHO ************************
-  java -jar "ziptools\signapk.jar" "ziptools\test.certificate.x509.pem" "ziptools\test.key.pk8" "%~1" "%basename:"=%-firstsign.zip"
-  ECHO ************************
-  ECHO * Adjusting %~1
-  ECHO ************************
-  ziptools\win_bin\zipadjust "%basename:"=%-firstsign.zip" "%basename:"=%-adjusted.zip"
-  ECHO ************************
-  ECHO * Final sign %~1
-  ECHO ************************
-  java -jar "ziptools\minsignapk.jar" "ziptools\test.certificate.x509.pem" "ziptools\test.key.pk8" "%basename:"=%-adjusted.zip" "%basename:"=%-signed.zip"
-
-  MOVE /Y "%basename:"=%-signed.zip" "%~1"
-  DEL "%basename:"=%-adjusted.zip" "%basename:"=%-firstsign.zip"
-  EXIT /B %ERRORLEVEL%
-
-:mkcp
-  2>NUL MKDIR "%~2"
-  2>NUL COPY /Y "%~1" "%~2"
-  EXIT /B 0
-
-:error
-  ECHO.
-  ECHO ! %~1
-  ECHO.
-  EXIT /B 1

build.gradle

@@ -0,0 +1,34 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
+
+buildscript {
+    
+    repositories {
+        google()
+        jcenter()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:3.1.0'
+        
+
+        // NOTE: Do not place your application dependencies here; they belong
+        // in the individual module build.gradle files
+    }
+}
+
+allprojects {
+    repositories {
+        google()
+        jcenter()
+        maven { url "https://jitpack.io" }
+    }
+}
+
+ext {
+    compileSdkVersion = 27
+    buildToolsVersion = "27.0.3"
+    supportLibVersion = "27.1.0"
+}
+
+task clean(type: Delete) {
+    delete rootProject.buildDir
+}

build.sh

@@ -1,172 +0,0 @@
-#!/bin/bash
-
-usage() {
-  echo "$0 all <version name>"
-  echo -e "\tBuild binaries, zip, and sign Magisk"
-  echo -e "\tThis is equlivant to first <build>, then <zip>"
-  echo "$0 clean"
-  echo -e "\tCleanup compiled / generated files"
-  echo "$0 build"
-  echo -e "\tBuild the binaries with ndk"
-  echo "$0 zip <version name>"
-  echo -e "\tZip and sign Magisk"
-  echo "$0 uninstaller"
-  echo -e "\tZip and sign the uninstaller"
-  exit 1
-}
-
-cleanup() {
-  echo "************************"
-  echo "* Cleaning up"
-  echo "************************"
-  ndk-build clean 2>/dev/null
-  rm -rfv zip_static/arm
-  rm -rfv zip_static/arm64
-  rm -rfv zip_static/x86
-  rm -rfv zip_static/x64
-  rm -rfv zip_static/chromeos
-  rm -rfv zip_static/META-INF/com/google/android/update-binary
-  rm -rfv zip_static/common/*.sh
-  rm -rfv zip_static/common/*.rc
-  rm -rfv uninstaller/common
-  rm -rfv uninstaller/arm
-  rm -rfv uninstaller/arm64
-  rm -rfv uninstaller/x86
-  rm -rfv uninstaller/x64
-  rm -rfv uninstaller/chromeos
-}
-
-mkcp() {
-  [ ! -d "$2" ] && mkdir -p "$2"
-  cp -afv $1 $2
-}
-
-error() {
-  echo -e "\n! $1\n"
-  exit 1
-}
-
-build_bin() {
-  echo "************************"
-  echo "* Building binaries"
-  echo "************************"
-  [ -z `which ndk-build` ] && error "Please add ndk-build to PATH!"
-  ndk-build -j4 || error "Magisk binary tools build failed...."
-  echo "************************"
-  echo "* Copying binaries"
-  echo "************************"
-  mkcp "libs/armeabi-v7a/*" zip_static/arm
-  mkcp libs/armeabi-v7a/magiskboot uninstaller/arm
-  mkcp "libs/arm64-v8a/*" zip_static/arm64
-  mkcp libs/arm64-v8a/magiskboot uninstaller/arm64
-  mkcp "libs/x86/*" zip_static/x86
-  mkcp libs/x86/magiskboot uninstaller/x86
-  mkcp "libs/x86_64/*" zip_static/x64
-  mkcp libs/x86_64/magiskboot uninstaller/x64
-}
-
-zip_package() {
-  [ ! -f "zip_static/arm/magiskboot" ] && error "Missing binaries!! Please run '$0 build' before zipping"
-  echo "************************"
-  echo "* Adding version info"
-  echo "************************"
-  sed "s/MAGISK_VERSION_STUB/Magisk v$1 Boot Image Patcher/g" scripts/flash_script.sh > zip_static/META-INF/com/google/android/update-binary
-  sed "s/MAGISK_VERSION_STUB/setprop magisk.version \"$1\"/g" scripts/magic_mask.sh > zip_static/common/magic_mask.sh
-  echo "************************"
-  echo "* Copying files"
-  echo "************************"
-  cp -afv scripts/custom_ramdisk_patch.sh zip_static/common/custom_ramdisk_patch.sh
-  cp -afv scripts/init.magisk.rc zip_static/common/init.magisk.rc
-  cp -afv binaries/busybox-arm zip_static/arm/busybox
-  cp -afv binaries/busybox-arm64 zip_static/arm64/busybox
-  cp -afv binaries/busybox-x86 zip_static/x86/busybox
-  cp -afv binaries/busybox-x64 zip_static/x64/busybox
-  cp -afv binaries/chromeos/. zip_static/chromeos
-  echo "************************"
-  echo "* Zipping Magisk v$1"
-  echo "************************"
-  cd zip_static
-  find . -type f -exec chmod 644 {} \;
-  find . -type d -exec chmod 755 {} \;
-  rm -rf "../Magisk-v$1.zip"
-  zip "../Magisk-v$1.zip" -r .
-  cd ../
-  sign_zip "Magisk-v$1.zip"
-}
-
-zip_uninstaller() {
-  [ ! -f "uninstaller/arm/magiskboot" ] && error "Missing binaries!! Please run '$0 build' before zipping"
-  echo "************************"
-  echo "* Copying files"
-  echo "************************"
-  mkcp scripts/magisk_uninstaller.sh uninstaller/common
-  cp -afv binaries/busybox-arm uninstaller/arm/busybox
-  cp -afv binaries/busybox-arm64 uninstaller/arm64/busybox
-  cp -afv binaries/busybox-x86 uninstaller/x86/busybox
-  cp -afv binaries/busybox-x64 uninstaller/x64/busybox
-  cp -afv binaries/chromeos/. zip_static/chromeos
-  echo "************************"
-  echo "* Zipping uninstaller"
-  echo "************************"
-  mkcp scripts/magisk_uninstaller.sh uninstaller/common
-  cd uninstaller
-  find . -type f -exec chmod 644 {} \;
-  find . -type d -exec chmod 755 {} \;
-  TIMESTAMP=`date "+%Y%m%d"`
-  rm -rf "../Magisk-uninstaller-$TIMESTAMP.zip"
-  zip "../Magisk-uninstaller-$TIMESTAMP.zip" -r .
-  cd ../
-  sign_zip "Magisk-uninstaller-$TIMESTAMP.zip"
-}
-
-sign_zip() {
-  if [ ! -f "ziptools/zipadjust" ]; then
-    echo "************************"
-    echo "* Compiling ZipAdjust"
-    echo "************************"
-    gcc -o ziptools/zipadjust ziptools/src/*.c -lz || error "ZipAdjust Build failed...."
-    chmod 755 ziptools/zipadjust
-  fi
-  echo "************************"
-  echo "* First sign $1"
-  echo "************************"
-  java -jar "ziptools/signapk.jar" "ziptools/test.certificate.x509.pem" "ziptools/test.key.pk8" "$1" "${1%.*}-firstsign.zip"
-  echo "************************"
-  echo "* Adjusting $1"
-  echo "************************"
-  ziptools/zipadjust "${1%.*}-firstsign.zip" "${1%.*}-adjusted.zip"
-  echo "************************"
-  echo "* Final sign $1"
-  echo "************************"
-  java -jar "ziptools/minsignapk.jar" "ziptools/test.certificate.x509.pem" "ziptools/test.key.pk8" "${1%.*}-adjusted.zip" "${1%.*}-signed.zip"
-
-  mv "${1%.*}-signed.zip" "$1"
-  rm "${1%.*}-adjusted.zip" "${1%.*}-firstsign.zip"
-}
-
-DIR="$(cd "$(dirname "$0")"; pwd)"
-cd "$DIR"
-
-case $1 in
-  "all" )
-    [ -z "$2" ] && echo -e "! Missing version number\n" && usage
-    build_bin
-    zip_package $2
-    ;;
-  "clean" )
-    cleanup
-    ;;
-  "build" )
-    build_bin
-    ;;
-  "zip" )
-    [ -z "$2" ] && echo -e "! Missing version number\n" && usage
-    zip_package $2
-    ;;
-  "uninstaller" )
-    zip_uninstaller
-    ;;
-  * )
-    usage
-    ;;
-esac

docs/README.MD

@@ -0,0 +1,36 @@
+# Magisk Documentations
+(Updated on 2018.1.8) ([Changelog](changelog.md))
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Tips and Tricks](tips.md)
+    - [OTA Installation Tips](tips.md#ota-installation-tips)
+
+The following are for developers
+
+- [Procedure Diagram](https://cdn.rawgit.com/topjohnwu/Magisk/7d1082b1cb91db90ed0a29d8b092723fc3d69c58/docs/procedures.html)
+- [Magisk Details](details.md)
+    - [Boot Stages](details.md#boot-stages)
+    - [Magic Mount Details](details.md#magic-mount-details)
+    - [Simple Mount Details](details.md#simple-mount-details)
+- [Available Tools](tools.md)
+    - [magiskboot](tools.md#magiskboot)
+    - [magiskinit](tools.md#magiskinit)
+    - [magiskpolicy](tools.md#magiskpolicy)
+    - [magisk](tools.md#magisk)
+    - [su](tools.md#su)
+    - [resetprop](tools.md#resetprop)
+    - [magiskhide](tools.md#magiskhide)
+- [Modules](modules.md)
+    - [Modules and Templates](modules.md#magisk-module-format)
+    - [Submit Modules to Repo](https://github.com/topjohnwu/Magisk_Repo_Submissions)
+- [Tips and Tricks](tips.md)
+    - [Remove Files](tips.md#remove-files)
+    - [Remove Folders](tips.md#remove-folders)
+
+    
+## Introduction
+Magisk is a suite of open source tools for devices running Android version higher than 5.0 Lollipop (API 21). It establishes an environment which covers most stuffs you need for Android customization, such as root, boot scripts, SELinux patches, AVB2.0 / dm-verity / forceencrypt patches etc..
+
+Furthermore, Magisk provides a **Systemless Interface** to alter the system (or vendor) arbitrarily while the actual partitions stay completely intact, all of which accomplished by only patching the boot image. With its systemless nature along with several other hacks, Magisk can hide modifications from nearly any existing system integrity verifications, one of the main target is to hide from [Google's SafetyNet API](https://developer.android.com/training/safetynet/index.html).

docs/changelog.md

@@ -0,0 +1,8 @@
+# Changelog
+- 2017.8.16
+    - Initial version for Magisk v13.5
+- 2017.9.28
+    - Update applets info to Magisk v14.1
+    - Add OTA tips
+- 2017.1.8
+    - Update to Magisk v15.2

docs/modules.md

@@ -0,0 +1,49 @@
+# Magisk Modules
+## Magisk Module Format
+A Magisk module is a folder placed in the root folder in `magisk.img`, which has a structure as described below:
+
+```
+$MOUNTPOINT
+├── .
+├── .
+├── $MODID                  <--- The ID of the module, should match with module.prop
+│   ├── auto_mount          <--- If this file exists, auto mount is enabled
+│   ├── disable             <--- If this file exists, the module is disabled
+│   ├── module.prop         <--- This files stores the identity and properties of the module
+│   ├── post-fs-data.sh     <--- This script will be executed in post-fs-data
+│   ├── remove              <--- If this file exists, the module will be removed next reboot
+│   ├── service.sh          <--- This script will be executed in late_start service
+│   ├── system.prop         <--- This file will be loaded as system props
+│   ├── system              <--- If auto mount is enabled, Magisk will "Magic Mount" this folder
+│   │   ├── .
+│   │   ├── .
+│   │   └── .
+│   ├── vendor              <--- Auto generated. A symlink to $MODID/system/vendor
+│   ├── .                   <--- Any other files/folders are allowed
+│   └── .		
+├── another_module
+│   ├── .
+│   └── .
+├── .
+├── .
+```
+You are not required to use my Magisk Module Template to create a module. As long as you place files with the structure above, it will be recognized as a module.
+
+## Magisk Module Template
+The **Magisk Module Template** is hosted **[here](https://github.com/topjohnwu/magisk-module-template)**.
+
+It is a template to create a flashable zip to install Magisk Modules. It is designed to be simple to use so that anyone can create their own modules easily. The template itself contains minimal scripting for installation; most of the functions are located externally in [util_functions.sh](https://github.com/topjohnwu/Magisk/blob/master/scripts/util_functions.sh), which will be installed along with Magisk, and can be upgraded through a Magisk upgrade without the need of a template update.
+
+Here are some files you would want to know:
+
+- `config.sh`: A simple script used as a configuration file. It is the place to configure which features your module needs/disables. A detailed instructions on how to use the template is also written in this file.
+- `module.prop`: This file contains your module's indentity and properties, including name and versions etc.. This file will be used to identify your module on an actual device and in the [Magisk Modules Repo](https://github.com/Magisk-Modules-Repo)
+- `common/*`: Boot stage scripts and `system.prop`
+- `META-INF/com/google/android/update-binary`: The actual installation script. Modify this file for advanced custom behavior
+
+And here are some notes to be aware of:
+
+- The template depends on external Magisk scripts, please specify the correct `minMagisk` value in `module.prop` with the template version your module is based on, or the minimum Magisk version your module is tested on.
+- **Windows users please check here!!** The line endings of all text files should be in the **Unix format**. Please use advanced text editors like Sublime, Atom, Notepad++ etc. to edit **ALL** text files, **NEVER** use Windows Notepad.
+- In `module.prop`, `version` can be an arbitrary string, so any fancy version name (e.g. `ultra-beta-v1.1.1.1`) is allowed. However, `versionCode` **MUST** be an integer. The value is used for version comparison.
+- Make sure your module ID **does not contain any spaces**.

gradle.properties

@@ -0,0 +1,22 @@
+# Project-wide Gradle settings.
+
+# IDE (e.g. Android Studio) users:
+# Gradle settings configured through the IDE *will override*
+# any settings specified in this file.
+
+# For more details on how to configure your build environment visit
+# http://www.gradle.org/docs/current/userguide/build_environment.html
+
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+# Default value: -Xmx10248m -XX:MaxPermSize=256m
+org.gradle.jvmargs=-Xmx2560m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8
+
+# When configured, Gradle will run in incubating parallel mode.
+# This option should only be used with decoupled projects. More details, visit
+# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
+org.gradle.parallel=true
+
+# When set to true the Gradle daemon is used to run the build. For local developer builds this is our favorite property.
+# The developer environment is optimized for speed and feedback so we nearly always run Gradle jobs with the daemon.
+org.gradle.daemon=true