Magisk/README.MD

63 lines
2.9 KiB
Plaintext
Raw Normal View History

2020-03-23 11:24:20 +00:00
![](docs/images/logo.png)
2018-10-05 21:52:40 +00:00
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)
2020-03-25 11:00:21 +00:00
2021-08-28 17:45:32 +00:00
#### This is not an officially supported Google product
2018-10-05 21:52:40 +00:00
## Introduction
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>
2021-08-28 17:45:32 +00:00
Some highlight features:
2018-10-05 21:52:40 +00:00
2021-04-10 04:29:42 +00:00
- **MagiskSU**: Provide root access for applications
2020-03-23 11:24:20 +00:00
- **Magisk Modules**: Modify read-only partitions by installing modules
2021-04-10 04:29:42 +00:00
- **MagiskBoot**: The most complete tool for unpacking and repacking Android boot images
2022-01-26 10:33:22 +00:00
- **Zygisk**: Run code in every Android applications' processes
## Downloads
2020-03-13 09:12:35 +00:00
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.
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)
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)
2016-11-08 21:16:03 +00:00
2020-03-23 11:24:20 +00:00
## Useful Links
2020-03-23 11:24:20 +00:00
- [Installation Instruction](https://topjohnwu.github.io/Magisk/install.html)
2023-05-13 09:37:52 +00:00
- [Building and Development](https://topjohnwu.github.io/Magisk/build.html)
2020-10-03 11:28:43 +00:00
- [Magisk Documentation](https://topjohnwu.github.io/Magisk/)
2017-06-03 18:49:24 +00:00
2020-03-23 11:24:20 +00:00
## Bug Reports
2022-05-15 08:14:07 +00:00
**Only bug reports from Debug builds will be accepted.**
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>
2021-02-23 12:22:32 +00:00
For Magisk app crashes, record and upload the logcat when the crash occurs.
2019-03-08 15:23:42 +00:00
2020-03-23 11:24:20 +00:00
## Translation Contributions
2019-03-08 15:23:42 +00:00
2021-02-23 12:22:32 +00:00
Default string resources for the Magisk app and its stub APK are located here:
2019-03-08 15:23:42 +00:00
- `app/src/main/res/values/strings.xml`
2021-12-14 13:31:12 +00:00
- `stub/src/main/res/values/strings.xml`
2019-03-08 15:23:42 +00:00
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`).
2018-09-09 16:25:22 +00:00
2017-06-03 18:49:24 +00:00
## 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/>.