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-v27.0-blue)](https://github.com/topjohnwu/Magisk/releases/tag/v27.0)
[![](https://img.shields.io/badge/Magisk%20Beta-v27.0-blue)](https://github.com/topjohnwu/Magisk/releases/tag/v27.0)
[![](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)
- [Building and Development](https://topjohnwu.github.io/Magisk/build.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.

## 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 12:24:20 +01:00			`![](docs/images/logo.png)`
Update README 2018-10-05 23:52:40 +02:00
Update README 2021-03-07 13:12:32 +01: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 12:00:21 +01:00
Update README 2021-08-28 19:45:32 +02:00			`#### This is not an officially supported Google product`

Update README 2018-10-05 23:52:40 +02:00			`## Introduction`
Misc Formatting * PEP8 and linting * empty exceptions 2019-02-11 09:18:15 +01:00
Clean up more codes 2023-03-17 13:08:31 +01: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 19:45:32 +02:00			`Some highlight features:`
Update README 2018-10-05 23:52:40 +02:00
Remove more pre SDK 21 stuffs 2021-04-10 06:29:42 +02:00			`- MagiskSU: Provide root access for applications`
Update documentation 2020-03-23 12:24:20 +01:00			`- Magisk Modules: Modify read-only partitions by installing modules`
Remove more pre SDK 21 stuffs 2021-04-10 06:29:42 +02:00			`- MagiskBoot: The most complete tool for unpacking and repacking Android boot images`
Update README 2022-01-26 11:33:22 +01:00			`- Zygisk: Run code in every Android applications' processes`
Misc Formatting * PEP8 and linting * empty exceptions 2019-02-11 09:18:15 +01:00
Update README Recommend Android Studio embedded JDK again 2020-07-02 13:16:02 +02:00			`## Downloads`
Update README 2020-03-13 10:12:35 +01:00
Remove more pre SDK 21 stuffs 2021-04-10 06:29:42 +02: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 07:08:07 +01:00
Update README 2024-02-07 23:39:53 +01:00			`[![](https://img.shields.io/badge/Magisk-v27.0-blue)](https://github.com/topjohnwu/Magisk/releases/tag/v27.0)`
Update README 2024-02-03 08:35:14 +01:00			`[![](https://img.shields.io/badge/Magisk%20Beta-v27.0-blue)](https://github.com/topjohnwu/Magisk/releases/tag/v27.0)`
Release new canary build 2022-05-15 10:14:07 +02: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 22:16:03 +01:00
Update documentation 2020-03-23 12:24:20 +01:00			`## Useful Links`
Misc Formatting * PEP8 and linting * empty exceptions 2019-02-11 09:18:15 +01:00
Update documentation 2020-03-23 12:24:20 +01:00			`- [Installation Instruction](https://topjohnwu.github.io/Magisk/install.html)`
Update development docs 2023-05-13 11:37:52 +02:00			`- [Building and Development](https://topjohnwu.github.io/Magisk/build.html)`
Update README 2020-10-03 13:28:43 +02:00			`- [Magisk Documentation](https://topjohnwu.github.io/Magisk/)`
Update README.MD 2017-06-03 20:49:24 +02:00
Update documentation 2020-03-23 12:24:20 +01:00			`## Bug Reports`

Release new canary build 2022-05-15 10:14:07 +02:00			`Only bug reports from Debug builds will be accepted.`
Update documentation 2020-03-23 12:24:20 +01: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 13:22:32 +01:00			`For Magisk app crashes, record and upload the logcat when the crash occurs.`
Update README.md 2019-03-08 16:23:42 +01:00
Update documentation 2020-03-23 12:24:20 +01:00			`## Translation Contributions`
Update README.md 2019-03-08 16:23:42 +01:00
Update README 2021-02-23 13:22:32 +01:00			`Default string resources for the Magisk app and its stub APK are located here:`
Update README.md 2019-03-08 16:23:42 +01:00
			- `app/src/main/res/values/strings.xml`
Update stub strings.xml path 2021-12-14 14:31:12 +01:00			- `stub/src/main/res/values/strings.xml`
Update README.md 2019-03-08 16:23:42 +01:00
Reorganize string resources 2019-10-15 09:33:22 +02:00			Translate each and place them in the respective locations (`[module]/src/main/res/values-[lang]/strings.xml`).
Update README.MD 2018-09-09 18:25:22 +02:00
Update README.MD 2017-06-03 20:49:24 +02:00			`## License`
Use GPL v3 license and update copyright messages 2017-04-22 11:08:47 +02:00
Misc Formatting * PEP8 and linting * empty exceptions 2019-02-11 09:18:15 +01: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 11:08:47 +02:00
Misc Formatting * PEP8 and linting * empty exceptions 2019-02-11 09:18:15 +01: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 11:08:47 +02:00
Misc Formatting * PEP8 and linting * empty exceptions 2019-02-11 09:18:15 +01: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/>.`