Official add-on repository: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
m (Robot: Substituting template: Name)
 
(15 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{mininav|[[Development]]|[[Add-on development]]}}
{{Mininav|[[Development]]|[[Add-on development]]}}<br />
<br />
XBMC includes an interface to browse remote [http://en.wikipedia.org/wiki/Software_repository repositories] from where add-ons can be retrieved. The model is similar to the way many current [http://en.wikipedia.org/wiki/Linux Linux] [http://en.wikipedia.org/wiki/Linux_distribution distributions] work, whereby there is a main repository that is the default, and additional ones may be added by the user. XBMC has two official repositories that are included by default (''XBMC.org Add-ons'' and ''XBMC.org PVR Add-ons'') and are maintained by the  [[Team XBMC|XBMC team]] (''Team XBMC''). This page outlines how to submit your add-on to the official repositories and keep it up to date.<br />


Kodi includes an interface to browse remote [[wikipedia:Software repository|software repositories]] from which a wide array of add-ons can be installed to provide new features or enhance existing ones. The model is similar to the way many current [[wikipedia:Linux|Linux]] [[wikipedia:Linux distribution|distributions]] work, whereby there is a carefully curated main repository enabled by default during installation and more may then be added by the user. Kodi has two official repositories that are included by default: ''Kodi.tv Add-ons'' and ''Kodi.tv PVR Add-ons'', both maintained by [[Archive:Team Kodi|Team Kodi]]. This page outlines how to submit an add-on for initial inclusion in the official repositories and how to update it once accepted.
== List of add-ons ==
{{Main|:Category:All add-ons|l1=All Add-ons category}}


== The repositories ==
== The repositories ==
=== General add-ons ===
Browsing add-ons can be done from within Kodi through the built-in [[add-ons]] browser. From here you can install any add-on that is listed in the [[Official add-on repository|Kodi.tv official repository]]. They are structured so each [[Releases|codenamed release]] accesses only the add-ons that are compatible with that specific version. Manual installation of add-ons from a [[wikipedia:Zip (file format)|zip archive file]] is also possible, but at that point it becomes <span style="text-decoration: underline;">the user's responsibility</span> to verify that they are compatible with the Kodi release being used.


=== XBMC.org Add-ons ===
Kodi uses the [[wikipedia:Git (software)|Git]] [[wikipedia:Version control|version control system]] to manage the official repositories. The list below details their organizational structures. The Git commands following each link will download a copy of that repository for you to use in creating a changeset which adds your prospective add-on to it. The changeset is what is needed to propose a new add-on for inclusion in the official repositories, for which the submission and subsequent review takes the form of a Git [[wikipedia:Pull request|pull request]].
 
{| style="margin-left: 2em;"
Browsing add-ons can be done from within XBMC through the built-in [[add-ons]] browser. From here you can install any add-on that is listed in the XBMC.org official repository.  
  | style="text-align: right;" | '''[https://github.com/xbmc/repo-plugins Plugins]:'''
For the time being each version of XBMC will have its own repo which contain only add-ons that are compatible with that specific version of XBMC. Manually installing add-ons is possible but remember to check if these are compatible for your XBMC version.
   | <kbd style="background-color: #f4f4f4; border: 1px solid #ddd; border-left: 4px solid #e04a2a; border-radius: 5px; color: #333; margin: 1em 0; padding: 2px 0.8em;">git clone <nowiki>https://github.com/xbmc/repo-plugins.git</nowiki></kbd>
 
  |-
XBMC uses [http://en.wikipedia.org/wiki/Git_(software) Git] to manage the official repository. See below for the list of git repositories that comprise it. This information is only useful for ''Team XBMC'' members who have repository pushing rights. You should not do any pull requests using these repositories. This is merely for information purpose only.
   | style="text-align: right;" | '''[https://github.com/xbmc/repo-scrapers Scrapers]:'''
 
   | <kbd style="background: #f4f4f4; color: #333; border: 1px solid #ddd; border-left: 4px solid #e04a2a; border-radius: 5px; padding: 2px 0.8em; margin: 1em 0">git clone <nowiki>https://github.com/xbmc/repo-scrapers.git</nowiki></kbd>
   git clone ssh://''sourceforge_username''@git.code.sf.net/p/xbmc/plugins
  |-
   git clone ssh://''sourceforge_username''@git.code.sf.net/p/xbmc/scrapers
  | style="text-align: right;" | '''[https://github.com/xbmc/repo-scripts Scripts]:'''
   git clone ssh://''sourceforge_username''@git.code.sf.net/p/xbmc/scripts
   | <kbd style="background: #f4f4f4; color: #333; border: 1px solid #ddd; border-left: 4px solid #e04a2a; border-radius: 5px; padding: 2px 0.8em; margin: 1em 0">git clone <nowiki>https://github.com/xbmc/repo-scripts.git</nowiki></kbd>
   git clone ssh://''sourceforge_username''@git.code.sf.net/p/xbmc/skins
  |-
   git clone ssh://''sourceforge_username''@git.code.sf.net/p/xbmc/webinterfaces
  | style="text-align: right;" | '''[https://github.com/xbmc/repo-skins Skins]:'''
   | <kbd style="background: #f4f4f4; color: #333; border: 1px solid #ddd; border-left: 4px solid #e04a2a; border-radius: 5px; padding: 2px 0.8em; margin: 1em 0">git clone <nowiki>https://github.com/xbmc/repo-skins.git</nowiki></kbd>
  |-
  | style="text-align: right;" | '''[https://github.com/xbmc/repo-webinterfaces Web Interfaces]:'''
  | <kbd style="background: #f4f4f4; color: #333; border: 1px solid #ddd; border-left: 4px solid #e04a2a; border-radius: 5px; padding: 2px 0.8em; margin: 1em 0">git clone <nowiki>https://github.com/xbmc/repo-webinterfaces.git</nowiki></kbd>
  |}


All current add-ons can be downloaded as ZIP files from the [http://mirrors.xbmc.org/addons/ repository server].
All current add-ons can be downloaded as ZIP files from the [https://mirrors.kodi.tv/addons/ repository server]. Feel free to see which ones there are and perhaps you they might give you some ideas for creating your own. These are also great examples for getting started and see how things are done in more extensive add-ons.
Feel free to see which ones there are and perhaps you they might give you some ideas for creating your own. These are also great examples for getting started and see how things are done in more extensive add-ons.


=== XBMC.org PVR Add-ons ===
=== PVR add-ons ===
 
:{{Main|PVR}}
For more info on PVR see here: [[PVR]]


=== Repo Branches ===
=== Repo Branches ===
For each version of XBMC there will be a specific branch of the XBMC.org add-on repository. As development progresses for the next version of XBMC, a repository for that next version will also be made. These repositories are automatically selected depending on which version of XBMC (stable or development) that the user is using. When the development XBMC repository is open we ask that add-on developers still maintain versions of their add-ons for the stable XBMC repository until that next development version of XBMC is released and becomes the new stable. When both repositories are open add-on developers will need to follow submission and update procedures individually to be in both. It is highly recommended to take advantage of the development XBMC repository so that your add-on is prepared for the next version of XBMC.
For each version of Kodi there will be a specific branch of the Kodi add-on repository. As development progresses for the next version of Kodi, a repository for that next version will also be made. These repositories are automatically selected depending on which version of Kodi (stable or development) that the user is using. When the development Kodi repository is open we ask that add-on developers still maintain versions of their add-ons for the stable Kodi repository until that next development version of Kodi is released and becomes the new stable. When both repositories are open add-on developers will need to follow submission and update procedures individually to be in both. It is highly recommended to take advantage of the development Kodi repository so that your add-on is prepared for the next version of Kodi.


== Submitting add-ons ==
== Submitting add-ons ==
{{main|Submitting Add-ons}}
:{{Main|Submitting Add-ons}}


== See also ==
== See also ==
* [[Add-ons]]
* [[Add-ons]]
* [[:Category:All add-ons]]
* [[:Category:All add-ons]]
* [[3rd party add-on repositories]]
* [[Unofficial add-on repositories]]
'''Development:'''
'''Development:'''
* [[Add-on development]]
* [[Add-on development]]
Line 42: Line 49:
* [[Add-on repositories]]
* [[Add-on repositories]]


[[Category:XBMC Manual]]
 
[[Category:Add-ons]]
[[Category:Team XBMC specific notes]]
[[Category:Add-on development]]
[[Category:Add-on development]]
[[Category:Manual]]
[[Category:Repositories]]

Latest revision as of 08:26, 2 September 2022

Home icon grey.png   ▶ Development ▶ Add-on development ▶ Official add-on repository


Kodi includes an interface to browse remote software repositories from which a wide array of add-ons can be installed to provide new features or enhance existing ones. The model is similar to the way many current Linux distributions work, whereby there is a carefully curated main repository enabled by default during installation and more may then be added by the user. Kodi has two official repositories that are included by default: Kodi.tv Add-ons and Kodi.tv PVR Add-ons, both maintained by Team Kodi. This page outlines how to submit an add-on for initial inclusion in the official repositories and how to update it once accepted.

List of add-ons

The repositories

General add-ons

Browsing add-ons can be done from within Kodi through the built-in add-ons browser. From here you can install any add-on that is listed in the Kodi.tv official repository. They are structured so each codenamed release accesses only the add-ons that are compatible with that specific version. Manual installation of add-ons from a zip archive file is also possible, but at that point it becomes the user's responsibility to verify that they are compatible with the Kodi release being used.

Kodi uses the Git version control system to manage the official repositories. The list below details their organizational structures. The Git commands following each link will download a copy of that repository for you to use in creating a changeset which adds your prospective add-on to it. The changeset is what is needed to propose a new add-on for inclusion in the official repositories, for which the submission and subsequent review takes the form of a Git pull request.

Plugins: git clone https://github.com/xbmc/repo-plugins.git
Scrapers: git clone https://github.com/xbmc/repo-scrapers.git
Scripts: git clone https://github.com/xbmc/repo-scripts.git
Skins: git clone https://github.com/xbmc/repo-skins.git
Web Interfaces: git clone https://github.com/xbmc/repo-webinterfaces.git

All current add-ons can be downloaded as ZIP files from the repository server. Feel free to see which ones there are and perhaps you they might give you some ideas for creating your own. These are also great examples for getting started and see how things are done in more extensive add-ons.

PVR add-ons

Repo Branches

For each version of Kodi there will be a specific branch of the Kodi add-on repository. As development progresses for the next version of Kodi, a repository for that next version will also be made. These repositories are automatically selected depending on which version of Kodi (stable or development) that the user is using. When the development Kodi repository is open we ask that add-on developers still maintain versions of their add-ons for the stable Kodi repository until that next development version of Kodi is released and becomes the new stable. When both repositories are open add-on developers will need to follow submission and update procedures individually to be in both. It is highly recommended to take advantage of the development Kodi repository so that your add-on is prepared for the next version of Kodi.

Submitting add-ons

See also

Development: