2020-03-23 11:24:20 +00:00
2018-10-05 21:52:40 +00:00
2021-03-07 12:12:32 +00:00
[](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
2019-02-11 08:18:15 +00:00
2021-04-10 04:29:42 +00:00
Magisk is a suite of open source software for customizing Android, supporting devices higher than Android 5.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
2019-02-11 08:18:15 +00:00
2020-07-02 11:16:02 +00:00
## 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.
2021-01-30 06:08:07 +00:00
2021-05-12 05:08:02 +00:00
[](https://github.com/topjohnwu/Magisk/releases/tag/v23.0)
[](https://github.com/topjohnwu/Magisk/releases/tag/v23.0)
2021-03-07 12:12:32 +00:00
[](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
2019-02-11 08:18:15 +00:00
2020-03-23 11:24:20 +00:00
- [Installation Instruction](https://topjohnwu.github.io/Magisk/install.html)
2020-10-03 04:47:47 +00:00
- [Frequently Asked Questions](https://topjohnwu.github.io/Magisk/faq.html)
2020-10-03 11:28:43 +00:00
- [Magisk Documentation](https://topjohnwu.github.io/Magisk/)
2020-03-23 11:24:20 +00:00
- [Magisk Troubleshoot Wiki](https://www.didgeridoohan.com/magisk/HomePage) (by [@Didgeridoohan](https://github.com/Didgeridoohan))
2017-06-03 18:49:24 +00:00
2020-03-23 11:24:20 +00:00
## Bug Reports
2020-06-20 11:58:54 +00:00
**Only bug reports from Canary 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-04-03 10:33:39 +00:00
## Building and Development
2020-03-23 11:24:20 +00:00
2020-04-03 10:33:39 +00:00
- Magisk builds on any OS Android Studio supports. Install Android Studio and do the initial setups.
2020-03-23 11:24:20 +00:00
- Clone sources: `git clone --recurse-submodules https://github.com/topjohnwu/Magisk.git`
2020-06-20 11:58:54 +00:00
- Install Python 3.6+ \
(Windows only: select **'Add Python to PATH'** in installer, and run `pip install colorama` after install)
2020-07-02 11:16:02 +00:00
- Configure to use the JDK bundled in Android Studio:
2021-09-02 09:27:05 +00:00
- macOS: `export JAVA_HOME="/Applications/Android Studio.app/Contents/jre/Contents/Home"`
2020-07-02 11:16:02 +00:00
- Linux: `export PATH="/path/to/androidstudio/jre/bin:$PATH"`
- Windows: Add `C:\Path\To\Android Studio\jre\bin` to environment variable `PATH`
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)
2020-04-03 10:33:39 +00:00
- Run `./build.py ndk` to let the script download and install NDK for you
2020-06-20 11:58:54 +00:00
- To start building, run `build.py` to see your options. \
For each action, use `-h` to access help (e.g. `./build.py all -h`)
2021-01-24 00:50:55 +00:00
- To start development, open the project with Android Studio. The IDE can be used for both app (Kotlin/Java) and native (C++/C) sources.
2020-12-28 06:36:03 +00:00
- Optionally, set custom configs with `config.prop`. A sample `config.prop.sample` is provided.
- To sign APKs and zips with your own private keys, set signing configs in `config.prop`. For more info, check [Google's Documentation](https://developer.android.com/studio/publish/app-signing.html#generate-key).
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-01 05:04:41 +00:00
- `stub/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
2017-04-22 09:08:47 +00:00
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.
2017-04-22 09:08:47 +00:00
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.
2017-04-22 09:08:47 +00:00
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/>.
