Plugins / Submit
Submit a plugin
New to plugins? Start from our plugin template. Then pick your repository and a release, run the check, and submit. We open a pull request on our plugin list for you, and Luis reviews it.
Step by step
Check and send
Sign in with GitHub so we know the repository is yours. GitHub will ask to let HolyArrs work with your public repositories. We use that only to read your plugin and to open the pull request in your name.
Before you start
What the check looks for
- Your repository was made from the HolyArrs plugin template (Use this template on GitHub).
- Your repository is public and yours.
- It has an open-source licence.
- The release tag matches
versioninplugin.json. plugin.jsonlists everything the plugin can reach, and says why for network and folders.- Approved releases are built by us, signed, and installed from us only. Your code stays yours.
Example
The plugin.json file
Put it at the top of your repository. The version must match the release tag, and permissions lists everything the plugin can reach.
{
"id": "trakt-sync",
"name": "Trakt Sync",
"version": "1.0.0",
"icon": "icon.png",
"screenshots": [
{ "src": "shots/watchlist.png", "alt": "Watchlist matched to HolyArrs titles" }
],
"permissions": [
{ "name": "library.read" },
{ "name": "alerts" },
{ "name": "network", "hosts": ["api.trakt.tv"], "why": "Reads your Trakt watchlist" }
]
}Permissions: library.read, library.write, requests, alerts, queue, settings.read, settings.write, network, folder. Network and folder need a why.
Icon and screenshots are optional: PNG, JPEG, WebP or SVG, up to 2 MB each, at most 8 screenshots. A square icon of at least 256 by 256 looks best. Without an icon, your plugin shows a tile with the first letters of its name.
Review
What happens next
- Your pull request appears on our plugin list, and the same check runs there.
- Luis reads the code of that exact release and approves it or says what to change.
- Once approved, we build that release, sign it and list it on this site. The code stays in your repository, under your licence.
- For a new version, publish a release and submit it again. Each update is reviewed the same way.