Go to file
topjohnwu 880de21596 Update Github Actions
Disable gradle daemon on Windows and always upload artifacts
2020-12-27 04:02:20 -08:00
.github/workflows Update Github Actions 2020-12-27 04:02:20 -08:00
app Embed keys into dex files 2020-12-26 21:33:30 -08:00
buildSrc Default to config.prop in buildSrc 2020-12-25 13:03:25 -08:00
docs Update install.md 2020-12-22 23:32:53 -08:00
gradle/wrapper Build compatible bytecode with newer JDKs 2020-06-21 02:43:32 -07:00
native Get boot config properly 2020-12-19 15:55:33 -08:00
scripts utils_functions: Added a check for the system_root 2020-12-22 23:30:14 -08:00
stub Update strings.xml 2020-12-22 23:32:01 -08:00
tools Embed keys into dex files 2020-12-26 21:33:30 -08:00
.gitattributes Small native code reorganization 2020-03-09 01:50:30 -07:00
.gitignore Make main app fully independent from the stub 2019-10-17 02:55:42 -04:00
.gitmodules Add BusyBox SELinux support 2020-01-20 20:48:05 +08:00
build.gradle.kts Update dependencies 2020-12-26 17:05:12 -08:00
build.py Fix uninstaller zip 2020-12-26 22:45:05 -08:00
config.prop.sample Make versionCode unconfigurable 2020-12-25 05:34:15 -08:00
gradle.properties Update Github Actions 2020-12-27 04:02:20 -08:00
gradlew Upgrade gradle wrapper 2020-06-20 04:41:54 -07:00
gradlew.bat Update Gradle wrapper to 5.6.1 2019-09-01 01:17:22 +08:00
LICENSE Use GPL v3 license and update copyright messages 2017-04-22 17:12:54 +08:00
README.MD Update README 2020-11-13 04:38:17 -08:00
settings.gradle.kts Move signing code into main app sources 2020-12-26 17:03:10 -08:00

ZIP Downloads APK Downloads

Introduction

Magisk is a suite of open source tools for customizing Android, supporting devices higher than Android 4.2. It covers fundamental parts of Android customization: root, boot scripts, SELinux patches, AVB2.0 / dm-verity / forceencrypt removals etc.

Here are some feature highlights:

  • MagiskSU: Provide root access to your device
  • Magisk Modules: Modify read-only partitions by installing modules
  • MagiskHide: Hide Magisk from root detections / system integrity checks

Downloads


Android Version Support

  • Android 4.2+: MagiskSU and Magisk Modules Only
  • Android 4.4+: All core features available
  • Android 6.0+: Guaranteed MagiskHide support
  • Android 7.0+: Full MagiskHide protection
  • Android 9.0+: Magisk Manager stealth mode

Bug Reports

Canary Channels are cutting edge builds for those adventurous. To access canary builds, install the Canary Magisk Manager, switch to the Canary Channel in settings and upgrade.

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 Manager 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 https://github.com/topjohnwu/Magisk.git
  • 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 Studio.app/Contents/jre/jdk/Contents/Home"
    • 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 ./build.py ndk to let the script download and install NDK for you
  • Set configurations in config.prop. A sample config.prop.sample is provided.
  • To start building, run build.py to see your options.
    For each action, use -h to access help (e.g. ./build.py all -h)
  • To start development, open the project in Android Studio. Both app (Kotlin/Java) and native (C++/C) source code can be properly developed using the IDE, but always use build.py for building.
  • build.py builds in debug mode by default. If you want release builds (with -r, --release), you need a Java Keystore to sign APKs and zips. For more information, check Google's Documentation.

Translation Contributions

Default string resources for Magisk Manager 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).

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