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.
- Installation Instruction
- Frequently Asked Questions
- Magisk Documentation
- Magisk Troubleshoot Wiki (by @Didgeridoohan)
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 https://github.com/topjohnwu/Magisk.git
- Install Python 3.6+
(Windows only: select 'Add Python to PATH' in installer, and run
pip install coloramaafter install)
- Configure to use the JDK bundled in Android Studio:
export JAVA_HOME="/Applications/Android Studio.app/Contents/jre/jdk/Contents/Home"
- Windows: Add
C:\Path\To\Android Studio\jre\binto environment variable
- Set environment variable
ANDROID_SDK_ROOTto the Android SDK folder (can be found in Android Studio settings)
./build.py ndkto let the script download and install NDK for you
- To start building, run
build.pyto see your options.
For each action, use
-hto access help (e.g.
./build.py 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
- To sign APKs and zips with your own private keys, set signing configs in
config.prop. For more info, check Google's Documentation.
Default string resources for the Magisk app and its stub APK are located here:
Translate each and place them in the respective locations (
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/>.