Magisk/README.MD

![](docs/images/logo.png)

[![Downloads](https://img.shields.io/badge/dynamic/json?color=green&label=Downloads&query=totalString&url=https%3A%2F%2Fraw.githubusercontent.com%2Ftopjohnwu%2Fmagisk-files%2Fcount%2Fcount.json&cacheSeconds=1800)](https://raw.githubusercontent.com/topjohnwu/magisk-files/count/count.json)

#### 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.<br>
Some highlight features:

- **MagiskSU**: Provide root access for applications
- **Magisk Modules**: Modify read-only partitions by installing modules
- **MagiskBoot**: The most complete tool for unpacking and repacking Android boot images
- **Zygisk**: Run code in every Android applications' processes

## Downloads

[Github](https://github.com/topjohnwu/Magisk/) is the only source where you can get official Magisk information and downloads.

[![](https://img.shields.io/badge/Magisk-v26.1-blue)](https://github.com/topjohnwu/Magisk/releases/tag/v26.1)
[![](https://img.shields.io/badge/Magisk%20Beta-v26.1-blue)](https://github.com/topjohnwu/Magisk/releases/tag/v26.1)
[![](https://img.shields.io/badge/Magisk-Canary-red)](https://raw.githubusercontent.com/topjohnwu/magisk-files/canary/app-release.apk)
[![](https://img.shields.io/badge/Magisk-Debug-red)](https://raw.githubusercontent.com/topjohnwu/magisk-files/canary/app-debug.apk)

## Useful Links

- [Installation Instruction](https://topjohnwu.github.io/Magisk/install.html)
- [Magisk Documentation](https://topjohnwu.github.io/Magisk/)

## Bug Reports

**Only bug reports from Debug builds will be accepted.**

For installation issues, upload both boot image and install logs.<br>
For Magisk issues, upload boot logcat or dmesg.<br>
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.8+ \
  (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/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
- 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 with Android Studio. The IDE can be used for both app (Kotlin/Java) and native sources.
- Optionally, set custom configs with `config.prop`. A sample `config.prop.sample` is provided.

## Signing and Distribution

- The certificate of the key used to sign the final Magisk APK product is also directly embedded into some executables. In release builds, Magisk's root daemon will enforce this certificate check and reject and forcefully uninstall any non-matching Magisk apps to protect users from malicious and unverified Magisk APKs.
- To do any development on Magisk itself, switch to an **official debug build and reinstall Magisk** to bypass the signature check.
- To distribute your own Magisk builds signed with your own keys, set your signing configs in `config.prop`.
- Check [Google's Documentation](https://developer.android.com/studio/publish/app-signing.html#generate-key) for more details on generating your own key.

## 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`).

## 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/>.
Update documentation 2020-03-23 11:24:20 +00:00			`![](docs/images/logo.png)`
Update README 2018-10-05 21:52:40 +00:00
Update README 2021-03-07 12:12:32 +00:00			`[![Downloads](https://img.shields.io/badge/dynamic/json?color=green&label=Downloads&query=totalString&url=https%3A%2F%2Fraw.githubusercontent.com%2Ftopjohnwu%2Fmagisk-files%2Fcount%2Fcount.json&cacheSeconds=1800)](https://raw.githubusercontent.com/topjohnwu/magisk-files/count/count.json)`
Add live download counts 2020-03-25 11:00:21 +00:00
Update README 2021-08-28 17:45:32 +00:00			`#### This is not an officially supported Google product`

Update README 2018-10-05 21:52:40 +00:00			`## Introduction`
Misc Formatting * PEP8 and linting * empty exceptions 2019-02-11 08:18:15 +00:00
Clean up more codes 2023-03-17 12:08:31 +00:00			`Magisk is a suite of open source software for customizing Android, supporting devices higher than Android 6.0.<br>`
Update README 2021-08-28 17:45:32 +00:00			`Some highlight features:`
Update README 2018-10-05 21:52:40 +00:00
Remove more pre SDK 21 stuffs 2021-04-10 04:29:42 +00:00			`- MagiskSU: Provide root access for applications`
Update documentation 2020-03-23 11:24:20 +00:00			`- Magisk Modules: Modify read-only partitions by installing modules`
Remove more pre SDK 21 stuffs 2021-04-10 04:29:42 +00:00			`- MagiskBoot: The most complete tool for unpacking and repacking Android boot images`
Update README 2022-01-26 10:33:22 +00:00			`- Zygisk: Run code in every Android applications' processes`
Misc Formatting * PEP8 and linting * empty exceptions 2019-02-11 08:18:15 +00:00
Update README Recommend Android Studio embedded JDK again 2020-07-02 11:16:02 +00:00			`## Downloads`
Update README 2020-03-13 09:12:35 +00:00
Remove more pre SDK 21 stuffs 2021-04-10 04:29:42 +00:00			`[Github](https://github.com/topjohnwu/Magisk/) is the only source where you can get official Magisk information and downloads.`
[README] Warn users that the official website is github Google puts a number of cheeky looking websites in the results for Magisk. I only found out they were unofficial is though issue #3435. This deserves to be shown more prominently. 2021-01-30 06:08:07 +00:00
Update README 2023-04-11 19:51:22 +00:00			`[![](https://img.shields.io/badge/Magisk-v26.1-blue)](https://github.com/topjohnwu/Magisk/releases/tag/v26.1)`
			`[![](https://img.shields.io/badge/Magisk%20Beta-v26.1-blue)](https://github.com/topjohnwu/Magisk/releases/tag/v26.1)`
Release new canary build 2022-05-15 08:14:07 +00:00			`[![](https://img.shields.io/badge/Magisk-Canary-red)](https://raw.githubusercontent.com/topjohnwu/magisk-files/canary/app-release.apk)`
			`[![](https://img.shields.io/badge/Magisk-Debug-red)](https://raw.githubusercontent.com/topjohnwu/magisk-files/canary/app-debug.apk)`
Update build.sh 2016-11-08 21:16:03 +00:00
Update documentation 2020-03-23 11:24:20 +00:00			`## Useful Links`
Misc Formatting * PEP8 and linting * empty exceptions 2019-02-11 08:18:15 +00:00
Update documentation 2020-03-23 11:24:20 +00:00			`- [Installation Instruction](https://topjohnwu.github.io/Magisk/install.html)`
Update README 2020-10-03 11:28:43 +00:00			`- [Magisk Documentation](https://topjohnwu.github.io/Magisk/)`
Update README.MD 2017-06-03 18:49:24 +00:00
Update documentation 2020-03-23 11:24:20 +00:00			`## Bug Reports`

Release new canary build 2022-05-15 08:14:07 +00:00			`Only bug reports from Debug builds will be accepted.`
Update documentation 2020-03-23 11:24:20 +00:00
			`For installation issues, upload both boot image and install logs.<br>`
			`For Magisk issues, upload boot logcat or dmesg.<br>`
Update README 2021-02-23 12:22:32 +00:00			`For Magisk app crashes, record and upload the logcat when the crash occurs.`
Update README.md 2019-03-08 15:23:42 +00:00
Let build.py setup NDK 2020-04-03 10:33:39 +00:00			`## Building and Development`
Update documentation 2020-03-23 11:24:20 +00:00
Let build.py setup NDK 2020-04-03 10:33:39 +00:00			`- Magisk builds on any OS Android Studio supports. Install Android Studio and do the initial setups.`
Update documentation 2020-03-23 11:24:20 +00:00			- Clone sources: `git clone --recurse-submodules https://github.com/topjohnwu/Magisk.git`
Update README.md to specify python version 3.8+ Current readme suggests python 3.6+ However, the file `build.py` on executing `build.py ndk` runs the command `shutil.copytree(src_dir, lib_dir, copy_function=cp, dirs_exist_ok=True)` This command errors out on python 3.7, because the `dirs_exist_ok` parameter is new in Python 3.8 (https://docs.python.org/3/library/shutil.html#shutil.copytree) So the README should suggest python 3.8+ 2022-10-20 08:47:13 +00:00			`- Install Python 3.8+ \`
Update README 2022-01-26 10:33:22 +00:00			(Windows only: select 'Add Python to PATH' in installer, and run `pip install colorama` after install)
Update README Recommend Android Studio embedded JDK again 2020-07-02 11:16:02 +00:00			`- Configure to use the JDK bundled in Android Studio:`
Update README 2022-01-26 10:33:22 +00:00			- macOS: `export JAVA_HOME="/Applications/Android Studio.app/Contents/jre/Contents/Home"`
			- Linux: `export PATH="/path/to/androidstudio/jre/bin:$PATH"`
			- Windows: Add `C:\Path\To\Android Studio\jre\bin` to environment variable `PATH`
ANDROID_HOME is deprecated 2020-10-17 13:42:34 +00:00			- Set environment variable `ANDROID_SDK_ROOT` to the Android SDK folder (can be found in Android Studio settings)
Let build.py setup NDK 2020-04-03 10:33:39 +00:00			- Run `./build.py ndk` to let the script download and install NDK for you
Update README 2020-06-20 11:58:54 +00:00			- To start building, run `build.py` to see your options. \
Update README 2022-01-26 10:33:22 +00:00			For each action, use `-h` to access help (e.g. `./build.py all -h`)
Setup preliminary rust infrastructure 2022-06-30 21:50:21 +00:00			`- To start development, open the project with Android Studio. The IDE can be used for both app (Kotlin/Java) and native sources.`
Update README.md 2020-12-28 06:36:03 +00:00			- Optionally, set custom configs with `config.prop`. A sample `config.prop.sample` is provided.
Update README 2022-05-24 13:13:51 +00:00
			`## Signing and Distribution`

			`- The certificate of the key used to sign the final Magisk APK product is also directly embedded into some executables. In release builds, Magisk's root daemon will enforce this certificate check and reject and forcefully uninstall any non-matching Magisk apps to protect users from malicious and unverified Magisk APKs.`
			`- To do any development on Magisk itself, switch to an official debug build and reinstall Magisk to bypass the signature check.`
			- To distribute your own Magisk builds signed with your own keys, set your signing configs in `config.prop`.
			`- Check [Google's Documentation](https://developer.android.com/studio/publish/app-signing.html#generate-key) for more details on generating your own key.`
Update documentation 2020-03-23 11:24:20 +00:00
			`## Translation Contributions`
Update README.md 2019-03-08 15:23:42 +00:00
Update README 2021-02-23 12:22:32 +00:00			`Default string resources for the Magisk app and its stub APK are located here:`
Update README.md 2019-03-08 15:23:42 +00:00
			- `app/src/main/res/values/strings.xml`
Update stub strings.xml path 2021-12-14 13:31:12 +00:00			- `stub/src/main/res/values/strings.xml`
Update README.md 2019-03-08 15:23:42 +00:00
Reorganize string resources 2019-10-15 07:33:22 +00:00			Translate each and place them in the respective locations (`[module]/src/main/res/values-[lang]/strings.xml`).
Update README.MD 2018-09-09 16:25:22 +00:00
Update README.MD 2017-06-03 18:49:24 +00:00			`## License`
Use GPL v3 license and update copyright messages 2017-04-22 09:08:47 +00:00
Misc Formatting * PEP8 and linting * empty exceptions 2019-02-11 08:18:15 +00:00			`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.`
Use GPL v3 license and update copyright messages 2017-04-22 09:08:47 +00:00
Misc Formatting * PEP8 and linting * empty exceptions 2019-02-11 08:18:15 +00:00			`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.`
Use GPL v3 license and update copyright messages 2017-04-22 09:08:47 +00:00
Misc Formatting * PEP8 and linting * empty exceptions 2019-02-11 08:18:15 +00:00			`You should have received a copy of the GNU General Public License`
			`along with this program. If not, see <http://www.gnu.org/licenses/>.`