Magisk Repo Submissions
This is the place for developers to submit their Magisk Module to the Magisk-Modules-Repo.
You might want to follow me on Twitter for real-time announcements about the status of the MagiskBot server, emergency issues, new rules or features etc.
- 2018.10.16: All DNS related modules are restored back to Magisk-Modules-Repo.
- 2018.10.14: Existing modules that are considered "inappropriate" by the moderation team are removed from Magisk-Modules-Repo (full list here). In case of developers that have no backup of their own modules, all removed modules are moved to Magisk-Modules-Grave instead of being deleted. Magisk-Modules-Grave is scheduled to be removed on November 1st, 2018; you have more than half a month before the module is actually removed from GitHub.
- Read the Magisk Documentation. Module developers are expected to be familiar with Magisk and GitHub.
- Create a repository with your personal GitHub account, and host your module in the repo.
- A valid Magisk Module. (e.g. proper and unique
versionCodeshould be an integer etc.)
- A well formatted
README.mdcontaining information about the module.
- English must be used in
README.md, other languages are allowed.
- No material infringing copyright.
What Will NOT be Approved
- If you cannot properly submit a module, it means you cannot even read basic instructions.
Your module will never get approved even if you get it right after multiple "tries".
- A repo without
- A module that only contains some simple boot scripts.
- A module that only uses
system.propto modify system props.
- A module that is simply a duplicate of an existing module, or only little modifications are done.
In other words: no plagiarism.
- Create an issue with the title starting with
[Submission]. The body of the issue is the GitHub link of your own module's repository.
- A moderator will review your module and decide whether your module is approved or rejected.
- Once approved, your module will be cloned to Magisk-Modules-Repo, and a collaboration invitation will be sent to your email so you have admin permissions to the module.
- Once you accepted the invitation for collaboration on GitHub, you have admin permission; this means you can delete the module yourself via GitHub.
- You should update your module directly to the repo on Magisk-Modules-Repo, NOT your personal repo! Your personal repository hosting your module will not be used by Magisk in any way.
- Every time you finish upgrading your repo, increment
module.prop. Magisk Manager compare this value with the local installed module to determine whether an update is available.