Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@topjohnwu
topjohnwu committed Aug 13, 2017
1 parent f7200e3 commit 3a084c5
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/README.MD
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Magisk Documentations
11 changes: 11 additions & 0 deletions docs/procedures.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=5,IE=9" ><![endif]-->
<!DOCTYPE html>
<html>
<head>
<title>Magisk Procedures</title>
<meta charset="utf-8"/>
</head>
<body><div class="mxgraph" style="max-width:100%;border:1px solid transparent;" data-mxgraph="{&quot;highlight&quot;:&quot;#0000ff&quot;,&quot;nav&quot;:true,&quot;resize&quot;:true,&quot;toolbar&quot;:&quot;zoom layers lightbox&quot;,&quot;edit&quot;:&quot;_blank&quot;,&quot;xml&quot;:&quot;&lt;mxfile userAgent=\&quot;Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.90 Safari/537.36\&quot; version=\&quot;7.0.9\&quot; editor=\&quot;www.draw.io\&quot; type=\&quot;google\&quot;&gt;&lt;diagram name=\&quot;Page-1\&quot; id=\&quot;74e2e168-ea6b-b213-b513-2b3c1d86103e\&quot;&gt;7V1bk6M2Fv41ruo8tAtx5zHdM5NkK5PMpieVzb6kaFu22cHgYDzdnV+/EkgYXcAyRoC7px9mbNnIIH3n6NzPzLrfPv+QhbvNx3QJ45lpLJ9n1ruZaQLH8dB/eOSlHPEDvxxYZ9GyHDKOAw/RP5BcSUcP0RLuyVg5lKdpnEc7dnCRJglc5MxYmGXpE/u1VRovmYFduIbCwMMijMXRP6JlviGjwA2OH/wIo/WG/LRvkgd+DBdf1ll6SMjvzUxrVfyVH29DOhd50P0mXKZPtSHr/cy6z9I0L19tn+9hjNeWXbYPDZ9W953BJFe6wH8EMLAdJ7ANN3yEt+ghyzm+hvEB0ocobjV/ocsDk+X3eJXRu0Uc7vfRYmbdbfJtjAYAelk9lYHf5Fn6Bd6ncZoVV1tB8OGDZVWf0AVGz363SpOcoAHQ97UrjeIPjcPnKP8P+TH8+k/8W3MHv1uijSR3CuPH9On9ceCuGEAffIVZHqHdRkPls+GrGleQDO3TQ7aATctmgGr3EFXAdAvz7AVd9XSEj0P2fFMDDh3LYBzm0Vf2JkKC4nU1XfULn9II3Z5pVBQXEAASgnPpxHSO8u7JZXVAiDO5zEyOb7Ez5WG2hrkwEwJE+FL72g5/Yd9yyy5w2FsGQX0+9KKckr6rLetxqICzKrQ9AdkP73+OksNzseH5YjMz3XC7Q6hIHve7AhxunGOg7sIEvV7j1zcxfv7v6EfoLuqfCqRS8AK4JFh92kQ5fNiFBY6eEO9k6YbcH0InfG6Howg0coHlmsyqAtsu3z/V+Rjd0zoUzaAZdbVNOW/NgeufxU6SNIEcLxGYRMVdwBn0OxZlVuRD9sPy7W6EyU9kO0pk2QfhAPO8TZSfCeI+Nh4My3C/qWhm6juMIM4yMrMz7+VnsoE52CYHwbc9btxj27H62WJ+oiF3WELF4vlXHGrL6Gt13G3hMjps6+dd7dPRjzskE7IbY/jCcRfYIi7sFgh0PuzovdQWGC3vFzTyMVxH+y+S5X2MkjCLkKozzeW1HPvk8voSstOzvDLNRFjRh2i7Q8uF1hytVd60riLO78PFprpsP1W82557ckMCc6gNsRs3BCtuzEq5fx9S+sHtvlDxvkdfAM7u+fghvz+PdGCX7vPbFaIS4+YxThdfomSNdsgo5qj26ZG/HI2V99G465pu97dDgu/1Ea7SDGNqGeYhXkg8uMX4Qog5/75PYphVV3p7mt/3cHXAQEBPUxyluzhcoB3AT4gNFQhVSbRFx2uanHgqVlNSIjBEKrlMyKAiBVEYVlEcc0NhHK0TLKkg0oJo/I5q/d+TD7bRclmYBWRk28fZxAsNvivQqun5IrG6ng5idS4mVvTwKnj5XPDR35NoFWGcG+9CuMXQMG625BhEBFEO3eOfPXAD5bc20RJWH3x3FrlcwqPrQELi6gf0d3/fDx5AwMt+Iu8GriuTYi0dgBhGqcPifiHw1y1zaZZv0nWahDFjnkvQM2GznkHfHO16s4lrCCYV5OnmGpx+rqohWCCYA0RqtuED1zJdViMM3DkdtwxXUXk41zTHPwsgJsGmW64YW8fvs1/v3/BnaVFt29DabJ9WxfEpezMh3nLHW/WRsSjCcliTtGlzaFWmCM7yJVgqNerMtkznuG7oUC21HTojm1vMuWt7huP7CEZmwO+/Py+GbQA8/DVOXFLntIBl2dZwJlVKC2PjyjzpM5NY8Cx0qA/MykrfzWiHO90uihS/4+Fe6eZjQE6mrfcv71UGXlV4jOaZ4c8npyMf4SeygZrHtJdNdYVNJXYvYxuhncz2EjvBzf5ln8NtqW19RXuO9Xr8urBGvkzV9uUap229wJLo01qMX7YoVL47bHezo7HXiNM1tvjkKfoH6ZVYnb3JStNQhFZuFSVoyeKXOf37bvQltogPni6xbworbAGJOd0yNKywI8penzKIH2ZGjQTzaLuWOy0QxZWYzrOIIL2wvE0V3J47JXA7ExFPehR7KadsFTOcUU8kj9O7LV46UD2RPC4IxOTlFY0nErVV1aBDrPe32Aw+X45OaoHJrY7MqeUNRWlapLJRKY3y7XZKs8akNB+wFijL6BiV47ucP87hJtJJaaJFn6G0vdSf/ylGpLUsRJDiTFweYjhZdycwLE5Ilx2LMolED7GK0vbVE6ulQqzOmMSKQBDMvaM9yOLYd0/mIGBwxy/iEsPRsuiMwdpBsXh/H+Aem+uJ//XoCw8X2Oe6FyDYwWeKFPdlCP3VYgqOU4dmC1TcORCIPpBEsPJBWf3QvKjn/YIVOuqxRLuCo/0lgSgILngDE/hU+/ok2Sxv3jIdCZMF4oJbgYYFPzNiWJXJEkZ6ZKt/UrZasd/yo4oB98dkadpIO5MNxmSyrsUnEJgd2SifPxBwE2nkoq5Iqye46C0JzXmtrNRmd9WSiU+GhLL53e+Fsj1RNbxHi55nhwXeI2w3W0gYKTVo5hmEE2WgSPJgfUnjyqleb0qlLPlKnrYlTdMaVbJ1FJiuN6oaig5VNrzD6ho1AoDLJyEMZ/LxREWU0DINwh2bPC3jdNisPxh19qZFXjF1eip6pzeu3gk4udjqLBMBzu9rGcMJRZ4oFD0U/r8Y7rE8tEGSUIv6Uo/GnObZa3NMVHr20gXXTt2+ePYiFMK/9mQ98yxar2GGTXCvTNYEjs2dZlRnrG2EJ+Oyro59ELnsHmZfowWcgAsCODQpqQWz3mCQFROj6VK9BhuyR2m/VTYPhlpsPeaNPs/y1oPbV/GjUkRNJthHIDjL4uZQT9K1OdId0EwcXJ7EoZj0w5xZhBs0lUe4LPequvQGHXC3tfSu1smnmDNUr15yJK/LmJdrs7ZwMzBE5kUPUIZwdNhmA5lhQWfGH7XPXVPaX7jC2GGz/pZwkb3sirw/I8TugiHyAHt+vDuazvjfl3Wa4xcYSGh+Ek1I2USxBsUXC/5RPPNh18ODvl4y96kQQKnc8wQqt2RFW/hqIv0UbTFEgbCjjKJuoaiv6DQtFkr2xFGdOMAKnDkwLNv2Tc/xXVNMnHAdB3g4RNkLqkjOs0UgK+CCFT3usNFZjMboTYDWBU6SVUHxCWZ196Mn+B/bsi86VUnpI+RjZCADHro+hzBlrNpUi2sK8++rnpkJuFv2mNJ7/ac1AkO07F1OCYrV+Vopobk6XxsDb6ODnqBPS8C1K6/uqNB3LRawIODCWs4oJ8XNZHMz6WTTtJRnGzhxpcxdo/hEinuGj/TrRsOmN4pVJntMWWJYiylTnYCpwyDpKjhlj7Yxoy/bWMPGtMJ7yFXRkmB7WVZalyXTWlqAQbHX0XDFJd3z0+gMyzEH2eOq0sQ17jEnUFsd99hpnUbnHouxPXro+Izk46ntMZdu3jFOmaNjfhqdeyxanz+k2ZfC3jOjga67LF0UjuXerTUxXOXn2mp6PiOrUHGWXKnkX7fJ0hhapsSujgBlV3R0Fr57dlvyTQbD5ZvaFUu0oQ24K6IJ7V9p4S6tCMS4KTdFTPt9zbtCBT7G+SrJttOyK4GWBB7JKYX/uphvpn1kBf0cWfw0Oh2mIhnevEvzHGKqM+7TDN6mSfzypijQl/BFIFH4tFAgTd56q/XggcHthtfZvMPP5BjDqXQVYCZnhW/M81FFxinruT8mfFwuxM7pmrjMTzRk0Zoq2OrNMgGHK1veuSuEMNOgbSEUTLxn84DKinOlbmIad9NeXm/UwHaHOzf4eopnnEAs9oZ0A5taDE5NkLq8Ct5Ym+3RE6IqTNuR1fATCTmCWnd7hIy2SYgb5cEw3kFFK4BV6OlaXUGYaVCB47yApiaBo1/sXJXIwhXd6C6w+J7TPpNWNiITPGvxk5JYSWwJuCVKPQ6WJDGDQrhkVfXvruyJ8Amb+ZaHTLm3C4LDDr8sLQ/L9FD6vTE4LqlgT9pPsrD0WmApBEcWF5L7pN7ai4IdOXOQxE5blXhm2iLosEcASdOeb6zhEtbg8LmNnVmDMJNO1iDpLkRTIEvS/rFsSEEqSQgYuf7sPbb0p0O7+4xSKgKcaSfs0IZWkUzbWKVc+uuxcAwYtw47XyHd4RU85brXgNMU/SEpuw9N8URHY6IMdofS1Jk8H1pidxUA+Ykcd0D5T9Kx7KckyiPEff/BzL1MzSk95QbpQBRHEm4/eJ9Dj7PZuGIO62B9DoG0dVBjBYE4XS/CvFrd5WG7K2ITtn9hVzhNMmRTC+uls7cp2iJctInkI2WdE6IuuLTeuuwjvSFa4bt8sMUGLrACEK1mlfmvlgPV2gXt9J1dAkAVlaDN+iUIJz0gmq/a4DhidK4NJAxNS3c0cGajF4ka0EXYAF2EDcFyXdm7q3J2vVu1K5JvNWuTb43mHPNZJul2NWx7nFNFkHt0nlG9tIZpBaOii0UFjOopHqc7zfQGVXv6UOWbY7l+x4jfyiBLJ7IGNKva2iXrHpU0dah636Bah6rNmuvcrs2PLK4yqDtg8yMgadciQrVty1mBqwnA/4N5/kJQGR6Q+GrdHXtd/pymu1mD0VCRJ7dJaSolbvUJCLYSlO0GKJ+H0XNzM23OROkRutOXmilptvUACy3h4acfHj7/+okqN1RPGFm/tDibvCuRxgfrKw6U6uyPSKyKp1IbsfZGdkpyeVMBf2Wyu0CxEm0FxJL+8P7nKDk846eG2TZCosFXKNHAf4NxlGC9GqvOj1FjDXXJhdsUz3hsyLXL0p2qO27wGuwOqw97tGRp3f7uSEqA8B1HeiJBMdeH5C9sSTnmJNzCfbEi4tKXBpFDQr8bY2Iil+6LblyKe1g2sWMvPQLBgPliPtH9dC13SvtpyyqHjSGqq0kwRsDIMHOjbCGO3n+CWYTWA5uhjuLMxeX7T0gtowbh8NKLyydiK+uK/ETBkLqieKZ/pjbSJdrPhczS2mY45cA7hWpQpw/8y4Q0riiKS81UdSFtqEQOIGlZcxRx73/95fPERFy+w+K4Iq57XthJJ6ekUiEXFX7cZjqZi7WOapL5UZ7WYT5RKvEPxs3Y8C2WaL2uPnTf5ybirds6uXcv6f3DiQ98OMYAPX7GhpnhzAPD9lxA/mV5nevPfccDtln+2xWCXBsFQRLRCsHm2rf9xG4StfRb4GajSsO6GmQazYCBm5JmTw95emzA/crj9fgo2pHj9Tzt8swY8XrtHJ8icDJBWsCw2GrRnQP2Aq4d3KABe700yOkjHKNV2GizPxcD6APKFAqZY/khill9ZsLhfkLAZscsdTFuUA1I57p4+E53NhEX9Ll4vD6KJE8bpQPY1tDImDgX+VxHnPu06znlvEDNuX0uzgNOBNePc3+sk10nzqfOf8XyDB2DLsT0XzWV7Vxcuh6HS1M7LsfyaPSGy6mD0DRYnmbTqIazhQCLNUfoAqHwO0Qc1gjCqxdVpw5CwDVu6g5CYHIg1HNCC7+jH4SiJPpw2MHssC/60LxWCwjSdlnhbWQTSC+d3a7MBDK9Rm/AZ8+AziYQYPisMWVQG4gvWjd7BlMPSYsDtHNod+0F41ZHqdxilyZFCjM5bqCEtbO7lAg/ZOoOhQ1eo/54XdY8CSvrWnRShLweex6oSjUPZugIZCmAfToYH36ffXMvtshzLtdBaWQHY3ANdQPGP4JHLWWIxHtO5ef5UWfOJuQ59cXZ+Ft2Dd0KoqRt6w9F4CVRDQuWxYdeLzK4RFCIwniqIfMABFwOOW1wNUZVBNM4M8VMHhunlroi5TusUDJmdos8cNA8mR+szpTa1dJAJSuG9IEX4aU3GQ3YvKuI6HrNLQz5CxzdnQUD0ZTx7wMsFgd3NX4M97Ksj1WRqbFL42hRLEgRDLxHMIyS9WR5iMWZ6yp7AdM2xB+KiQAVoUM99U2iujRLJ2GWc/UtijHCU66A7fTEPkxDiX2UwLmAfVxw1Ij0+UcYYZ5R0mBW1qDcb8qJyjB8nGSXhLhx99g0VxWKbjm3q9z4AWjObBCPKAcjVaHyQ4aTzhZpEVhYLOoijmAyfm4Dkl0VVpTOO4AoJCmmiJZvd1xTUhuqbE5FcDr2IgqwDCRHAa1JqT9FJDgR8FyeoHfh4su6WKpZ1eWrsEXsDwVW4xguatWz2OP3Y4gkjbBIpcStwspSZ0a6Ki7/K0pWaflU5cePh9Wq8CgVX4DPuI1VkbNL9Yi95P5+CLPHcA2P98LOvSqUDyOPtjA95FMVEnhFw6MoqCHDkqVe8c2me0LGeV7n+mE+coZGJSpcQ81DQILTagmTXauf8zM5/oCZE5ImWPdlrTqBWimJK5HhG0i5BMBj1QPXlJSpkzQVtHSYJE1Duy+ljzo0J20cUodKSy0mVUZxUuGfGDvp2soZ2JxzxKH+nb5tlcItk4oFLbYK78ILLM3GDdMQVew7KtnA52if62heO31OJ2SXO2JdfpkxVUt2uWmIJuueOV0v4oya8+XSLOgTHphRI+glXK1jqDKoGoNW+hd3N6NxNTPgaePMC6gqqZGridriL2lNaXuDHM2kPR3orgFRdnMkll1NHE17vlCPNQRZx413urBr9xSLnnw544p2NrW3VQJZZ9Eu4Gay1JhgL0wEjBWr9Ur0i5FPYs5+SU+pDiDkmrW5jqaT+GJ1wSE6lL6DFVxT5TT1IsfD134dt0BKlRxQ2fI6iqmOz000YMtd88xGhlMCo3dO3Sh9FbfVXLvj1vLhEca3yFGv4sBNBLiJemLjPk2okUe06GDKogP8M/FvR2kikMQb0HZ8wB2MpugBpkkF+pWdMzu8T4lPmd/4VFc+5XQ8UgU+pSk1U+BTunMKzP76Vr/uLuWm5c2D2p/HleXo2rT8xLymA5iPh6uoaJpXX77gCstqSLqQdzVWu7bBQIdLsNJU4UDIkdFeZ8M0+yhx8AZY2ElEdM0NbZ93TBbWR8K7gIzmQsaTR4AdBNzedI0X4meygTXgvvYhvL+mffVpuN/F+8rP1N++ordF1Hft60gH3XxMlxB/4/8=&lt;/diagram&gt;&lt;/mxfile&gt;&quot;}"></div>
<script type="text/javascript" src="https://www.draw.io/js/viewer.min.js"></script>
</body>
</html>
46 changes: 46 additions & 0 deletions docs/template.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## Magisk Module Template Intro
The **Magisk Module Template** is hosted **[here](https://github.com/topjohnwu/magisk-module-template)**.

The template is created to be simple to use that anyone can create their own modules easily. The template itself contains minimal scripting for installation; most of the functions are located [here](https://github.com/topjohnwu/Magisk/blob/master/scripts/util_functions.sh), which will be installed along with Magisk, and can be upgraded through a Magisk upgrade instead of a template update.

The template can cover most modules' needs: you can add files into `system`, which will be cloned into `/system` by Magisk after installing the module. In addition to module files, `system.prop`, `post-fs-data.sh`, `service.sh` are also installable through this template.

## Template Structure
Here are some files you would want to know:

- `config.sh`: A simple script used as a configuration file for the actual installation file to correctly install you module. Here is the place you can select which features your module needs/disables.
- `module.prop`: This file contains your module's indentity and properties, including name and versions etc.. This file will be used to identify your module on an actual device and in the [Magisk Modules Repo](https://github.com/Magisk-Modules-Repo)
- `common/post-fs-data.sh`: Module specific script to run in post-fs-data mode
- `common/service.sh`: Module specific script to run in late_start service mode
- `common/system.prop`: This prop file will be loaded into Android's system props
- `META-INF/com/google/android/update-binary`: The actual installation script. Modify this file for advanced custom behavior

## Create a Magisk Module With The Template
1. Clone / download [this repo](https://github.com/topjohnwu/magisk-module-template)
1. Open `config.sh` and carefully read the fully documented file. Follow the instructions within the script
1. You should at least modified `config.sh` and `module.prop`
1. Directly zip your files, and the result zip file is a flashable zip for both Magisk Manager and custom recoveries
1. Please check **Notes** for precautions

## Submit Your Module to Magisk Modules Repo
If you want to share your module with others, you can submit your modules to [Magisk Modules Repo](https://github.com/Magisk-Modules-Repo). In order to submit a module, you will need to know how to use some basic `git`.

1. Create a module as stated above, and test if it works properly
1. Fork [this repo](https://github.com/topjohnwu/magisk-module-template) to your account
1. Commit and push your changes to your forked repo
1. Open an issue in [topjohnwu/Magisk_Repo_Central](https://github.com/topjohnwu/Magisk_Repo_Central/issues/new) with your repo link
1. I will review your module, and once accepted, your repo should be cloned into [Magisk-Modules-Repo](https://github.com/Magisk-Modules-Repo), and you should receive an email to become the collaborator so you can edit the repo in the future.

#### Once your module is live on the Modules Repo, the description of your repo should be the ID of your module. Please do NOT change the description, repeat, do NOT change the description.

## Notes
- The Module Template depends on external scripts installed by Magisk, so it each version of template will has its own minimal Magisk version requirement.
- **Windows users please aware!!** The line endings on all text files should be the **Unix format**. Please use advanced text editors like Sublime, Atom, Notepad++ etc., **NEVER** use Windows Notepad.
- In `module.prop`, `version` can be an arbitrary string, so any fancy version name (e.g. ultra-beta-v1.1.1.1) is allowed. However, `versionCode` **MUST** be an integer. The value is used for version comparison.
- Make sure your module ID **doesn't contain any spaces**.

#### For Repo Developers

- Magisk Manager monitors all repo's `master` branch. Any changes to the branch `master` will be reflected to all users immediately. If you are working on an update for a module, please work on another branch, make sure it works, then finally merge the changes back to `master`.
- Once you finished upgrading your repo, bump up at least the `versionCode` in `module.prop`, so Magisk Manager will know you module is updated!
- The description of your repo should be the same as your module ID. If you changed your description, Magisk Manager will fail to identify your repo, and cannot relate installed module to the online repo together.

0 comments on commit 3a084c5

Please sign in to comment.