|Development||Add-on development||Submitting Add-ons|
1 Submitting a Compliant Add-on to the Kodi.tv Repo
After you have read the repository guidelines and made sure your addon is compliant with them, you may begin the submission process using the following steps.
2 Allowed submissions
We have restricted the allowed submissions of add-ons to past Kodi versions. Several reasons:
- Kodi code improvements
- Reduce support load for add-on developers
- Reduce workload for repository maintainers
Below is a table of on which submissions are allowed to official Kodi repository.
Additional feature is that we now use combined repositories. So if your add-on is Gotham/Helix compatible, you only need to send it to Gotham repository. If it's only Helix compatible you need to send it to Helix repository. This of course requires that the minimal Kodi dependencies are set accordingly.
3 The mailing list
We ask that all Add-on authors subscribe to the Add-ons Mailing List. This is done for several reasons.
- This is where all updates and important information will be announced.
- This way we can contact you regarding your add-ons if necessary.
- You can see what other devs are requesting to be added so you know if possibly you need to check compatibility of the add-on you depend on.
- You may find new and interesting add-ons this way on which you can get inspiration from or may depend on.
All pull requests should be sent to this list so that repository maintainers will be notified that you want to add of update your add-on. They will do a sanity check if all seems ok and you are following the Kodi guidelines for add-ons. If any issues or questions arise they will contact you through the e-mail you registered with. Once all checks out fine your add-on is added to repository and you will receive a confirmation e-mail that it is added.
3.1 How to submit your add-on and subsequent updates
In order to submit your addon, you must send a request that we add or update your add-on to the Add-ons Mailing List (We call this a "pull request."). Each request will require a version bump in the addon.xml. We ask that you also keep a changelog.txt up to date so that users may easily see what has changed.
Note that .xbt files will be generated automatically for skins so you do not include this in your pull request.
There are several ways to request that we add or update your add-on. Please preface threads using the following conventions:
|[Git Pull]||Submit a request that we pull from your repo. This should include a url, branch/tag/revision, and the addon to pull. HEAD is NOT a revision.|
|[SVN Pull]||Same as [Git Pull]|
|[Zip Pull]|| By far the least used but still a valid way. Submit a link where the add-on zip can be downloaded from.
For example you can just give us the link to .zip in your dropbox account. We do not want to download it from a public download site that holds questionable content or is filled with ads.
|[Patch]|| Sometimes you may wish to submit a patch to the author for review.
Under most circumstances we will not merge this directly, it should go to the upstream maintainer first.
After you have send it to the mailing list please keep an eye out for any reply from our repository maintainers if there are any remarks or changes needed or a simple confirmation it has been added. Do note it might take some time to process the request.
After it has been added or updated it will be available from the Kodi repository in Kodi itself, on http://addons.kodi.tv/ and on the wiki page http://kodi.wiki/index.php?title=Category:All_add-ons.
3.2 Example e-mail
[Git Pull] my.cool.plugin
*addon - my.cool.plugin *version - 1.1.0 *url - git://some.where.git *revision - a241345a *branch - master *xbmc version - helix
Alternatively, add-on updates may be submitted directly to the Official add-on repository on Github as pull requests. In addition to the repository guidelines the following rules apply when submitting PRs on Github:
- PR should contain one commit only.
- Commit message should have the format "[addonid] version". Example: "[my.cool.addon] 1.0.1"
As with mailing list, only PRs from add-on author will be accepted. Patches should be submitted upstream. For an easy way to create PR from your own git repository, see HOW-TO: create add-on PRs using Git Subtree Merging.