-
Notifications
You must be signed in to change notification settings - Fork 7
repo.json
The core of detailing to modules in Googlers-Repo/magisk-modules-repo-util
Tip
Non-array- and non-objects can also placed inside the module.prop
file!
The URL to your project's support page, forum, or issue tracker where users can get help or report problems.
Example:
"support": "https://github.com/owner/project/issues"
The URL to the donation page for your project, where users can financially support its development.
Example:
"donate": "https://example.com/donate"
The URL to a cover image representing the project. This should typically be a featured graphic for the project.
Example:
"cover": "https://example.com/cover.png"
The URL to the icon image of the project, which should be squared and no larger than 512x512 pixels.
Example:
"icon": "https://example.com/icon.png"
An SPDX identifier specifying the license for the project.
For SPDX identifiers, see the SPDX license list.
Example:
"license": "MIT"
The URL to the project's README file, which typically contains information like a project description and setup instructions.
Example:
"readme": "https://github.com/owner/project#readme"
The URL to the homepage of the project.
Example:
"homepage": "https://example.com"
An array of URLs to screenshots of the module.
Example:
"screenshots": [
"https://example.com/screenshot1.png",
"https://example.com/screenshot2.png"
]
The category the module belongs to. This field is deprecated.
Example:
"category": "Utility"
Important
Repository owners can set a whitelist to prevent spam and abuse
An array of categories the module belongs to.
Example:
"categories": ["Utility", "Tools"]
An array of module_id
s this module depends on.
Example:
"require": [
"com.example.module1",
"com.example.module2"
]
An additional note for the module. This is an optional field, but if it's defined, the message field is required.
Example:
"note": {
"title": "Important Update",
"color": "red",
"message": "This module requires Magisk version 24.0 or higher."
}
Note
If you want to implant this into your app, you should follow the semver syntax
Defines the minimum version requirements for root solutions such as Magisk, KernelSU, or APatch.
Example:
"root": {
"kernelsu": ">= 1.0.0",
"magisk": ">= 24.0"
}