Magisk/docs/README.MD

37 lines
1.9 KiB
Plaintext
Raw Normal View History

2017-08-14 02:37:48 +08:00
# Magisk Documentations
2018-01-08 22:33:55 +08:00
(Updated on 2018.1.8) ([Changelog](changelog.md))
2017-08-15 02:27:07 +08:00
2017-09-28 05:39:10 +08:00
## Table of Contents
2017-08-15 02:27:07 +08:00
- [Introduction](#introduction)
2018-01-08 22:33:55 +08:00
- [Tips and Tricks](tips.md)
- [OTA Installation Tips](tips.md#ota-installation-tips)
The following are for developers
2018-01-09 06:50:03 +08:00
- [Procedure Diagram](https://cdn.rawgit.com/topjohnwu/Magisk/7d1082b1cb91db90ed0a29d8b092723fc3d69c58/docs/procedures.html)
2018-01-08 22:33:55 +08:00
- [Magisk Details](details.md)
2017-08-15 10:11:10 +08:00
- [Boot Stages](details.md#boot-stages)
- [Magic Mount Details](details.md#magic-mount-details)
- [Simple Mount Details](details.md#simple-mount-details)
2018-01-08 22:33:55 +08:00
- [Available Tools](tools.md)
- [magiskboot](tools.md#magiskboot)
- [magiskinit](tools.md#magiskinit)
- [magiskpolicy](tools.md#magiskpolicy)
- [magisk](tools.md#magisk)
- [su](tools.md#su)
- [resetprop](tools.md#resetprop)
- [magiskhide](tools.md#magiskhide)
- [Modules](modules.md)
- [Modules and Templates](modules.md#magisk-module-format)
- [Submit Modules to Repo](https://github.com/topjohnwu/Magisk_Repo_Submissions)
2017-08-15 10:11:10 +08:00
- [Tips and Tricks](tips.md)
- [Remove Files](tips.md#remove-files)
- [Remove Folders](tips.md#remove-folders)
2017-08-15 01:28:45 +08:00
## Introduction
2018-01-08 22:33:55 +08: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 stuffs you need for Android customization, such as root, boot scripts, SELinux patches, AVB2.0 / dm-verity / forceencrypt patches etc..
Furthermore, Magisk 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. With its systemless nature along with several other hacks, Magisk can hide modifications from nearly any existing system integrity verifications, one of the main target is to hide from [Google's SafetyNet API](https://developer.android.com/training/safetynet/index.html).