Official add-on repository: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(xbmc -> kodi)
mNo edit summary
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{mininav|[[Development]]|[[Add-on development]]}}
{{Mininav|[[Development]]|[[Add-on development]]}}
<br />
<br />
Kodi 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. Kodi has two official repositories that are included by default (''kodi.tv Add-ons'' and ''kodi.tv PVR Add-ons'') and are maintained by the  [[Team Kodi|Kodi team]] (''Team Kodi''). 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 [[w:Software repository|software repositories]] from which a wide array of add-ons can be installed. The model is similar to the way many current [[w:Linux|Linux]] [[w:Linux distribution|distributions]] work, whereby there is a carefully curated main repository enabled by default during installation and additional ones 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'') that are 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.<br />


== List of add-ons ==
See:
* [https://kodi.tv/addons Official Add-ons Gallery]
* [[:Category:All add-ons]]


== 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 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 just a [[w:Zip (file format)|Zip file]] is also possible, at which point it becomes the user's responsibility to verify that they are compatible with the Kodi release being used.


=== kodi.tv / Kodi Add-ons ===
Kodi uses [[w:Git (software)|Git]] to manage the official repositories. The list below details the structures that comprise them. If you already have Git installed on your system, the commands following each link will download a copy of the repository for you to add your prospective add-on to and then submit for inclusion:


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.  
:{|
For the time being each version of Kodi will have its own repo which contain only add-ons that are compatible with that specific version of Kodi. Manually installing add-ons is possible but remember to check if these are compatible for your Kodi version.
  | style="text-align: right;" | '''[https://github.com/xbmc/repo-plugins Plugins]:'''
  | <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-plugins.git</nowiki></kbd>
  |-
  | 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>
  |-
  | style="text-align: right;" | '''[https://github.com/xbmc/repo-scripts 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>
  |-
  | 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>
  |}


Kodi 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 Kodi'' members who have repository pushing rights. You should not do any pull requests using these repositories. This is merely for information purpose only.
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.


Read only pull:
=== PVR add-ons ===
  git clone https://github.com/xbmc/repo-scripts
:{{Main|PVR}}
  git clone https://github.com/xbmc/repo-scrapers
  git clone https://github.com/xbmc/repo-scripts
  git clone https://github.com/xbmc/repo-skins
  git clone https://github.com/xbmc/repo-webinterfaces
 
All current add-ons can be downloaded as ZIP files from the [http://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.
 
=== kodi.tv / Kodi PVR Add-ons ===
 
For more info on PVR see here: [[PVR]]


=== Repo Branches ===
=== Repo Branches ===
Line 31: Line 40:


== 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 43: Line 52:
* [[Add-on repositories]]
* [[Add-on repositories]]


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

Revision as of 20:40, 27 August 2020

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. 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 additional ones 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) that are 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

See:

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 just a Zip file is also possible, at which point it becomes the user's responsibility to verify that they are compatible with the Kodi release being used.

Kodi uses Git to manage the official repositories. The list below details the structures that comprise them. If you already have Git installed on your system, the commands following each link will download a copy of the repository for you to add your prospective add-on to and then submit for inclusion:

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: