Magisk/docs/README.MD

29 lines
1.8 KiB
Plaintext
Raw Normal View History

2017-08-13 18:37:48 +00:00
# Magisk Documentations
2017-09-27 21:39:10 +00:00
(Updated on 2017.9.28) ([Changelog](changelog.md))
2017-08-14 18:27:07 +00:00
2017-09-27 21:39:10 +00:00
## Table of Contents
2017-08-14 18:27:07 +00:00
- [Introduction](#introduction)
2017-08-16 16:41:50 +00:00
- [Procedure Diagram](https://cdn.rawgit.com/topjohnwu/Magisk/cc1809688299f1f8b5db494a234850852712c0c9/docs/procedures.html)
- [Magisk Details](details.md)
2017-08-15 02:11:10 +00:00
- [Boot Stages](details.md#boot-stages)
- [Magic Mount Details](details.md#magic-mount-details)
- [Simple Mount Details](details.md#simple-mount-details)
- [Available Applets](applets.md)
- [magisk](applets.md#magisk)
- [su](applets.md#su)
- [resetprop](applets.md#resetprop)
- [magiskpolicy](applets.md#magiskpolicy)
- [magiskhide](applets.md#magiskhide)
2017-08-13 19:46:23 +00:00
- [Modules and Repos](module_repo.md)
- [Modules and Templates](module_repo.md#magisk-module-format)
2017-08-14 17:28:45 +00:00
- [Submit Modules to Repo](module_repo.md#submit-your-module-to-magisk-modules-repo)
2017-08-15 02:11:10 +00:00
- [Tips and Tricks](tips.md)
2017-09-27 21:39:10 +00:00
- [OTA Installation Tips](tips.md#ota-installation-tips)
2017-08-15 02:11:10 +00:00
- [Remove Files](tips.md#remove-files)
- [Remove Folders](tips.md#remove-folders)
2017-08-14 17:28:45 +00:00
## Introduction
2017-08-16 16:41:50 +00:00
Magisk is a suite of open source tools for devices running Android version higher than 5.0 Lollipop (API 21). It establishes an environment which covers most Android aftermarket customization needs, such as root, boot scripts, SELinux patches, dm-verity/forceencrypt patches etc.. Furthermore, Magisk also provides a **Systemless Interface** to alter the system (or vendor) arbitrarily while the actual partitions stay completely intact, all of which accomplished by only patching the boot image, and adding some files into `/data`. With its systemless nature along with several other hacks, Magisk can hide modifications from device integrity verifications, one of the main target is to hide from [Google's SafetyNet API](https://developer.android.com/training/safetynet/index.html).