github/Magisk
1
Fork 0
mirror of https://github.com/topjohnwu/Magisk synced 2024-11-13 20:54:12 +01:00
Code Releases Activity
2,146 Commits 1 Branch 138 Tags 104 MiB
C++ 36.9%
Kotlin 30.1%
Rust 16.5%
Java 9%
Shell 4.8%
Other 2.6%
04bcd145d3
Go to file
topjohnwu 04bcd145d3 Add a.a alias to BootSigner
2018-09-20 15:37:59 -04:00
app Add a.a alias to BootSigner 2018-09-20 15:37:59 -04:00
chromeos Massive build script refactor 2017-06-03 20:31:02 +08:00
docs Delete repo_description.png 2018-09-09 10:41:02 -04:00
gradle/wrapper Update Gradle wrapper to 4.6 2018-04-22 03:09:02 +08:00
native New method of communication 2018-09-16 04:16:18 -04:00
scripts Add a.a alias to BootSigner 2018-09-20 15:37:59 -04:00
snet Migrate to AndroidX support library 2018-09-10 02:27:45 -04:00
utils Optimize boot signing to use as little memory as possible 2018-09-18 23:48:21 -04: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 Simplify SignAPK code 2018-09-11 10:48:36 -04:00
build.py Better support for external config file 2018-09-06 14:25:35 -04:00
config.prop.sample Read props directly in Gradle 2018-08-20 12:02:38 +08:00
gradle.properties Migrate to AndroidX support library 2018-09-10 02:27:45 -04: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 Update README.MD 2018-09-09 12:25:22 -04:00
settings.gradle Rename module core to native 2018-01-27 09:11:28 +08:00

README.MD

Magisk

XDA Announcement Thread

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. Clone sources with submodules: git clone --recurse-submodules https://github.com/topjohnwu/Magisk.git
  2. Building is supported on macOS, Linux, and Windows. Official releases are built and tested with FrankeNDK; point ANDROID_NDK_HOME to FrankeNDK if you want to use it for compiling.
  3. Set configurations in config.prop. A sample file config.prop.sample is provided as an example.
  4. 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
  5. 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.

Bug Reports

Make sure to install the latest Canary Build before reporting any bugs! Please DO NOT report bugs that is already fixed upstream.

Follow the instructions in the Canary Channel XDA Thread, and report a bug either by opening an issue on GitHub or directly in the thread.

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