2020-03-23 04:24:20 -07:00
2018-10-05 17:52:40 -04:00
2021-03-07 04:12:32 -08:00
[](https://raw.githubusercontent.com/topjohnwu/magisk-files/count/count.json)
2020-03-25 04:00:21 -07:00
2021-08-28 10:45:32 -07:00
#### This is not an officially supported Google product
2018-10-05 17:52:40 -04:00
## Introduction
2019-02-11 03:18:15 -05:00
2021-04-09 21:29:42 -07:00
Magisk is a suite of open source software for customizing Android, supporting devices higher than Android 5.0.<br>
2021-08-28 10:45:32 -07:00
Some highlight features:
2018-10-05 17:52:40 -04:00
2021-04-09 21:29:42 -07:00
- **MagiskSU**: Provide root access for applications
2020-03-23 04:24:20 -07:00
- **Magisk Modules**: Modify read-only partitions by installing modules
2021-04-09 21:29:42 -07:00
- **MagiskBoot**: The most complete tool for unpacking and repacking Android boot images
2022-01-26 02:33:22 -08:00
- **Zygisk**: Run code in every Android applications' processes
2019-02-11 03:18:15 -05:00
2020-07-02 04:16:02 -07:00
## Downloads
2020-03-13 02:12:35 -07:00
2021-04-09 21:29:42 -07:00
[Github](https://github.com/topjohnwu/Magisk/) is the only source where you can get official Magisk information and downloads.
2021-01-30 13:08:07 +07:00
2022-07-20 20:17:02 -07:00
[](https://github.com/topjohnwu/Magisk/releases/tag/v25.2)
[](https://github.com/topjohnwu/Magisk/releases/tag/v25.2)
2022-05-15 01:14:07 -07:00
[](https://raw.githubusercontent.com/topjohnwu/magisk-files/canary/app-release.apk)
[](https://raw.githubusercontent.com/topjohnwu/magisk-files/canary/app-debug.apk)
2016-11-09 05:16:03 +08:00
2020-03-23 04:24:20 -07:00
## Useful Links
2019-02-11 03:18:15 -05:00
2020-03-23 04:24:20 -07:00
- [Installation Instruction](https://topjohnwu.github.io/Magisk/install.html)
2020-10-03 04:28:43 -07:00
- [Magisk Documentation](https://topjohnwu.github.io/Magisk/)
2020-03-23 04:24:20 -07:00
- [Magisk Troubleshoot Wiki](https://www.didgeridoohan.com/magisk/HomePage) (by [@Didgeridoohan](https://github.com/Didgeridoohan))
2017-06-04 02:49:24 +08:00
2020-03-23 04:24:20 -07:00
## Bug Reports
2022-05-15 01:14:07 -07:00
**Only bug reports from Debug builds will be accepted.**
2020-03-23 04:24:20 -07:00
For installation issues, upload both boot image and install logs.<br>
For Magisk issues, upload boot logcat or dmesg.<br>
2021-02-23 04:22:32 -08:00
For Magisk app crashes, record and upload the logcat when the crash occurs.
2019-03-08 10:23:42 -05:00
2020-04-03 03:33:39 -07:00
## Building and Development
2020-03-23 04:24:20 -07:00
2020-04-03 03:33:39 -07:00
- Magisk builds on any OS Android Studio supports. Install Android Studio and do the initial setups.
2020-03-23 04:24:20 -07:00
- Clone sources: `git clone --recurse-submodules https://github.com/topjohnwu/Magisk.git`
2020-06-20 04:58:54 -07:00
- Install Python 3.6+ \
2022-01-26 02:33:22 -08:00
(Windows only: select **'Add Python to PATH'** in installer, and run `pip install colorama` after install)
2020-07-02 04:16:02 -07:00
- Configure to use the JDK bundled in Android Studio:
2022-01-26 02:33:22 -08: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`
2020-10-17 06:42:34 -07:00
- Set environment variable `ANDROID_SDK_ROOT` to the Android SDK folder (can be found in Android Studio settings)
2020-04-03 03:33:39 -07:00
- Run `./build.py ndk` to let the script download and install NDK for you
2020-06-20 04:58:54 -07:00
- To start building, run `build.py` to see your options. \
2022-01-26 02:33:22 -08:00
For each action, use `-h` to access help (e.g. `./build.py all -h`)
2022-06-30 14:50:21 -07:00
- To start development, open the project with Android Studio. The IDE can be used for both app (Kotlin/Java) and native sources.
2020-12-27 22:36:03 -08:00
- Optionally, set custom configs with `config.prop`. A sample `config.prop.sample` is provided.
2022-05-24 06:13:51 -07: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.
2020-03-23 04:24:20 -07:00
## Translation Contributions
2019-03-08 10:23:42 -05:00
2021-02-23 04:22:32 -08:00
Default string resources for the Magisk app and its stub APK are located here:
2019-03-08 10:23:42 -05:00
- `app/src/main/res/values/strings.xml`
2021-12-14 05:31:12 -08:00
- `stub/src/main/res/values/strings.xml`
2019-03-08 10:23:42 -05:00
2019-10-15 03:33:22 -04:00
Translate each and place them in the respective locations (`[module]/src/main/res/values-[lang]/strings.xml`).
2018-09-09 12:25:22 -04:00
2017-06-04 02:49:24 +08:00
## License
2017-04-22 17:08:47 +08:00
2019-02-11 03:18:15 -05: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 17:08:47 +08:00
2019-02-11 03:18:15 -05: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 17:08:47 +08:00
2019-02-11 03:18:15 -05: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/>.
