Magisk README

The project's README from github.com/topjohnwu/Magisk. As one markdown file: README.md.

Downloads

This is not an officially supported Google product

Introduction

Magisk is a suite of open source software for customizing Android, supporting devices higher than Android 6.0.
Some highlight features:

Downloads

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

Bug Reports

Only bug reports from 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 app crashes, record and upload the logcat when the crash occurs.

Translation Contributions

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

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

Magisk (topjohnwu/Magisk)

modding
Searching Database…

63.3K ·GitHub
Magisk
What is this?Magisk is a suite of open source software for customizing Android, supporting devices higher than Android 6.0. Its four headline pieces are MagiskSU, Magisk Modules, MagiskBoot, and Zygisk.
Does it live on my phone, or is it a program for my computer?It is installed on the Android device itself: the Magisk app manages root access and modules right on the phone.
How does Magisk actually get onto a device?GitHub is the only official source for downloads; from there, follow the installation instruction in the docs.
Do I need my phone rooted already, or does Magisk handle that?Magisk handles it itself: MagiskSU is the component that provides root access for applications, so no pre-rooted device is needed.
Will it work on any Android phone?Only on devices running higher than Android 6.0 — older versions are not supported.
Is it really free to modify and redistribute?Yes — Magisk, including all git submodules, is free software under the GNU GPL version 3 or later.
What is Zygisk?A Magisk component that can run code inside every Android application's process — the deep hook that lets modules affect how individual apps behave.
What can Magisk modules change?They modify read-only partitions by installing modules, so you can alter system-level parts of Android without actually editing those partitions.
What is MagiskBoot for?It is described as the most complete tool for unpacking and repacking Android boot images — handy when you need to work with a boot image directly.
Is Magisk a Google product?No — the README states upfront that this is not an officially supported Google product, despite how deep into Android it goes.
What are similar projects?KernelSU, awesome-android-root, Vector, DiPlay, HyperChanger, LSPosed, LocationSpoofer, UniRoot
Which topics is it in?magisk, boot, root, apk, android-development, modding, gpl, kernel, firmware, android-app, kotlin, customization
Creator
topjohnwu
Size
62.6 MB
Stars
63.3K
Updated
CommitOct 16Releasev30.7Feb 23
Age
10y
Commits · 90 Days