You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
topjohnwu 4f73534837 Update installation instructions 1 year ago
.github Refresh flag 1 year ago
app Remove unused file 1 year ago
buildSrc Update dependencies 1 year ago
docs Update installation instructions 1 year ago
gradle/wrapper Update dependencies 1 year ago
native Build our own zlib 1 year ago
scripts Fix copy sepolicy rules when install module 1 year ago
stub Remove/move unused files 1 year ago
tools Update NDK to r21e 2 years ago
.gitattributes Small native code reorganization 3 years ago
.gitignore Make main app fully independent from the stub 3 years ago
.gitmodules Build our own zlib 1 year ago
LICENSE Use GPL v3 license and update copyright messages 6 years ago
README.MD Publish v23.0 docs 1 year ago
build.gradle.kts Fix release builds 1 year ago Update snet.jar extension 1 year ago
config.prop.sample Cleanup scripts 2 years ago Release new canary build 1 year ago
gradlew Update AGP 2 years ago
gradlew.bat Update AGP 2 years ago
settings.gradle.kts Move signing code into main app sources 2 years ago




Magisk is a suite of open source software for customizing Android, supporting devices higher than Android 5.0.
Here are some feature highlights:

  • MagiskSU: Provide root access for applications
  • Magisk Modules: Modify read-only partitions by installing modules
  • MagiskHide: Hide Magisk from root detections / system integrity checks
  • MagiskBoot: The most complete tool for unpacking and repacking Android boot images


Github is the only source where you can get official Magisk information and downloads.

Bug Reports

Only bug reports from Canary builds will be accepted.

For installation issues, upload both boot image and install logs.
For Magisk issues, upload boot logcat or dmesg.
For Magisk app crashes, record and upload the logcat when the crash occurs.

Building and Development

  • Magisk builds on any OS Android Studio supports. Install Android Studio and do the initial setups.
  • Clone sources: git clone --recurse-submodules
  • Install Python 3.6+
    (Windows only: select 'Add Python to PATH' in installer, and run pip install colorama after install)
  • Configure to use the JDK bundled in Android Studio:
    • macOS: export JAVA_HOME="/Applications/Android"
    • Linux: export PATH="/path/to/androidstudio/jre/bin:$PATH"
    • Windows: Add C:\Path\To\Android Studio\jre\bin to environment variable PATH
  • Set environment variable ANDROID_SDK_ROOT to the Android SDK folder (can be found in Android Studio settings)
  • Run ./ ndk to let the script download and install NDK for you
  • To start building, run to see your options.
    For each action, use -h to access help (e.g. ./ all -h)
  • To start development, open the project with Android Studio. The IDE can be used for both app (Kotlin/Java) and native (C++/C) sources.
  • Optionally, set custom configs with config.prop. A sample config.prop.sample is provided.
  • To sign APKs and zips with your own private keys, set signing configs in config.prop. For more info, check Google's Documentation.

Translation Contributions

Default string resources for the Magisk app and its stub APK are located here:

  • app/src/main/res/values/strings.xml
  • stub/src/main/res/values/strings.xml

Translate each and place them in the respective locations ([module]/src/main/res/values-[lang]/strings.xml).


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