Submitting Add-ons
|
 Development |
Add-on development |
Submitting Add-ons
|
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.
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.
| codename | version | update | new |
|---|---|---|---|
| Dharma | 10.x | no | no |
| Eden | 11.x | no | no |
| Frodo | 12.x | no | no |
| Gotham | 13.x | no | no |
| Helix | 14.x | no | no |
| Isengard | 15.x | no | no |
| Jarvis | 16.x | no | no |
| Krypton | 17.x | no | no |
| Leia | 18.x | no | no |
| Matrix | 19.x | yes | yes |
| Nexus | 20.x | yes | yes |
| Omega | 21.x | yes | yes |
| Piers | 22.x | yes | yes |
An additional feature is that we use combined repositories. So if your add-on is Matrix/Nexus/Omega compatible, you only need to send it to the Matrix repository.
If it's only Omega+ compatible you need to send it to the Omega repository.
This of course requires that the minimal Kodi dependencies are set accordingly.
Note that as of April 2024, only Python 3 add-ons are accepted since the last Python 2 release, Leia, is out of support. Contributions to the Leia and older repositories will no longer be accepted.
| codename | version | repos | repo | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Dharma | 10.x | Dharma | |||||||||
| Eden | 11.x | Eden | |||||||||
| Frodo | 12.x | Frodo | |||||||||
| Gotham | 13.x | Gotham | |||||||||
| Helix | 14.x | Gotham | Helix | ||||||||
| Isengard | 15.x | Gotham | Helix | Isengard | |||||||
| Jarvis | 16.x | Gotham | Helix | Isengard | Jarvis | ||||||
| Krypton | 17.x | Gotham | Helix | Isengard | Jarvis | Krypton | |||||
| Leia | 18.x | Gotham | Helix | Isengard | Jarvis | Krypton | Leia | ||||
| Matrix | 19.x | - | - | - | - | - | - | Matrix | |||
| Nexus | 20.x | - | - | - | - | - | - | Matrix | Nexus | ||
| Omega | 21.x | - | - | - | - | - | - | Matrix | Nexus | Omega | |
| Piers | 22.x | - | - | - | - | - | - | Matrix | Nexus | Omega | Piers |
| codename | version | repos | repo | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Dharma | 10.x | Dharma | ||||||||
| Eden | 11.x | Eden | ||||||||
| Frodo | 12.x | Frodo | ||||||||
| Gotham | 13.x | Gotham | ||||||||
| Helix | 14.x | Gotham | Helix | |||||||
| Isengard | 15.x | Isengard | ||||||||
| Jarvis | 16.x | Jarvis | ||||||||
| Krypton | 17.x | Krypton | ||||||||
| Leia | 18.x | Leia | ||||||||
| Matrix | 19.x | Matrix | ||||||||
| Nexus | 20.x | Matrix | Nexus | |||||||
| codename | version | repos | repo | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Dharma | 10.x | Dharma | |||||||||
| Eden | 11.x | Eden | |||||||||
| Frodo | 12.x | Frodo | |||||||||
| Gotham | 13.x | Gotham | |||||||||
| Helix | 14.x | Gotham | Helix | ||||||||
| Isengard | 15.x | Gotham | Helix | Isengard | |||||||
| Jarvis | 16.x | Gotham | Helix | Isengard | Jarvis | ||||||
| Krypton | 17.x | Gotham | Helix | Isengard | Jarvis | Krypton | |||||
| Leia | 18.x | Gotham | Helix | Isengard | Jarvis | Krypton | Leia | ||||
| Matrix | 19.x | Gotham | Helix | Isengard | Jarvis | Krypton | Leia | Matrix | |||
| Nexus | 20.x | Gotham | Helix | Isengard | Jarvis | Krypton | Leia | Matrix | Nexus | ||
| Omega | 21.x | Gotham | Helix | Isengard | Jarvis | Krypton | Leia | Matrix | Nexus | Omega | |
| Piers | 22.x | Gotham | Helix | Isengard | Jarvis | Krypton | Leia | Matrix | Nexus | Omega | Piers |
Github
Pull requests
New add-ons or updates may be submitted directly to the Official add-on repository on Github as pull requests. We are aware that this requires some initial git knowledge and we strongly suggest to read up on this subject before submitting a pull request.
To reduce size we have split up the git repositories in several locations. Please visit Official add-on repository to see where they are. Each contains a small readme with a short description of it's contents as well as a link to a short explanation on how to submit using git command line. There are also git tools available that have a graphic interface and the steps above should be done in a similar way. Please consult the manual of those programs.
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"
If Team Kodi reviewers asked you to make some changes in your PR, follow this procedure: HOW-TO: Update a pull request to an official addon repository on GitHub.
Only PRs from the add-on author or his successor will be accepted. Patches should be submitted upstream to the original author first. For an easy way to create PR from your own git repository, see HOW-TO: create add-on PRs using Git Subtree Merging.
Issue ticket
This route is only available for skins in https://github.com/xbmc/repo-skins.
For skins submissions you may also use the "issue" option where you submit a request to get you add-on added. In this ticket you need to provide the basic information needed so our repo maintainers know where to get the correct version. This consists of
- Add-on name: - Add-on ID: - Version number: - Kodi/repository version: - Code location URL: - Revision/tag: - Branch:
Further information is provide when you initially create the issue on github as comments in the ticket. Same repository guidelines apply here as well.
How to submit your add-on and subsequent updates
Submitting updates is done the same way as with pull requests or issue ticket.
Repository lists
You can create pull requests or tickets on the following individual repositories.
https://github.com/xbmc/repo-plugins https://github.com/xbmc/repo-resources https://github.com/xbmc/repo-scrapers https://github.com/xbmc/repo-scripts https://github.com/xbmc/repo-skins https://github.com/xbmc/repo-webinterfaces
Additional information
Note that skin .xbt files will be generated automatically for skins so you do not include this in your pull request or created tickets. After the add-on 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.
Note: Please locate you add-on in the root of the git repository. This to make sure we can easily pull the add-on into our repository. Example: https://github.com/XBMC-Addons/service.xbmc.versioncheck
Tip: We automatically combine all repos into one single repo list on our server and provide that list to Kodi. You only need to do a request for the minimum repo your add-on supports.The mailing list
MAILINGLIST IS NOT USED ANYMORE. ALL REQUESTS SHOULD GO THROUGH GITHUB