Skip to content

Latest commit

 

History

History
84 lines (60 loc) · 4.58 KB

README.MD

File metadata and controls

84 lines (60 loc) · 4.58 KB
Raw

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

Download


Useful Links

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 either Canary Magisk Manager, switch to a Canary Channel in settings and upgrade.

Only bug reports from Canary DEBUG 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 Magisk

  • Clone sources: git clone --recurse-submodules https://github.com/topjohnwu/Magisk.git
  • Magisk builds on any OS Android Studio supports. Install Android Studio and import the project.
  • Python 3.6+. For Windows only, install Colorama with pip install colorama in admin shell.
  • 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_HOME to the Android SDK folder
  • Download / clone FrankeNDK and set environment variable ANDROID_NDK_HOME to the folder
  • Set configurations in config.prop. A sample file config.prop.sample is provided.
  • Run build.py to see help messages. For each supported actions, use -h to access help (e.g. ./build.py all -h)
  • By default, the script builds everything in debug mode. If you want to build Magisk Manager in release mode (with the -r, --release flag), you need a Java Keystore (only JKS format is supported) 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/>.