https://kodi.wiki/api.php?action=feedcontributions&feedformat=atom&user=AlwinusOfficial Kodi Wiki - User contributions [en]2026-06-16T21:48:56ZUser contributionsMediaWiki 1.43.8https://kodi.wiki/index.php?title=Addon.xml&diff=224891Addon.xml2021-03-08T13:42:09Z<p>Alwinus: </p>
<hr />
<div>{{mininav|[[Development]]|[[Add-on development]]}}<br />
{{TOC right}}<br />
<br /><br />
<br />
Every skin, script, or plugin in Kodi contains an <code>addon.xml</code> file which describes the add-on, providing credits, version information and dependencies. Below, we will explain how this file is structured and which elements must be used to create an add-on for Kodi. You can also consult the examples at the end to see how this file is laid out depending on if you are developing a skin or script.<br />
<br />
Every <code>addon.xml</code> file has the same basic structure, this example is for a video plugin:<br />
<br />
<syntaxhighlight lang="xml" enclose="div"><br />
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><br />
<addon id="plugin.addon.id" name="Your Add-on" version="1.2.3" provider-name="You"><br />
<requires><br />
<import addon="xbmc.python" version="2.25.0"/><br />
</requires><br />
<extension point="xbmc.python.pluginsource" library="addon.py"><br />
<provides>video</provides><br />
</extension><br />
<extension point="xbmc.addon.metadata"><br />
<summary lang="en_GB">Your add-on's summary</summary><br />
<description lang="en_GB">Your add-on's description</description><br />
<disclaimer lang="en_GB"></disclaimer><br />
<language>en</language> <!-- the language of the videos or other content the plugin provides, may be omitted in case the addon does not provide any content --><br />
<platform>all</platform><br />
<license>GPL-2.0-or-later</license><br />
<forum>https://forum.kodi.tv/showthread.php?tid=xxxx</forum> <!-- may be omitted --><br />
<website>http://myplugin.com</website> <!-- the url of the website that contains the videos (or the official website of your plugin). May be omitted. --><br />
<email>you@youremail.com</email> <!-- may be omitted --><br />
<source>http://github.com/you/plugin.addon.id</source><br />
<news>v1.2.3 (01/02/201x)<br />
[new] some new feature<br />
[fix] some fix<br />
</news><br />
<assets><br />
<icon>resources/icon.png</icon><br />
<fanart>resources/fanart.jpg</fanart><br />
<banner></banner> <!-- optional --><br />
<clearlogo>resources/clearlogo.png</clearlogo> <!-- optional --><br />
<screenshot></screenshot> <!-- optional, max 10 --><br />
</assets><br />
</extension><br />
</addon><br />
</syntaxhighlight><br />
<br />
There are a few important things to note in the above sample:<br />
<br />
* The <code><addon></code> element must be present, and be the root node. It presents data about the add-on package as a whole.<br />
* Inside the <code><addon></code> element is a <code><requires></code> element, listing all the dependencies that this add-on needs in order to function.<br />
* Then there are one or more <code><extension></code> elements, each of which describes a part of Kodi that the add-on extends.<br />
* Finally, there is a specific <code><extension></code> element that extends <code>"xbmc.addon.metadata"</code>. This describes the add-on to the user.<br />
* Banners and clearlogos assets exclusive to Kodi v.18+<br />
= Elements =<br />
<br />
== <addon> ==<br />
<br />
The <code><addon></code> element has 4 attributes, all required: <code>id</code>, <code>version</code>, <code>name</code>, and <code>provider-name</code>. For example:<br />
<br />
<source lang="xml"><br />
<addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2"><br />
</source><br />
<br />
=== id attribute ===<br />
<br />
The id attribute is the unique identifier used for this add-on. It must be unique, and must use only lowercase characters, periods, underscores, dashes and numbers. This identifier is also used as the name of the folder that contains the add-on, so for ease of searching, we suggest you use something like <type>.<uniquename>.<br />
<br />
=== version attribute ===<br />
<br />
The version attribute is used by Kodi to determine whether updates are available. This should be use a version scheme like <code>x.y.z</code> (major.minor.patch). For example: <code>version="0.0.1"</code>. Generally, you'll start with a version of <code>0.y.z</code> for test releases and once you feel it is ready for a full release, you'd bump the version to <code>1.0.0</code>.<br />
<br />
==== How versioning works ====<br />
<br />
* <code>2.2.9</code> is newer than <code>2.2.1</code><br />
* <code>2.2.10</code> is newer than <code>2.2.1</code><br />
* <code>2.3.0</code> is newer than <code>2.2.9</code><br />
* <code>2.2.1</code> is newer than <code>2.2.1~alpha</code><br />
* <code>2.2.1</code> is newer than <code>2.2.1~beta</code><br />
* <code>2.2.1~beta</code> is newer than <code>2.2.1~alpha</code><br />
* <code>2.2.1~beta3</code> is newer than <code>2.2.1~beta2</code><br />
* <code>2.2.1~beta10</code> is newer than <code>2.2.1~beta1</code><br />
<br />
{{tip|Text should only be added for a beta version. In other cases version number should only contain numbers.}}<br />
<br />
=== name attribute ===<br />
<br />
The name attribute is the name of the add-on as it appears in the UI. This should be in English where it makes sense for it to be so, and is not translatable.<br />
<br />
=== provider-name attribute ===<br />
<br />
The provider-name attribute is used as the author field. This could be a team of authors or a single author. If the add-on is maintained by multiple people please separate them with a comma (<code>,</code>).<br />
<br />
== <requires> ==<br />
<br />
The <code><requires></code> element contains one or more <code><import></code> elements which specify which other add-ons this particular add-on requires, and which version of those add-ons it requires. These add-ons may be part of Kodi itself, or may be parts of other third-party add-ons.<br />
<br />
Kodi will only allow the add-on to be run if suitable versions of the (non-optional) add-ons on which this add-on depends are installed. When a user installs your add-on from an online repository via Kodi's add-on manager, Kodi attempts to resolve these dependencies, and install anything that your add-on relies on first. The dependency must be provided with the minimum version number your script/skin requires.<br />
<br />
=== Examples ===<br />
<br />
Here is a sample <code><requires></code> block that imports two required modules:<br />
<br />
<source lang="xml"><br />
<requires><br />
<import addon="xbmc.python" version="2.25.0"/><br />
<import addon="script.module.elementtree" version="1.2.7"/><br />
</requires><br />
</source><br />
<br />
Here's another example, which will only install on LibreELEC. This occurs because the addon will depend on an addon that only exists in LibreELEC. Hence, Kodi will refuse to install the addon in other platforms due to unmet dependencies:<br />
<br />
<source lang="xml"><br />
<requires><br />
<import addon="os.librelec.tv" version="2.0"/><br />
</requires><br />
</source><br />
<br />
== <import> ==<br />
<br />
Each <code><import></code> element describes one dependency for an add-on, with two required attributes: <code>addon</code> and <code>version</code>. There is also an optional attribute called, fittingly, <code>optional</code>.<br />
<br />
If your add-on relies on other third-party add-ons, Kodi will automatically install them as well, provided they are available on an existing add-on repository. If they aren't available on any existing repository, the user must install the other add-ons themselves. Note that you need to include any Python libraries you need directly in your add-on; these can't be loaded with an <code><import></code> element, since Kodi wouldn't know what to do with them.<br />
<br />
=== addon attribute ===<br />
<br />
The <code>addon</code> attribute specifies the id of the required add-on, e.g. <code>script.module.elementtree</code>.<br />
<br />
=== version attribute ===<br />
<br />
The <code>version</code> attribute specifies the minimum version of the required add-on to be installed.<br />
<br />
==== Dependency versions ====<br />
<br />
Each different Kodi version might require you to use a higher version of the <code>xbmc.*</code> add-on dependencies to control on which version of Kodi the add-on can be installed.<br />
<br />
{| class="prettytable" border="1"<br />
|+ Current versions<br />
! Kodi version !! xbmc.python !! xbmc.gui !! xbmc.json !! xbmc.metadata !! xbmc.addon<br />
|-<br />
| Dharma 10.1 <font color="red">Deprecated</font>|| 1.0 || 2.11 || 2.0|| 1.0 || 0.1<br />
|-<br />
| Eden 11.0 <font color="red">Deprecated</font> || 2.0 || 3.0 || 4.0 || 1.0 || 11.0<br />
|-<br />
| Frodo 12.x <font color="red">Deprecated</font>|| 2.1.0 || 4.0.0 || 6.0.0 || 2.1.0 || 12.0.0<br />
|-<br />
| Gotham 13.x || 2.14.0 (ABI 2.1.0) || 5.0.1 || 6.6.0 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 13.0.0 (ABI 12.0.0)<br />
|-<br />
| Helix 14.x || 2.19.0 (ABI 2.1.0) || 5.3.0 || 6.20.0 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 14.0.0 (ABI 12.0.0)<br />
|-<br />
| Isengard 15.x || 2.20.0 (ABI 2.1.0) || 5.9.0 (ABI 5.3.0) || 6.25.1 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 15.0.0 (ABI 12.0.0)<br />
|-<br />
| Jarvis 16.x || 2.24.0 (ABI 2.1.0) || 5.10.0 || 6.32.4 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 16.0.0 (ABI 12.0.0)<br />
|-<br />
| Krypton 17.x || 2.25.0 (ABI 2.1.0) || 5.12.0 || 7.0.0 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 17.0.0 (ABI 12.0.0)<br />
|-<br />
| Leia 18.x || 2.26.0 (ABI 2.1.0) || 5.14.0 || 9.7.2 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 17.9.910 (ABI 12.0.0)<br />
|-<br />
| Matrix 19.x || 3.0.0 (ABI 3.0.0) || 5.15.0 (ABI 5.14.0) || 11.2.0 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 18.9.701 (ABI 12.0.0)<br />
|}<br />
<br />
Each Kodi version contain a certain backwards compatibility. For example add-ons made for Gotham 13.x can still work ion Jarvis 16.x. Do note that this might change in the future. The '''ABI''' version you see in the table above is the backwards compatibility version for which add-ons are still marked "working".<br />
<br />
=== optional attribute ===<br />
<br />
The dependency may be made optional by setting the <code>optional</code> attribute to <code>true</code>. This will only install the dependency when the add-on actually needs it. Even if this dependency is missing, the add-on can still be installed.<br />
<br />
== <extension> ==<br />
<br />
The <code><extension></code> element describes the technical aspects of this add-on. It will have at least a point attribute which will give the part of Kodi that the add-on extends. For instance, the <code>addon.xml</code> file for the Confluence skin extends the <code>xbmc.gui.skin</code> part of xbmc. All available extension points are given below.<br />
<br />
The various extension points that Kodi provides are given in the list below.<br />
{| class="prettytable"<br />
!Extension point<br />
!Add-on Category<br />
|-<br />
|<code>[[Skinning|xbmc.gui.skin]]</code><br />
|Skin<br />
|-<br />
|<code>xbmc.webinterface</code><br />
|Web interface<br />
|-<br />
|<code>[[Add-on repositories|xbmc.addon.repository]]</code><br />
|''None''<br />
|-<br />
|<code>[[Service_add-ons|xbmc.service]]</code><br />
|Services<br />
|-<br />
|<code>xbmc.metadata.scraper.albums</code><br />
|Album information<br />
|-<br />
|<code>xbmc.metadata.scraper.artists</code><br />
|Artist information<br />
|-<br />
|<code>xbmc.metadata.scraper.movies</code><br />
|Movie information<br />
|-<br />
|<code>xbmc.metadata.scraper.musicvideos</code><br />
|Music video information<br />
|-<br />
|<code>xbmc.metadata.scraper.tvshows</code><br />
|TV information<br />
|-<br />
|<code>xbmc.metadata.scraper.library</code><br />
|''None''<br />
|-<br />
|<code>xbmc.ui.screensaver</code><br />
|Screensaver<br />
|-<br />
|<code>xbmc.player.musicviz</code><br />
|Visualization<br />
|-<br />
|<code>[[Plugin sources|xbmc.python.pluginsource]]</code><br />
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)<br />
|-<br />
|<code>[[Script_sources|xbmc.python.script]]</code><br />
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)<br />
|-<br />
|<code>xbmc.python.weather</code><br />
|Weather<br />
|-<br />
|<code>xbmc.subtitle.module</code><br />
|Subtitle service module<br />
|-<br />
|<code>[[Script_lyrics|xbmc.python.lyrics]]</code><br />
|Lyrics<br />
|-<br />
|<code>xbmc.python.library</code><br />
|These don't show up in the addon browser and are purely as support for other scripts.<br />
|-<br />
|<code>xbmc.python.module</code><br />
|Provides an additional python library. mainly for use in script.module.* addons.<br />
|-<br />
|<code>xbmc.addon.video</code><br />
|Video Add-ons (video)<br />
|-<br />
|<code>xbmc.addon.audio</code><br />
|Music Add-ons (audio)<br />
|-<br />
|<code>xbmc.addon.image</code><br />
|Picture Add-ons (image)<br />
|-<br />
|<code>kodi.resource.font</code><br />
|Additional font files<br />
|-<br />
|<code>kodi.resource.images</code><br />
|Additional image files<br />
|-<br />
|<code>kodi.resource.language</code><br />
|Additional language files<br />
|-<br />
|<code>kodi.resource.uisounds</code><br />
|Additional sound files<br />
|}<br />
<br />
Add-ons that don't correspond to a specific add-on category can not be installed by users. These are usually supporting or shared add-ons that are installed automatically by the add-ons that require them.<br />
<br />
=== xbmc.python.pluginsource ===<br />
{{See also|Plugin sources}}<br />
<br />
The most common extension point that will be used by plugin addon developers is <code>xbmc.python.pluginsource</code>.<br />
<br />
==== library attribute ====<br />
<br />
The <code><extension point="xbmc.python.pluginsource"></code> element has an extra attribute: <code>library</code>. This is the name of the Python script (startup script) that will be run when the add-on is activated. This file must exist in the root of your add-on directory.<br />
<br />
==== <provides> element ====<br />
<br />
The extension has an additional child element named <code><provides></code>, which contains a whitespace separated list of <code>image</code>, <code>video</code>, <code>audio</code>, and/or <code>executable</code>. This determines in what area (or context) of the Kodi system your addon will make itself visible in (please note that this applies only to plugin extension points):<br />
<br />
{| class="prettytable"<br />
!Provides<br />
!Appears in<br />
|-<br />
|<code>image</code><br />
|Pictures<br />
|-<br />
|<code>audio</code><br />
|Music<br />
|-<br />
|<code>video</code><br />
|Video<br />
|-<br />
|<code>executable</code><br />
|Programs<br />
|-<br />
|''(blank)''<br />
|See Note<br />
|}<br />
<br />
{{Note|If the '''<provides>''' element is not defined, behaviour will depend on the structure of your addon. If it has a single extension point (e.g. a single '''xbmc.python.script''' or '''xbmc.python.pluginsource'''), kodi will default to "executable" (thus your addon will be shown in programs). If your addon has multiple extension points and none specifies a '''<provides>''' element, different entries for your addon will be shown in "programs" (multiple fallbacks to "executable"). If your addon has multiple extension points and only one (or some) define the '''<provides>''' tag it really depends on the order of the extension points. If the first extension point (your addon '''main extension point''') defines the '''<provides>''' element, kodi will assume all the other (empty) extension points provide the same content. Otherwise it will set the content for all the extension points that specify the '''<provides>''' tag and fallback all the others to "executable". '''At the moment, there is no way to hide an addon from the interface.''' |reminder}}<br />
<br />
==== Example ====<br />
<br />
<source lang="xml"><br />
<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py"><br />
<provides>audio video</provides><br />
</extension><br />
</source><br />
<br />
=== xbmc.addon.metadata ===<br />
<br />
This special extension point ''must'' be provided by all add-ons, and is the way that your add-on is described to users of the Kodi add-on manager.<br />
<br />
==== Available elements ====<br />
<br />
There are several elements that this should contain. Most of these elements are required (except the deprecated tag). However, in case the elements do not apply (e.g. language, website, email) they can be omitted from the addon.xml file. Language specific elements must always be present in English as a minimum.<br />
<br />
Many of these elements can be translated into multiple languages and should be added once for each supported language. The <code>lang</code> attribute should contain a [https://en.wikipedia.org/wiki/Locale_(computer_software) locale identifier]. If omitted, it defaults to en_GB. (Note: Kodi v14 and older uses ISO-639 code. See [[List of language codes (ISO-639:1988)]]).<br />
<br />
===== <summary> =====<br />
<br />
One or more <code><summary></code> elements provide a short summary of what the add-on does. This should be a single sentence. It may be translated into multiple languages.<br />
<br />
<source lang="xml"><br />
<summary lang="en_GB">Hello World script provides some basic examples on how to create your first script.</summary><br />
</source><br />
<br />
===== <description> =====<br />
<br />
One or more <code><description></code> elements provide a more detailed summary of what the add-on does. It may be translated into multiple languages.<br />
<br />
<source lang="xml"><br />
<description lang="en_GB">Hello World script provides some basic examples on how to create your first script<br />
and hopefully will increase the number of Kodi users to start creating their own addons.</description><br />
</source><br />
<br />
===== <disclaimer> =====<br />
<br />
One or more <code><disclaimer></code> elements that indicate what (if any) things the user should know about the add-on. There is no need to have a disclaimer if you don't want one, though if something requires settings, or only works in a particular country then you may want to state this here. It may be translated into multiple languages.<br />
<br />
<source lang="xml"><br />
<disclaimer lang="en_GB">Feel free to use this script. For information visit the wiki.</disclaimer><br />
</source><br />
<br />
===== <news> =====<br />
<br />
{{note|Used in Kodi v17 Krypton and later only. Older versions are forward compatible.}}<br />
<br />
The <code><news></code> element should contains a simple description of the major changes made to the add-on (new functionality, big fixes, etc). This is displayed in the Kodi addon installation/update system. (In the author's opinion, too many add-ons skip this piece of information, making it difficult for users to determine whether a particular problem that they may have been having has been fixed or not.)<br />
Please keep it short (it's limited to 1500 characters), you might want to only include the changes for the last version here.<br />
<br />
Here is an example: <br />
<br />
<source lang="xml"><br />
<news>v0.1.2 (2014-1-15)<br />
- Added notification for Ubuntu users checking through apt command</news><br />
</source><br />
<br />
===== <platform> =====<br />
<br />
The <code><platform></code> tag specifies which platforms (operating systems, hardware, architecture) this add-on runs on. Many add-ons will run on all platforms, so <code>all</code> is an option. If the platform tag is missing, we assume the add-on runs on all platforms. A combination of these is also possible. Currently available options are:<br />
<br />
* <code>all</code><br />
* <code>linux</code><br />
* <code>osx</code><br />
* <code>osx64</code><br />
* <code>osx-x86_64</code><br />
* <code>osx32</code><br />
* <code>osx-i686</code><br />
* <code>ios</code><br />
* <code>ios-armv7</code><br />
* <code>ios-aarch64</code><br />
* <code>windx</code><br />
* <code>windows</code><br />
* <code>windows-i686</code><br />
* <code>windows-x86_64</code><br />
* <code>windowsstore</code><br />
* <code>android</code><br />
* <code>android-armv7</code><br />
* <code>android-aarch64</code><br />
* <code>android-i686</code><br />
<br />
{{note|Kodi v19 Matrix and later.}}<br />
<br />
* <code>tvos</code><br />
* <code>tvos-aarch64</code><br />
<br />
<source lang="xml"><br />
<platform>all</platform><br />
</source><br />
<br />
===== <language> =====<br />
<br />
The <code><language></code> elements indicate the language(s) of the ''content'' provided by your add-on. It applies to plugins, scripts, scrapers etc. This allows browsing the add-on list by language. When there is no specific language provided in your content, omit it from the addon.xml.<br />
<br />
<source lang="xml"><br />
<language>en de fr</language><br />
</source><br />
<br />
===== <license> =====<br />
<br />
The <code><license></code> element indicates what license is used for this add-on. In general, the [https://spdx.org/licenses/ SPDX identifier] for the license is advised when compared to the full license name:<br />
<br />
<source lang="xml"><br />
<license>GPL-2.0-or-later</license> <!-- SPDX identifier --><br />
</source><br />
<br />
vs<br />
<br />
<source lang="xml"><br />
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license> <!-- Full license name --><br />
</source><br />
<br />
===== <forum> =====<br />
<br />
The <code><forum></code> element provides the forum thread URL for this specific add-on. Leave this blank if there is no forum thread.<br />
<source lang="xml"><br />
<forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum><br />
</source><br />
<br />
===== <website> =====<br />
<br />
The <code><website></code> element provides the website URL for this specific add-on.<br />
<br />
<source lang="xml"><br />
<website>http://www.myaddonwebsite.com/</website><br />
</source><br />
<br />
===== <nowiki><source></nowiki> =====<br />
<br />
The <code><nowiki><source></nowiki></code> element provides the URL for the source code for this specific add-on.<br />
<syntaxhighlight lang="xml" enclose="div"><br />
<source>http://github.com/someone/myaddon</source><br />
</syntaxhighlight><br />
<br />
===== <email> =====<br />
<br />
The <code><email></code> element provides the email address of the author if he wishes to do so for this specific add-on. Here are two examples of how you can make it look (the second one it harder for spambots to use). This can be left blank if you do not want to make your email address public.<br />
<source lang="xml"><br />
<email>foo@bar.com</email><br />
or<br />
<email>foo at bar dot com</email><br />
</source><br />
<br />
===== <lifecyclestate> =====<br />
<br />
{{note|Kodi v19 Matrix and later.}}<br />
<br />
The <code><lifecyclestate></code> tag will mark the add-on as broken or deprecated in the Kodi repo and provide the reason why. A dialog will be presented to every user that has the addon installed, so please try to be specific about the related reason. Also, the lifecyclestate tag presupposes that a version bump has been made to the addon.<br />
<br />
<source lang="xml"><br />
<lifecyclestate type="deprecated">Description why deprecated</lifecyclestate><br />
</source><br />
<br />
It can also optionally be translated into several languages.<br />
<source lang="xml"><br />
<lifecyclestate type="broken" lang="en_GB">Description why broken</lifecyclestate><br />
</source><br />
<br />
Possible types for here:<br />
{| class="prettytable"<br />
| '''broken'''<br />
| To mark addon as broken and no more usable.<br />
|- <br />
| '''deprecated'''<br />
| To mark addon as deprected and to have e.g. replaced by another addon.<br />
|- <br />
| '''normal'''<br />
| To set addon as normal. This value is not really needed, only available to be able to declare all possible life paths.<br />
|}<br />
<br />
===== <broken> =====<br />
<br />
{{note|Kodi v18 Leia and earlier. For matrix and later, see [[Addon.xml#.3Clifecyclestate.3E|lifecyclestate]]}}<br />
<br />
The <code><broken></code> tag will mark the add-on as broken in the Kodi repo and provide the reason why. A dialog will be presented to every user that has the addon installed, so please try to be specific about the broken reason. Also, the broken tag presupposes that a version bump has been made to the addon.<br />
<br />
<source lang="xml"><br />
<broken>deprecated</broken><br />
</source><br />
<br />
===== <assets> =====<br />
<br />
{{note|Kodi v17 Krypton and later.}}<br />
<br />
The <code><assets></code> element is a manifest that describes the various assets the add-on provides and where they are located. Supported sub-elements (some optional) are:<br />
<br />
* <code><icon></code> See [[Add-on_structure#icon_png_element|icon.png]] - if an icon.png file exists it must be listed here (mandatory since Kodi v17 Krypton)<br />
* <code><fanart></code> See [[Add-on_structure#fanart_jpg_element|fanart.jpg]] - if a fanart.jpg file exists it must be listed here (mandatory since Kodi v17 Krypton)<br />
* <code><screenshot></code> See [[Add-on_structure#screenshot_specifications|screenshots]] - '''(optional)''' <br />
<br />
{{note|Kodi v18 Leia and later.}}<br />
<br />
* <code><banner></code> See [[Add-on_structure#banner_element|banner.jpg]] - '''(optional)'''<br />
* <code><clearlogo></code> See [[Add-on_structure#clearlogo_element|clearlogo.png]] - '''(optional)'''<br />
<br />
If some elements are empty or not specified, it will be treated as non-existing/not provided. From all the above items, only icon and fanart are mandatory for addons since Kodi v17 Krypton and later.<br />
<br />
Example:<br />
<source lang="xml"><br />
<assets><br />
<icon>resources/icon.png</icon><br />
<fanart>resources/fanart.jpg</fanart><br />
<banner>resources/banner.jpg</banner><br />
<clearlogo>resources/clearlogo.png</clearlogo><br />
<screenshot>resources/screenshot-01.jpg</screenshot><br />
<screenshot>resources/screenshot-02.jpg</screenshot><br />
<screenshot>resources/screenshot-03.jpg</screenshot><br />
<screenshot>resources/screenshot-04.jpg</screenshot><br />
</assets><br />
</source><br />
<br />
With the above example definition, the files must be placed in the <code>resources</code> folder.<br />
<br />
===== <reuselanguageinvoker> =====<br />
{{note|Kodi v18 Leia and later.}}<br />
<br />
The <code><reuselanguageinvoker></code> element is a feature introduced with Kodi 18.0 that changes the way the python invoker works in Kodi - trying to reuse the invoker instances as much as possible. As a result, the addon performance is greatly improved. However, note that for the element to work some changes may be required in your addon. Namely, since the invoker is reused, make sure <code>sys.argv</code> is always passed to your entrypoint and propagated throughout your codebase. Do not store it as a class variable.<br />
<br />
<source lang="xml"><br />
<reuselanguageinvoker>true</reuselanguageinvoker><br />
</source><br />
<br />
Furthermore, it is advised to set this element to <code>false</code> while developing the addon, making it only <code>true</code> for the production version (and after testing).<br />
<br />
== Skin specific elements ==<br />
=== Overview ===<br />
{| class="prettytable"<br />
| '''effectslowdown'''<br />
| A multiplier that is applied to all <animation> effect lengths in the skin. Useful to slow down all animations globally so that you can better configure timings and see interactions between animating controls.<br />
|- <br />
| '''debugging'''<br />
| When set to true, it'll display onscreen debug information (xml filename, mouse position and focused control type and name) in the skin.<br />
|- <br />
| '''res'''<br />
| Support for arbitrary skin resolutions.<br />
|}<br />
<br />
=== How window xml files are found ===<br />
<br />
Kodi can run in many differing resolutions, and a skin should try and cater to all these resolutions. The easiest way is to develop for one specific resolution and make sure that all controls contain <width> and <height> tags. That way, Kodi can scale the controls to the new screen resolution.<br />
<br />
However, you may choose to develop alternative window xml files for differing resolutions (such as for HDTV resolutions, or for widescreen versus 4x3 resolutions).<br />
<br />
The order that Kodi looks for it's skin files are as follows:<br />
<br />
# It first looks in the current screenmode folder (one of 1080i, 720p, NTSC16x9, NTSC, PAL16x9 or PAL)<br />
# If the current screenmode is 1080i and there's no 1080i folder, it then looks in the 720p folder.<br />
# Finally, it looks in the '''res''' folder.<br />
<br />
This allows you to just put any window files that do not require special treatment for 16x9 resolutions etc. in the <defaultresolution> folder, preventing needless repetition.<br />
<br />
= Examples =<br />
<br />
== addon.xml for skins ==<br />
<br />
<syntaxhighlight lang="xml" enclose="div"><br />
<?xml version="1.0" encoding="UTF-8"?><br />
<addon id="skin.estuary" version="2.0.22" name="Estuary" provider-name="phil65, Ichabod Fletchman"><br />
<requires><br />
<import addon="xbmc.gui" version="5.14.0"/><br />
</requires><br />
<extension point="xbmc.gui.skin" debugging="false"><br />
<res width="1920" height="1440" aspect="4:3" default="false" folder="xml" /><br />
<res width="1920" height="1280" aspect="3:2" default="false" folder="xml" /><br />
<res width="1920" height="1200" aspect="16:10" default="false" folder="xml" /><br />
<res width="2040" height="1080" aspect="17:9" default="false" folder="xml" /><br />
<res width="1920" height="1080" aspect="16:9" default="true" folder="xml" /><br />
<res width="2560" height="1080" aspect="21:9" default="false" folder="xml" /><br />
<res width="2338" height="1080" aspect="19.5:9" default="false" folder="xml" /><br />
<res width="2160" height="1080" aspect="18:9" default="false" folder="xml" /><br />
</extension><br />
<extension point="xbmc.addon.metadata"><br />
<summary lang="en_GB">Estuary skin by phil65. (Kodi's default skin)</summary><br />
<description lang="en_GB">Estuary is the default skin for Kodi 17.0 and above. It attempts to be easy for first time Kodi users to understand and use.</description><br />
<disclaimer lang="en_GB">Estuary is the default skin for Kodi, removing it may cause issues</disclaimer><br />
<platform>all</platform><br />
<license>CC-BY-4.0, GPL-2.0-or-later</license><br />
<forum>http://forum.kodi.tv/</forum><br />
<source>https://github.com/xbmc/skin.estuary/</source><br />
<assets><br />
<icon>resources/icon.png</icon><br />
<fanart>resources/fanart.jpg</fanart><br />
<screenshot>resources/screenshot-01.jpg</screenshot><br />
<screenshot>resources/screenshot-02.jpg</screenshot><br />
<screenshot>resources/screenshot-03.jpg</screenshot><br />
<screenshot>resources/screenshot-04.jpg</screenshot><br />
<screenshot>resources/screenshot-05.jpg</screenshot><br />
<screenshot>resources/screenshot-06.jpg</screenshot><br />
<screenshot>resources/screenshot-07.jpg</screenshot><br />
<screenshot>resources/screenshot-08.jpg</screenshot><br />
</assets><br />
</extension><br />
</addon><br />
</syntaxhighlight><br />
One thing to note is that <font color="red">all tag names are lower case.</font> XML tag names are case sensitive!<br />
<br />
== addon.xml for scripts ==<br />
<br />
<syntaxhighlight lang="xml" enclose="div"><br />
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><br />
<addon<br />
id="script.artwork.downloader"<br />
name="Artwork Downloader"<br />
version="12.0.12"<br />
provider-name="Martijn"><br />
<requires><br />
<import addon="xbmc.python" version="2.25.0"/><br />
<import addon="script.module.elementtree" version="1.2.7"/><br />
<import addon="script.module.simplejson" version="2.0.10" optional="true"/><br />
<import addon="script.common.plugin.cache" version="1.3.0"/><br />
</requires><br />
<extension point="xbmc.python.script" library="default.py"><br />
<provides>executable</provides><br />
</extension><br />
<extension point="xbmc.service" library="service.py" start="login"/><br />
<extension point="xbmc.addon.metadata"><br />
<summary lang="en_GB">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary><br />
<description lang="en_GB">Downloads all available artwork for TV shows, Movies and Musicvideos in your library. Check the options for supported artwork[CR]Artwork sources:[CR]www.fanart.tv[CR]www.thetvdb.com[CR]www.themoviedb.org[CR]Remark:[CR]Check your skin to see what type of artwork is supported![CR]Each TV Show/Movie must have its own folder![CR]Skin integration:[CR]See readme file</description><br />
<disclaimer lang="en_GB">For bugs, requests or general questions visit the Artwork Downloader thread on the Kodi forum.</disclaimer><br />
<platform>all</platform><br />
<license>GPL-2.0-or-later</license><br />
<forum>...</forum><br />
<website>...</website><br />
<email>...</email><br />
<source>...</source><br />
<news><br />
v12.0.12:<br />
- Changes ....<br />
</news><br />
<assets><br />
<icon>resources/images/icon.png</icon><br />
<fanart>resources/images/fanart.png</fanart><br />
<screenshot>resources/images/screenshot.png</screenshot><br />
</assets><br />
</extension><br />
</addon><br />
</syntaxhighlight><br />
<br />
=== Common errors ===<br />
<br />
If you are getting errors when installing your Kodi addon, then you may have errors in your addon.xml file, which could be any of the following:<br />
<br />
# Invalid characters - does any of your description text, addon name, etc. have any of the following? !, ?, -, etc<br />
# Too large description can sometimes cause issues<br />
# You may have an opening tag but not a closing tag further in the file e.g. <description> but not later on </description><br />
# If you have directly updated your code and are still finding errors which you know you have fixed, it's possible your cache is still holding the previous version. Try clearing contents of the following folders (or if this fails, reboot your Kodi device):<br />
* .kodi/addons/temp<br />
* .kodi/temp/temp<br />
* .kodi/temp/archive_cache<br />
<br />
= Schema Definition =<br />
<br />
The XML schema definition for <code>addon.xml</code> is located [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.addon/metadata.xsd here].<br />
<br />
{{Leia updated}}<br />
<br />
[[Category:Add-on development]]<br />
[[Category:Skin development]]</div>Alwinushttps://kodi.wiki/index.php?title=Addon.xml&diff=224890Addon.xml2021-03-08T13:40:45Z<p>Alwinus: </p>
<hr />
<div>{{mininav|[[Development]]|[[Add-on development]]}}<br />
{{TOC right}}<br />
<br /><br />
<br />
Every skin, script, or plugin in Kodi contains an <code>addon.xml</code> file which describes the add-on, providing credits, version information and dependencies. Below, we will explain how this file is structured and which elements must be used to create an add-on for Kodi. You can also consult the examples at the end to see how this file is laid out depending on if you are developing a skin or script.<br />
<br />
Every <code>addon.xml</code> file has the same basic structure, this example is for a video plugin:<br />
<br />
<syntaxhighlight lang="xml" enclose="div"><br />
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><br />
<addon id="plugin.addon.id" name="Your Add-on" version="1.2.3" provider-name="You"><br />
<requires><br />
<import addon="xbmc.python" version="2.25.0"/><br />
</requires><br />
<extension point="xbmc.python.pluginsource" library="addon.py"><br />
<provides>video</provides><br />
</extension><br />
<extension point="xbmc.addon.metadata"><br />
<summary lang="en_GB">Your add-on's summary</summary><br />
<description lang="en_GB">Your add-on's description</description><br />
<disclaimer lang="en_GB"></disclaimer><br />
<language>en</language> <!-- the language of the videos or other content the plugin provides, may be omitted in case the addon does not provide any content --><br />
<platform>all</platform><br />
<license>GPL-2.0-or-later</license><br />
<forum>https://forum.kodi.tv/showthread.php?tid=xxxx</forum> <!-- may be omitted --><br />
<website>http://myplugin.com</website> <!-- the url of the website that contains the videos (or the official website of your plugin). May be omitted. --><br />
<email>you@youremail.com</email> <!-- may be omitted --><br />
<source>http://github.com/you/plugin.addon.id</source><br />
<news>v1.2.3 (01/02/201x)<br />
[new] some new feature<br />
[fix] some fix<br />
</news><br />
<assets><br />
<icon>resources/icon.png</icon><br />
<fanart>resources/fanart.jpg</fanart><br />
<banner></banner> <!-- optional --><br />
<clearlogo>resources/clearlogo.png</clearlogo> <!-- optional --><br />
<screenshot></screenshot> <!-- optional, max 10 --><br />
</assets><br />
</extension><br />
</addon><br />
</syntaxhighlight><br />
<br />
There are a few important things to note in the above sample:<br />
<br />
* The <code><addon></code> element must be present, and be the root node. It presents data about the add-on package as a whole.<br />
* Inside the <code><addon></code> element is a <code><requires></code> element, listing all the dependencies that this add-on needs in order to function.<br />
* Then there are one or more <code><extension></code> elements, each of which describes a part of Kodi that the add-on extends.<br />
* Finally, there is a specific <code><extension></code> element that extends <code>"xbmc.addon.metadata"</code>. This describes the add-on to the user.<br />
* Banners and clearlogos assets exclusive to Kodi v.18+<br />
= Elements =<br />
<br />
== <addon> ==<br />
<br />
The <code><addon></code> element has 4 attributes, all required: <code>id</code>, <code>version</code>, <code>name</code>, and <code>provider-name</code>. For example:<br />
<br />
<source lang="xml"><br />
<addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2"><br />
</source><br />
<br />
=== id attribute ===<br />
<br />
The id attribute is the unique identifier used for this add-on. It must be unique, and must use only lowercase characters, periods, underscores, dashes and numbers. This identifier is also used as the name of the folder that contains the add-on, so for ease of searching, we suggest you use something like <type>.<uniquename>.<br />
<br />
=== version attribute ===<br />
<br />
The version attribute is used by Kodi to determine whether updates are available. This should be use a version scheme like <code>x.y.z</code> (major.minor.patch). For example: <code>version="0.0.1"</code>. Generally, you'll start with a version of <code>0.y.z</code> for test releases and once you feel it is ready for a full release, you'd bump the version to <code>1.0.0</code>.<br />
<br />
==== How versioning works ====<br />
<br />
* <code>2.2.9</code> is newer than <code>2.2.1</code><br />
* <code>2.2.10</code> is newer than <code>2.2.1</code><br />
* <code>2.3.0</code> is newer than <code>2.2.9</code><br />
* <code>2.2.1</code> is newer than <code>2.2.1~alpha</code><br />
* <code>2.2.1</code> is newer than <code>2.2.1~beta</code><br />
* <code>2.2.1~beta</code> is newer than <code>2.2.1~alpha</code><br />
* <code>2.2.1~beta3</code> is newer than <code>2.2.1~beta2</code><br />
* <code>2.2.1~beta10</code> is newer than <code>2.2.1~beta1</code><br />
<br />
{{tip|Text should only be added for a beta version. In other cases version number should only contain numbers.}}<br />
<br />
=== name attribute ===<br />
<br />
The name attribute is the name of the add-on as it appears in the UI. This should be in English where it makes sense for it to be so, and is not translatable.<br />
<br />
=== provider-name attribute ===<br />
<br />
The provider-name attribute is used as the author field. This could be a team of authors or a single author. If the add-on is maintained by multiple people please separate them with a comma (<code>,</code>).<br />
<br />
== <requires> ==<br />
<br />
The <code><requires></code> element contains one or more <code><import></code> elements which specify which other add-ons this particular add-on requires, and which version of those add-ons it requires. These add-ons may be part of Kodi itself, or may be parts of other third-party add-ons.<br />
<br />
Kodi will only allow the add-on to be run if suitable versions of the (non-optional) add-ons on which this add-on depends are installed. When a user installs your add-on from an online repository via Kodi's add-on manager, Kodi attempts to resolve these dependencies, and install anything that your add-on relies on first. The dependency must be provided with the minimum version number your script/skin requires.<br />
<br />
=== Examples ===<br />
<br />
Here is a sample <code><requires></code> block that imports two required modules:<br />
<br />
<source lang="xml"><br />
<requires><br />
<import addon="xbmc.python" version="2.25.0"/><br />
<import addon="script.module.elementtree" version="1.2.7"/><br />
</requires><br />
</source><br />
<br />
Here's another example, which will only install on LibreELEC. This occurs because the addon will depend on an addon that only exists in LibreELEC. Hence, Kodi will refuse to install the addon in other platforms due to unmet dependencies:<br />
<br />
<source lang="xml"><br />
<requires><br />
<import addon="os.librelec.tv" version="2.0"/><br />
</requires><br />
</source><br />
<br />
== <import> ==<br />
<br />
Each <code><import></code> element describes one dependency for an add-on, with two required attributes: <code>addon</code> and <code>version</code>. There is also an optional attribute called, fittingly, <code>optional</code>.<br />
<br />
If your add-on relies on other third-party add-ons, Kodi will automatically install them as well, provided they are available on an existing add-on repository. If they aren't available on any existing repository, the user must install the other add-ons themselves. Note that you need to include any Python libraries you need directly in your add-on; these can't be loaded with an <code><import></code> element, since Kodi wouldn't know what to do with them.<br />
<br />
=== addon attribute ===<br />
<br />
The <code>addon</code> attribute specifies the id of the required add-on, e.g. <code>script.module.elementtree</code>.<br />
<br />
=== version attribute ===<br />
<br />
The <code>version</code> attribute specifies the minimum version of the required add-on to be installed.<br />
<br />
==== Dependency versions ====<br />
<br />
Each different Kodi version might require you to use a higher version of the <code>xbmc.*</code> add-on dependencies to control on which version of Kodi the add-on can be installed.<br />
<br />
{| class="prettytable" border="1"<br />
|+ Current versions<br />
! Kodi version !! xbmc.python !! xbmc.gui !! xbmc.json !! xbmc.metadata !! xbmc.addon<br />
|-<br />
| Dharma 10.1 <font color="red">Deprecated</font>|| 1.0 || 2.11 || 2.0|| 1.0 || 0.1<br />
|-<br />
| Eden 11.0 <font color="red">Deprecated</font> || 2.0 || 3.0 || 4.0 || 1.0 || 11.0<br />
|-<br />
| Frodo 12.x <font color="red">Deprecated</font>|| 2.1.0 || 4.0.0 || 6.0.0 || 2.1.0 || 12.0.0<br />
|-<br />
| Gotham 13.x || 2.14.0 (ABI 2.1.0) || 5.0.1 || 6.6.0 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 13.0.0 (ABI 12.0.0)<br />
|-<br />
| Helix 14.x || 2.19.0 (ABI 2.1.0) || 5.3.0 || 6.20.0 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 14.0.0 (ABI 12.0.0)<br />
|-<br />
| Isengard 15.x || 2.20.0 (ABI 2.1.0) || 5.9.0 (ABI 5.3.0) || 6.25.1 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 15.0.0 (ABI 12.0.0)<br />
|-<br />
| Jarvis 16.x || 2.24.0 (ABI 2.1.0) || 5.10.0 || 6.32.4 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 16.0.0 (ABI 12.0.0)<br />
|-<br />
| Krypton 17.x || 2.25.0 (ABI 2.1.0) || 5.12.0 || 7.0.0 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 17.0.0 (ABI 12.0.0)<br />
|-<br />
| Leia 18.x || 2.26.0 (ABI 2.1.0) || 5.14.0 || 9.7.2 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 17.9.910 (ABI 12.0.0)<br />
|-<br />
| Matrix 19.x || 3.0.0 (ABI 3.0.0) || 5.15.0 (ABI 5.14.0) || 11.2.0 (ABI 6.0.0) || 2.1.0 (ABI 1.0) || 18.9.701 (ABI 12.0.0)<br />
|}<br />
<br />
Each Kodi version contain a certain backwards compatibility. For example add-ons made for Gotham 13.x can still work ion Jarvis 16.x. Do note that this might change in the future. The '''ABI''' version you see in the table above is the backwards compatibility version for which add-ons are still marked "working".<br />
<br />
=== optional attribute ===<br />
<br />
The dependency may be made optional by setting the <code>optional</code> attribute to <code>true</code>. This will only install the dependency when the add-on actually needs it. Even if this dependency is missing, the add-on can still be installed.<br />
<br />
== <extension> ==<br />
<br />
The <code><extension></code> element describes the technical aspects of this add-on. It will have at least a point attribute which will give the part of Kodi that the add-on extends. For instance, the <code>addon.xml</code> file for the Confluence skin extends the <code>xbmc.gui.skin</code> part of xbmc. All available extension points are given below.<br />
<br />
The various extension points that Kodi provides are given in the list below.<br />
{| class="prettytable"<br />
!Extension point<br />
!Add-on Category<br />
|-<br />
|<code>[[Skinning|xbmc.gui.skin]]</code><br />
|Skin<br />
|-<br />
|<code>xbmc.webinterface</code><br />
|Web interface<br />
|-<br />
|<code>[[Add-on repositories|xbmc.addon.repository]]</code><br />
|''None''<br />
|-<br />
|<code>[[Service_add-ons|xbmc.service]]</code><br />
|Services<br />
|-<br />
|<code>xbmc.metadata.scraper.albums</code><br />
|Album information<br />
|-<br />
|<code>xbmc.metadata.scraper.artists</code><br />
|Artist information<br />
|-<br />
|<code>xbmc.metadata.scraper.movies</code><br />
|Movie information<br />
|-<br />
|<code>xbmc.metadata.scraper.musicvideos</code><br />
|Music video information<br />
|-<br />
|<code>xbmc.metadata.scraper.tvshows</code><br />
|TV information<br />
|-<br />
|<code>xbmc.metadata.scraper.library</code><br />
|''None''<br />
|-<br />
|<code>xbmc.ui.screensaver</code><br />
|Screensaver<br />
|-<br />
|<code>xbmc.player.musicviz</code><br />
|Visualization<br />
|-<br />
|<code>[[Plugin sources|xbmc.python.pluginsource]]</code><br />
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)<br />
|-<br />
|<code>[[Script_sources|xbmc.python.script]]</code><br />
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)<br />
|-<br />
|<code>xbmc.python.weather</code><br />
|Weather<br />
|-<br />
|<code>xbmc.subtitle.module</code><br />
|Subtitle service module<br />
|-<br />
|<code>[[Script_lyrics|xbmc.python.lyrics]]</code><br />
|Lyrics<br />
|-<br />
|<code>xbmc.python.library</code><br />
|These don't show up in the addon browser and are purely as support for other scripts.<br />
|-<br />
|<code>xbmc.python.module</code><br />
|Provides an additional python library. mainly for use in script.module.* addons.<br />
|-<br />
|<code>xbmc.addon.video</code><br />
|Video Add-ons (video)<br />
|-<br />
|<code>xbmc.addon.audio</code><br />
|Music Add-ons (audio)<br />
|-<br />
|<code>xbmc.addon.image</code><br />
|Picture Add-ons (image)<br />
|-<br />
|<code>kodi.resource.font</code><br />
|Additional font files<br />
|-<br />
|<code>kodi.resource.images</code><br />
|Additional image files<br />
|-<br />
|<code>kodi.resource.language</code><br />
|Additional language files<br />
|-<br />
|<code>kodi.resource.uisounds</code><br />
|Additional sound files<br />
|}<br />
<br />
Add-ons that don't correspond to a specific add-on category can not be installed by users. These are usually supporting or shared add-ons that are installed automatically by the add-ons that require them.<br />
<br />
=== xbmc.python.pluginsource ===<br />
{{See also|Plugin sources}}<br />
<br />
The most common extension point that will be used by plugin addon developers is <code>xbmc.python.pluginsource</code>.<br />
<br />
==== library attribute ====<br />
<br />
The <code><extension point="xbmc.python.pluginsource"></code> element has an extra attribute: <code>library</code>. This is the name of the Python script (startup script) that will be run when the add-on is activated. This file must exist in the root of your add-on directory.<br />
<br />
==== <provides> element ====<br />
<br />
The extension has an additional child element named <code><provides></code>, which contains a whitespace separated list of <code>image</code>, <code>video</code>, <code>audio</code>, and/or <code>executable</code>. This determines in what area (or context) of the Kodi system your addon will make itself visible in (please note that this applies only to plugin extension points):<br />
<br />
{| class="prettytable"<br />
!Provides<br />
!Appears in<br />
|-<br />
|<code>image</code><br />
|Pictures<br />
|-<br />
|<code>audio</code><br />
|Music<br />
|-<br />
|<code>video</code><br />
|Video<br />
|-<br />
|<code>executable</code><br />
|Programs<br />
|-<br />
|''(blank)''<br />
|See Note<br />
|}<br />
<br />
{{Note|If the '''<provides>''' element is not defined, behaviour will depend on the structure of your addon. If it has a single extension point (e.g. a single '''xbmc.python.script''' or '''xbmc.python.pluginsource'''), kodi will default to "executable" (thus your addon will be shown in programs). If your addon has multiple extension points and none specifies a '''<provides>''' element, different entries for your addon will be shown in "programs" (multiple fallbacks to "executable"). If your addon has multiple extension points and only one (or some) define the '''<provides>''' tag it really depends on the order of the extension points. If the first extension point (your addon '''main extension point''') defines the '''<provides>''' element, kodi will assume all the other (empty) extension points provide the same content. Otherwise it will set the content for all the extension points that specify the '''<provides>''' tag and fallback all the others to "executable". '''At the moment, there is no way to hide an addon from the interface.''' |reminder}}<br />
<br />
==== Example ====<br />
<br />
<source lang="xml"><br />
<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py"><br />
<provides>audio video</provides><br />
</extension><br />
</source><br />
<br />
=== xbmc.addon.metadata ===<br />
<br />
This special extension point ''must'' be provided by all add-ons, and is the way that your add-on is described to users of the Kodi add-on manager.<br />
<br />
==== Available elements ====<br />
<br />
There are several elements that this should contain. Most of these elements are required (except the deprecated tag). However, in case the elements do not apply (e.g. language, website, email) they can be omitted from the addon.xml file. Language specific elements must always be present in English as a minimum.<br />
<br />
Many of these elements can be translated into multiple languages and should be added once for each supported language. The <code>lang</code> attribute should contain a [https://en.wikipedia.org/wiki/Locale_(computer_software) locale identifier]. If omitted, it defaults to en_GB. (Note: Kodi v14 and older uses ISO-639 code. See [[List of language codes (ISO-639:1988)]]).<br />
<br />
===== <summary> =====<br />
<br />
One or more <code><summary></code> elements provide a short summary of what the add-on does. This should be a single sentence. It may be translated into multiple languages.<br />
<br />
<source lang="xml"><br />
<summary lang="en_GB">Hello World script provides some basic examples on how to create your first script.</summary><br />
</source><br />
<br />
===== <description> =====<br />
<br />
One or more <code><description></code> elements provide a more detailed summary of what the add-on does. It may be translated into multiple languages.<br />
<br />
<source lang="xml"><br />
<description lang="en_GB">Hello World script provides some basic examples on how to create your first script<br />
and hopefully will increase the number of Kodi users to start creating their own addons.</description><br />
</source><br />
<br />
===== <disclaimer> =====<br />
<br />
One or more <code><disclaimer></code> elements that indicate what (if any) things the user should know about the add-on. There is no need to have a disclaimer if you don't want one, though if something requires settings, or only works in a particular country then you may want to state this here. It may be translated into multiple languages.<br />
<br />
<source lang="xml"><br />
<disclaimer lang="en_GB">Feel free to use this script. For information visit the wiki.</disclaimer><br />
</source><br />
<br />
===== <news> =====<br />
<br />
{{note|Used in Kodi v17 Krypton and later only. Older versions are forward compatible.}}<br />
<br />
The <code><news></code> element should contains a simple description of the major changes made to the add-on (new functionality, big fixes, etc). This is displayed in the Kodi addon installation/update system. (In the author's opinion, too many add-ons skip this piece of information, making it difficult for users to determine whether a particular problem that they may have been having has been fixed or not.)<br />
Please keep it short (it's limited to 1500 characters), you might want to only include the changes for the last version here.<br />
<br />
Here is an example: <br />
<br />
<source lang="xml"><br />
<news>v0.1.2 (2014-1-15)<br />
- Added notification for Ubuntu users checking through apt command</news><br />
</source><br />
<br />
===== <platform> =====<br />
<br />
The <code><platform></code> tag specifies which platforms (operating systems, hardware, architecture) this add-on runs on. Many add-ons will run on all platforms, so <code>all</code> is an option. If the platform tag is missing, we assume the add-on runs on all platforms. A combination of these is also possible. Currently available options are:<br />
<br />
* <code>all</code><br />
* <code>linux</code><br />
* <code>osx</code><br />
* <code>osx64</code><br />
* <code>osx-x86_64</code><br />
* <code>osx32</code><br />
* <code>osx-i686</code><br />
* <code>ios</code><br />
* <code>ios-armv7</code><br />
* <code>ios-aarch64</code><br />
* <code>windx</code><br />
* <code>windows</code><br />
* <code>windows-i686</code><br />
* <code>windows-x86_64</code><br />
* <code>windowsstore</code><br />
* <code>android</code><br />
* <code>android-armv7</code><br />
* <code>android-aarch64</code><br />
* <code>android-i686</code><br />
<br />
{{note|Kodi v19 Matrix and later.}}<br />
<br />
* <code>tvos</code><br />
* <code>tvos-aarch64</code><br />
<br />
<source lang="xml"><br />
<platform>all</platform><br />
</source><br />
<br />
===== <language> =====<br />
<br />
The <code><language></code> elements indicate the language(s) of the ''content'' provided by your add-on. It applies to plugins, scripts, scrapers etc. This allows browsing the add-on list by language. When there is no specific language provided in your content, omit it from the addon.xml.<br />
<br />
<source lang="xml"><br />
<language>en de fr</language><br />
</source><br />
<br />
===== <license> =====<br />
<br />
The <code><license></code> element indicates what license is used for this add-on. In general, the [https://spdx.org/licenses/ SPDX identifier] for the license is advised when compared to the full license name:<br />
<br />
<source lang="xml"><br />
<license>GPL-2.0-or-later</license> <!-- SPDX identifier --><br />
</source><br />
<br />
vs<br />
<br />
<source lang="xml"><br />
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license> <!-- Full license name --><br />
</source><br />
<br />
===== <forum> =====<br />
<br />
The <code><forum></code> element provides the forum thread URL for this specific add-on. Leave this blank if there is no forum thread.<br />
<source lang="xml"><br />
<forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum><br />
</source><br />
<br />
===== <website> =====<br />
<br />
The <code><website></code> element provides the website URL for this specific add-on.<br />
<br />
<source lang="xml"><br />
<website>http://www.myaddonwebsite.com/</website><br />
</source><br />
<br />
===== <nowiki><source></nowiki> =====<br />
<br />
The <code><nowiki><source></nowiki></code> element provides the URL for the source code for this specific add-on.<br />
<syntaxhighlight lang="xml" enclose="div"><br />
<source>http://github.com/someone/myaddon</source><br />
</syntaxhighlight><br />
<br />
===== <email> =====<br />
<br />
The <code><email></code> element provides the email address of the author if he wishes to do so for this specific add-on. Here are two examples of how you can make it look (the second one it harder for spambots to use). This can be left blank if you do not want to make your email address public.<br />
<source lang="xml"><br />
<email>foo@bar.com</email><br />
or<br />
<email>foo at bar dot com</email><br />
</source><br />
<br />
===== <lifecyclestate> =====<br />
<br />
{{note|Kodi v19 Matrix and later.}}<br />
<br />
The <code><lifecyclestate></code> tag will mark the add-on as broken or deprecated in the Kodi repo and provide the reason why. A dialog will be presented to every user that has the addon installed, so please try to be specific about the related reason. Also, the lifecyclestate tag presupposes that a version bump has been made to the addon.<br />
<br />
<source lang="xml"><br />
<lifecyclestate type="deprecated">Description why deprecated</lifecyclestate><br />
</source><br />
<br />
It can also optionally be translated into several languages.<br />
<source lang="xml"><br />
<lifecyclestate type="broken" lang="en_GB">Description why broken</lifecyclestate><br />
</source><br />
<br />
Possible types for here:<br />
{| class="prettytable"<br />
| '''broken'''<br />
| To mark addon as broken and no more usable.<br />
|- <br />
| '''deprecated'''<br />
| To mark addon as deprected and to have e.g. replaced by another addon.<br />
|- <br />
| '''normal'''<br />
| To set addon as normal. This value is not really needed, only available to be able to declare all possible life paths.<br />
|}<br />
<br />
===== <broken> =====<br />
<br />
{{note|Kodi v18 Leia and earlier. For matrix and later, see [[Addon.xml#lifecyclestate|lifecyclestate]]}}<br />
<br />
The <code><broken></code> tag will mark the add-on as broken in the Kodi repo and provide the reason why. A dialog will be presented to every user that has the addon installed, so please try to be specific about the broken reason. Also, the broken tag presupposes that a version bump has been made to the addon.<br />
<br />
<source lang="xml"><br />
<broken>deprecated</broken><br />
</source><br />
<br />
===== <assets> =====<br />
<br />
{{note|Kodi v17 Krypton and later.}}<br />
<br />
The <code><assets></code> element is a manifest that describes the various assets the add-on provides and where they are located. Supported sub-elements (some optional) are:<br />
<br />
* <code><icon></code> See [[Add-on_structure#icon_png_element|icon.png]] - if an icon.png file exists it must be listed here (mandatory since Kodi v17 Krypton)<br />
* <code><fanart></code> See [[Add-on_structure#fanart_jpg_element|fanart.jpg]] - if a fanart.jpg file exists it must be listed here (mandatory since Kodi v17 Krypton)<br />
* <code><screenshot></code> See [[Add-on_structure#screenshot_specifications|screenshots]] - '''(optional)''' <br />
<br />
{{note|Kodi v18 Leia and later.}}<br />
<br />
* <code><banner></code> See [[Add-on_structure#banner_element|banner.jpg]] - '''(optional)'''<br />
* <code><clearlogo></code> See [[Add-on_structure#clearlogo_element|clearlogo.png]] - '''(optional)'''<br />
<br />
If some elements are empty or not specified, it will be treated as non-existing/not provided. From all the above items, only icon and fanart are mandatory for addons since Kodi v17 Krypton and later.<br />
<br />
Example:<br />
<source lang="xml"><br />
<assets><br />
<icon>resources/icon.png</icon><br />
<fanart>resources/fanart.jpg</fanart><br />
<banner>resources/banner.jpg</banner><br />
<clearlogo>resources/clearlogo.png</clearlogo><br />
<screenshot>resources/screenshot-01.jpg</screenshot><br />
<screenshot>resources/screenshot-02.jpg</screenshot><br />
<screenshot>resources/screenshot-03.jpg</screenshot><br />
<screenshot>resources/screenshot-04.jpg</screenshot><br />
</assets><br />
</source><br />
<br />
With the above example definition, the files must be placed in the <code>resources</code> folder.<br />
<br />
===== <reuselanguageinvoker> =====<br />
{{note|Kodi v18 Leia and later.}}<br />
<br />
The <code><reuselanguageinvoker></code> element is a feature introduced with Kodi 18.0 that changes the way the python invoker works in Kodi - trying to reuse the invoker instances as much as possible. As a result, the addon performance is greatly improved. However, note that for the element to work some changes may be required in your addon. Namely, since the invoker is reused, make sure <code>sys.argv</code> is always passed to your entrypoint and propagated throughout your codebase. Do not store it as a class variable.<br />
<br />
<source lang="xml"><br />
<reuselanguageinvoker>true</reuselanguageinvoker><br />
</source><br />
<br />
Furthermore, it is advised to set this element to <code>false</code> while developing the addon, making it only <code>true</code> for the production version (and after testing).<br />
<br />
== Skin specific elements ==<br />
=== Overview ===<br />
{| class="prettytable"<br />
| '''effectslowdown'''<br />
| A multiplier that is applied to all <animation> effect lengths in the skin. Useful to slow down all animations globally so that you can better configure timings and see interactions between animating controls.<br />
|- <br />
| '''debugging'''<br />
| When set to true, it'll display onscreen debug information (xml filename, mouse position and focused control type and name) in the skin.<br />
|- <br />
| '''res'''<br />
| Support for arbitrary skin resolutions.<br />
|}<br />
<br />
=== How window xml files are found ===<br />
<br />
Kodi can run in many differing resolutions, and a skin should try and cater to all these resolutions. The easiest way is to develop for one specific resolution and make sure that all controls contain <width> and <height> tags. That way, Kodi can scale the controls to the new screen resolution.<br />
<br />
However, you may choose to develop alternative window xml files for differing resolutions (such as for HDTV resolutions, or for widescreen versus 4x3 resolutions).<br />
<br />
The order that Kodi looks for it's skin files are as follows:<br />
<br />
# It first looks in the current screenmode folder (one of 1080i, 720p, NTSC16x9, NTSC, PAL16x9 or PAL)<br />
# If the current screenmode is 1080i and there's no 1080i folder, it then looks in the 720p folder.<br />
# Finally, it looks in the '''res''' folder.<br />
<br />
This allows you to just put any window files that do not require special treatment for 16x9 resolutions etc. in the <defaultresolution> folder, preventing needless repetition.<br />
<br />
= Examples =<br />
<br />
== addon.xml for skins ==<br />
<br />
<syntaxhighlight lang="xml" enclose="div"><br />
<?xml version="1.0" encoding="UTF-8"?><br />
<addon id="skin.estuary" version="2.0.22" name="Estuary" provider-name="phil65, Ichabod Fletchman"><br />
<requires><br />
<import addon="xbmc.gui" version="5.14.0"/><br />
</requires><br />
<extension point="xbmc.gui.skin" debugging="false"><br />
<res width="1920" height="1440" aspect="4:3" default="false" folder="xml" /><br />
<res width="1920" height="1280" aspect="3:2" default="false" folder="xml" /><br />
<res width="1920" height="1200" aspect="16:10" default="false" folder="xml" /><br />
<res width="2040" height="1080" aspect="17:9" default="false" folder="xml" /><br />
<res width="1920" height="1080" aspect="16:9" default="true" folder="xml" /><br />
<res width="2560" height="1080" aspect="21:9" default="false" folder="xml" /><br />
<res width="2338" height="1080" aspect="19.5:9" default="false" folder="xml" /><br />
<res width="2160" height="1080" aspect="18:9" default="false" folder="xml" /><br />
</extension><br />
<extension point="xbmc.addon.metadata"><br />
<summary lang="en_GB">Estuary skin by phil65. (Kodi's default skin)</summary><br />
<description lang="en_GB">Estuary is the default skin for Kodi 17.0 and above. It attempts to be easy for first time Kodi users to understand and use.</description><br />
<disclaimer lang="en_GB">Estuary is the default skin for Kodi, removing it may cause issues</disclaimer><br />
<platform>all</platform><br />
<license>CC-BY-4.0, GPL-2.0-or-later</license><br />
<forum>http://forum.kodi.tv/</forum><br />
<source>https://github.com/xbmc/skin.estuary/</source><br />
<assets><br />
<icon>resources/icon.png</icon><br />
<fanart>resources/fanart.jpg</fanart><br />
<screenshot>resources/screenshot-01.jpg</screenshot><br />
<screenshot>resources/screenshot-02.jpg</screenshot><br />
<screenshot>resources/screenshot-03.jpg</screenshot><br />
<screenshot>resources/screenshot-04.jpg</screenshot><br />
<screenshot>resources/screenshot-05.jpg</screenshot><br />
<screenshot>resources/screenshot-06.jpg</screenshot><br />
<screenshot>resources/screenshot-07.jpg</screenshot><br />
<screenshot>resources/screenshot-08.jpg</screenshot><br />
</assets><br />
</extension><br />
</addon><br />
</syntaxhighlight><br />
One thing to note is that <font color="red">all tag names are lower case.</font> XML tag names are case sensitive!<br />
<br />
== addon.xml for scripts ==<br />
<br />
<syntaxhighlight lang="xml" enclose="div"><br />
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><br />
<addon<br />
id="script.artwork.downloader"<br />
name="Artwork Downloader"<br />
version="12.0.12"<br />
provider-name="Martijn"><br />
<requires><br />
<import addon="xbmc.python" version="2.25.0"/><br />
<import addon="script.module.elementtree" version="1.2.7"/><br />
<import addon="script.module.simplejson" version="2.0.10" optional="true"/><br />
<import addon="script.common.plugin.cache" version="1.3.0"/><br />
</requires><br />
<extension point="xbmc.python.script" library="default.py"><br />
<provides>executable</provides><br />
</extension><br />
<extension point="xbmc.service" library="service.py" start="login"/><br />
<extension point="xbmc.addon.metadata"><br />
<summary lang="en_GB">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary><br />
<description lang="en_GB">Downloads all available artwork for TV shows, Movies and Musicvideos in your library. Check the options for supported artwork[CR]Artwork sources:[CR]www.fanart.tv[CR]www.thetvdb.com[CR]www.themoviedb.org[CR]Remark:[CR]Check your skin to see what type of artwork is supported![CR]Each TV Show/Movie must have its own folder![CR]Skin integration:[CR]See readme file</description><br />
<disclaimer lang="en_GB">For bugs, requests or general questions visit the Artwork Downloader thread on the Kodi forum.</disclaimer><br />
<platform>all</platform><br />
<license>GPL-2.0-or-later</license><br />
<forum>...</forum><br />
<website>...</website><br />
<email>...</email><br />
<source>...</source><br />
<news><br />
v12.0.12:<br />
- Changes ....<br />
</news><br />
<assets><br />
<icon>resources/images/icon.png</icon><br />
<fanart>resources/images/fanart.png</fanart><br />
<screenshot>resources/images/screenshot.png</screenshot><br />
</assets><br />
</extension><br />
</addon><br />
</syntaxhighlight><br />
<br />
=== Common errors ===<br />
<br />
If you are getting errors when installing your Kodi addon, then you may have errors in your addon.xml file, which could be any of the following:<br />
<br />
# Invalid characters - does any of your description text, addon name, etc. have any of the following? !, ?, -, etc<br />
# Too large description can sometimes cause issues<br />
# You may have an opening tag but not a closing tag further in the file e.g. <description> but not later on </description><br />
# If you have directly updated your code and are still finding errors which you know you have fixed, it's possible your cache is still holding the previous version. Try clearing contents of the following folders (or if this fails, reboot your Kodi device):<br />
* .kodi/addons/temp<br />
* .kodi/temp/temp<br />
* .kodi/temp/archive_cache<br />
<br />
= Schema Definition =<br />
<br />
The XML schema definition for <code>addon.xml</code> is located [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.addon/metadata.xsd here].<br />
<br />
{{Leia updated}}<br />
<br />
[[Category:Add-on development]]<br />
[[Category:Skin development]]</div>Alwinushttps://kodi.wiki/index.php?title=User:Alwinus&diff=183875User:Alwinus2019-10-06T14:23:19Z<p>Alwinus: </p>
<hr />
<div>=alwinus=<br />
===Team-KODI Developer===<br />
{|<br />
|-<br />
| '''Real Name:''' || Alwin Esch<br />
|-<br />
| '''Nationality:''' || German<br />
|-<br />
| '''Residence:''' || Saarbrücken, Germany<br />
|}<br />
<br />
===Contact===<br />
{|<br />
|-<br />
| '''Timezone:''' || Central European Time (CET) i.e. GMT+1/+2<br />
|-<br />
| '''IRC username:''' || alwinus<br />
|-<br />
| '''KODI e-mail alias:''' || alwinus@kodi.tv<br />
|-<br />
| '''KODI Forum account:''' || alwinus<br />
|-<br />
| '''KODI Wiki account:''' || Alwinus<br />
|-<br />
| '''github.com:''' || AlwinEsch<br />
|-<br />
| '''SourceForge.net:''' || alwinus<br />
|-<br />
| '''Website:''' || http://esmasol.de<br />
|}</div>Alwinushttps://kodi.wiki/index.php?title=Official:Code_guidelines_and_formatting_conventions&diff=103026Official:Code guidelines and formatting conventions2015-11-09T23:52:38Z<p>Alwinus: /* Headers */</p>
<hr />
<div>{{mininav|[[Development]]}}<br />
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.<br />
<br />
As such we don't follow these rules slavishly, in certain cases it is ok (and in fact favorable) to stray from them.<br />
== Indentation ==<br />
Use spaces as tab policy with an indentation size of 2<br />
<br />
=== Namespaces ===<br />
Namespaces are not required to use any indentation to simplify nested namespaces and wrapping .cpp files in a namespace<br />
<pre><br />
namespace KODI<br />
{<br />
namespace UTILS<br />
{<br />
class ILogger<br />
{<br />
void Log(...) = 0;<br />
}<br />
}<br />
}<br />
</pre><br />
<br />
=== Headers ===<br />
Included header files *.h, are to sort alphabetical to prevent double used file definition and allow better overview<br />
* On cpp define used header first to confirm needed headers are present on them itself<br />
* As next use the global system headers e.g. <cassert> or "system.h"<br />
* Then insert all the headers needed for the file itself<br />
<pre><br />
#include "PVRManager.h"<br />
<br />
#include <cassert><br />
#include <utility><br />
<br />
#include "Application.h"<br />
#include "Util.h"<br />
#include "addons/AddonInstaller.h"<br />
#include "dialogs/GUIDialogExtendedProgressBar.h"<br />
...<br />
#include "messaging/helpers/DialogHelper.h"<br />
#include "music/tags/MusicInfoTag.h"<br />
#include "network/Network.h"<br />
#include "pvr/addons/PVRClients.h"<br />
#include "pvr/channels/PVRChannel.h"<br />
...<br />
#include "settings/Settings.h"<br />
#include "threads/SingleLock.h"<br />
#include "utils/JobManager.h"<br />
#include "utils/log.h"<br />
...<br />
#include "utils/Variant.h"<br />
#include "video/VideoDatabase.h"<br />
</pre><br />
<br />
== Braces ==<br />
Braces should go to newline and your code should look like the following example:<br />
<pre><br />
if (int i = 0; i < t; i++)<br />
{<br />
[...]<br />
}<br />
else<br />
{<br />
[...]<br />
}<br />
<br />
class Dummy()<br />
{<br />
[...]<br />
}<br />
</pre><br />
<br />
== Whitespaces ==<br />
Conventional operators should be surrounded by a whitespace.<br />
<pre><br />
a = (b + c) * d;<br />
</pre><br />
<br />
Reserved words should be separated from opening parentheses by a whitespace.<br />
<pre><br />
while (true)<br />
for (int i = 0; i < x; ++i)<br />
</pre><br />
<br />
Commas should be followed by a whitespace.<br />
<pre><br />
void Dummy::Method(int a, int b, int c);<br />
int d, e;<br />
</pre><br />
<br />
Semicolons should be followed by a whitespace if there is more than one expression per line.<br />
<pre><br />
for (int i = 0; i < x; ++i)<br />
doSomething(e); doSomething(f); // this is probably bad style anyway<br />
</pre><br />
<br />
== Control statements ==<br />
Insert new line before <br />
* ''else'' in an ''if'' statement <br />
* ''catch'' in a ''try'' statement<br />
* ''while'' in a ''do'' statement<br />
<br />
=== if else ===<br />
* put ''then'' statement, ''return'' or ''throw'' to new line<br />
* keep ''else if'' on one line<br />
<pre><br />
if (true) <br />
return;<br />
<br />
if (true) <br />
{<br />
[...]<br />
} <br />
else if (false) <br />
{<br />
return;<br />
} <br />
else<br />
return;<br />
</pre><br />
<br />
=== switch / case ===<br />
<pre><br />
switch (cmd)<br />
{<br />
case x:<br />
{<br />
doSomething();<br />
break;<br />
}<br />
case x:<br />
case z:<br />
return true;<br />
default:<br />
doSomething();<br />
}<br />
</pre><br />
<br />
== Naming ==<br />
=== Namespaces ===<br />
Namespaces should be in uppercase letters<br />
<pre><br />
namespace KODI<br />
{<br />
...<br />
}<br />
</pre><br />
=== Constants ===<br />
Use upper case with underscore spacing where necessary.<br />
<pre><br />
const int MY_CONSTANT = 1;<br />
</pre><br />
<br />
=== Enums ===<br />
Use CamelCase for the enum name and upper case for the values.<br />
<pre><br />
enum Dummy<br />
{<br />
VALUE_X,<br />
VALUE_Y<br />
};<br />
</pre><br />
<br />
=== Interfaces ===<br />
We use CamelCase for interface names and they should be prefixed with an uppercase I.<br />
Filename should match the interface name, e.g. ILogger.h<br />
<pre><br />
class ILogger<br />
{<br />
void Log(...) = 0;<br />
}<br />
</pre><br />
<br />
=== Classes ===<br />
We use CamelCase for class names and they should be prefixed with an uppercase C.<br />
Filename should match the class name without the prefixed C, e.g. Logger.cpp<br />
<pre><br />
class CLogger : public ILogger<br />
{<br />
void Log(...)<br />
}<br />
</pre><br />
<br />
=== Methods ===<br />
We use CamelCase for method names and first letter should be upper case.<br />
<pre><br />
void MyDummyClass::DoSomething();<br />
</pre><br />
<br />
=== Variables ===<br />
We use CamelCase for variables. Type prefixing is optional.<br />
<br />
==== Global Variables ====<br />
Prefix global variables with ''g_''<br />
<pre><br />
int g_globalVariableA;<br />
</pre><br />
<br />
==== Member Variables ====<br />
Prefix member variables with ''m_''<br />
<pre><br />
int m_variableA;<br />
</pre><br />
<br />
== Conventions ==<br />
=== Casts ===<br />
New code should use C++ style casts and not older C style casts. When modifying existing code the developer can choose to update it to C++ style casts or leave as is.<br />
Remember that whenever a dynamic_cast is used the result can be a nullptr and needs to be checked accordingly.<br />
<br />
=== NULL vs nullptr ===<br />
Prefer the use of nullptr instead of NULL. nullptr is a typesafe version and as such can't be implicitly converted to int or anything else.<br />
<br />
=== auto ===<br />
Feel free to use auto wherever it improves readability. Good places are iterators or when dealing with containers.<br />
<pre><br />
std::map<std::string, std::vector<int>>::iterator i = var.begin();<br />
vs<br />
auto i = var.being();<br />
</pre><br />
<br />
=== for loops ===<br />
Use newer style foreach loops whenever it makes sense. If iterators are used see above about using auto.<br />
<pre><br />
for (auto& : var)<br />
{<br />
...<br />
}<br />
</pre><br />
Use const auto& if there's no reason to modify the value.<br />
[[Category:Development]]</div>Alwinushttps://kodi.wiki/index.php?title=Official:Code_guidelines_and_formatting_conventions&diff=103025Official:Code guidelines and formatting conventions2015-11-09T23:49:11Z<p>Alwinus: Add guideline for included source code headers</p>
<hr />
<div>{{mininav|[[Development]]}}<br />
These are conventions which we try to follow when writing code for Kodi. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.<br />
<br />
As such we don't follow these rules slavishly, in certain cases it is ok (and in fact favorable) to stray from them.<br />
== Indentation ==<br />
Use spaces as tab policy with an indentation size of 2<br />
<br />
=== Namespaces ===<br />
Namespaces are not required to use any indentation to simplify nested namespaces and wrapping .cpp files in a namespace<br />
<pre><br />
namespace KODI<br />
{<br />
namespace UTILS<br />
{<br />
class ILogger<br />
{<br />
void Log(...) = 0;<br />
}<br />
}<br />
}<br />
</pre><br />
<br />
=== Headers ===<br />
Included source files *.cpp and *.h, are to sort alphabetical to prevent double used file definition and allow better overview<br />
* On cpp define used header first to confirm needed headers are present on them itself<br />
* As next use the global system headers e.g. <cassert> or "system.h"<br />
* Then insert all the headers needed for the file itself<br />
<pre><br />
#include "PVRManager.h"<br />
<br />
#include <cassert><br />
#include <utility><br />
<br />
#include "Application.h"<br />
#include "Util.h"<br />
#include "addons/AddonInstaller.h"<br />
#include "dialogs/GUIDialogExtendedProgressBar.h"<br />
...<br />
#include "messaging/helpers/DialogHelper.h"<br />
#include "music/tags/MusicInfoTag.h"<br />
#include "network/Network.h"<br />
#include "pvr/addons/PVRClients.h"<br />
#include "pvr/channels/PVRChannel.h"<br />
...<br />
#include "settings/Settings.h"<br />
#include "threads/SingleLock.h"<br />
#include "utils/JobManager.h"<br />
#include "utils/log.h"<br />
...<br />
#include "utils/Variant.h"<br />
#include "video/VideoDatabase.h"<br />
</pre><br />
<br />
== Braces ==<br />
Braces should go to newline and your code should look like the following example:<br />
<pre><br />
if (int i = 0; i < t; i++)<br />
{<br />
[...]<br />
}<br />
else<br />
{<br />
[...]<br />
}<br />
<br />
class Dummy()<br />
{<br />
[...]<br />
}<br />
</pre><br />
<br />
== Whitespaces ==<br />
Conventional operators should be surrounded by a whitespace.<br />
<pre><br />
a = (b + c) * d;<br />
</pre><br />
<br />
Reserved words should be separated from opening parentheses by a whitespace.<br />
<pre><br />
while (true)<br />
for (int i = 0; i < x; ++i)<br />
</pre><br />
<br />
Commas should be followed by a whitespace.<br />
<pre><br />
void Dummy::Method(int a, int b, int c);<br />
int d, e;<br />
</pre><br />
<br />
Semicolons should be followed by a whitespace if there is more than one expression per line.<br />
<pre><br />
for (int i = 0; i < x; ++i)<br />
doSomething(e); doSomething(f); // this is probably bad style anyway<br />
</pre><br />
<br />
== Control statements ==<br />
Insert new line before <br />
* ''else'' in an ''if'' statement <br />
* ''catch'' in a ''try'' statement<br />
* ''while'' in a ''do'' statement<br />
<br />
=== if else ===<br />
* put ''then'' statement, ''return'' or ''throw'' to new line<br />
* keep ''else if'' on one line<br />
<pre><br />
if (true) <br />
return;<br />
<br />
if (true) <br />
{<br />
[...]<br />
} <br />
else if (false) <br />
{<br />
return;<br />
} <br />
else<br />
return;<br />
</pre><br />
<br />
=== switch / case ===<br />
<pre><br />
switch (cmd)<br />
{<br />
case x:<br />
{<br />
doSomething();<br />
break;<br />
}<br />
case x:<br />
case z:<br />
return true;<br />
default:<br />
doSomething();<br />
}<br />
</pre><br />
<br />
== Naming ==<br />
=== Namespaces ===<br />
Namespaces should be in uppercase letters<br />
<pre><br />
namespace KODI<br />
{<br />
...<br />
}<br />
</pre><br />
=== Constants ===<br />
Use upper case with underscore spacing where necessary.<br />
<pre><br />
const int MY_CONSTANT = 1;<br />
</pre><br />
<br />
=== Enums ===<br />
Use CamelCase for the enum name and upper case for the values.<br />
<pre><br />
enum Dummy<br />
{<br />
VALUE_X,<br />
VALUE_Y<br />
};<br />
</pre><br />
<br />
=== Interfaces ===<br />
We use CamelCase for interface names and they should be prefixed with an uppercase I.<br />
Filename should match the interface name, e.g. ILogger.h<br />
<pre><br />
class ILogger<br />
{<br />
void Log(...) = 0;<br />
}<br />
</pre><br />
<br />
=== Classes ===<br />
We use CamelCase for class names and they should be prefixed with an uppercase C.<br />
Filename should match the class name without the prefixed C, e.g. Logger.cpp<br />
<pre><br />
class CLogger : public ILogger<br />
{<br />
void Log(...)<br />
}<br />
</pre><br />
<br />
=== Methods ===<br />
We use CamelCase for method names and first letter should be upper case.<br />
<pre><br />
void MyDummyClass::DoSomething();<br />
</pre><br />
<br />
=== Variables ===<br />
We use CamelCase for variables. Type prefixing is optional.<br />
<br />
==== Global Variables ====<br />
Prefix global variables with ''g_''<br />
<pre><br />
int g_globalVariableA;<br />
</pre><br />
<br />
==== Member Variables ====<br />
Prefix member variables with ''m_''<br />
<pre><br />
int m_variableA;<br />
</pre><br />
<br />
== Conventions ==<br />
=== Casts ===<br />
New code should use C++ style casts and not older C style casts. When modifying existing code the developer can choose to update it to C++ style casts or leave as is.<br />
Remember that whenever a dynamic_cast is used the result can be a nullptr and needs to be checked accordingly.<br />
<br />
=== NULL vs nullptr ===<br />
Prefer the use of nullptr instead of NULL. nullptr is a typesafe version and as such can't be implicitly converted to int or anything else.<br />
<br />
=== auto ===<br />
Feel free to use auto wherever it improves readability. Good places are iterators or when dealing with containers.<br />
<pre><br />
std::map<std::string, std::vector<int>>::iterator i = var.begin();<br />
vs<br />
auto i = var.being();<br />
</pre><br />
<br />
=== for loops ===<br />
Use newer style foreach loops whenever it makes sense. If iterators are used see above about using auto.<br />
<pre><br />
for (auto& : var)<br />
{<br />
...<br />
}<br />
</pre><br />
Use const auto& if there's no reason to modify the value.<br />
[[Category:Development]]</div>Alwinushttps://kodi.wiki/index.php?title=Add-on:VDR_VNSI_Client&diff=97858Add-on:VDR VNSI Client2015-06-22T22:48:49Z<p>Alwinus: </p>
<hr />
<div><!-- See http://kodi.wiki/index.php?title=Template:Addon and http://kodi.wiki/index.php?title=Help:Add-on_page for help editing this page --><br />
{{Addon <br />
| Name = VDR VNSI Client<br />
| provider-name = Team Kodi<br />
| ID = pvr.vdr.vnsi<br />
| latest-version = 1.0.0<br />
| extension point = xbmc.pvrclient<br />
| provides = <br />
| Platform = all<br />
| broken = <br />
| icon url = <br />
| repo = https://github.com/kodi-pvr/pvr.vdr.vnsi<br />
| zip = <br />
| Summary = PVR client to connect VDR to Kodi over the VNSI interface<br />
| Description = VDR frontend; supporting streaming of Live TV &amp; Recordings, EPG, Timers over the VNSI plugin<br />
}}<br />
<br />
<br />
<big>For setting up VDR in Kodi, see '''[[PVR/Backend/VDR]]'''.</big></div>Alwinushttps://kodi.wiki/index.php?title=Add-on:VDR_VNSI_Client&diff=97857Add-on:VDR VNSI Client2015-06-22T22:47:51Z<p>Alwinus: </p>
<hr />
<div><!-- See http://wiki.xbmc.org/index.php?title=Template:Addon and http://wiki.xbmc.org/index.php?title=Help:Add-on_page for help editing this page --><br />
{{Addon <br />
| Name = VDR VNSI Client<br />
| provider-name = Team Kodi<br />
| ID = pvr.vdr.vnsi<br />
| latest-version = 1.0.0<br />
| extension point = xbmc.pvrclient<br />
| provides = <br />
| Platform = all<br />
| broken = <br />
| icon url = <br />
| repo = https://github.com/kodi-pvr/pvr.vdr.vnsi<br />
| zip = <br />
| Summary = PVR client to connect VDR to Kodi over the VNSI interface<br />
| Description = VDR frontend; supporting streaming of Live TV &amp; Recordings, EPG, Timers over the VNSI plugin<br />
}}<br />
<br />
<br />
<big>For setting up VDR in Kodi, see '''[[PVR/Backend/VDR]]'''.</big></div>Alwinushttps://kodi.wiki/index.php?title=User:Alwinus&diff=97856User:Alwinus2015-06-22T22:40:31Z<p>Alwinus: /* Contact */</p>
<hr />
<div>=alwinus=<br />
===Team-KODI Developer===<br />
{|<br />
|-<br />
| '''Real Name:''' || Alwin Esch<br />
|-<br />
| '''Nationality:''' || German<br />
|-<br />
| '''Residence:''' || Moenchengladbach, Germany<br />
|}<br />
<br />
===Contact===<br />
{|<br />
|-<br />
| '''Timezone:''' || Central European Time (CET) i.e. GMT+1/+2<br />
|-<br />
| '''IRC username:''' || alwinus<br />
|-<br />
| '''KODI e-mail alias:''' || alwinus@kodi.tv<br />
|-<br />
| '''KODI Forum account:''' || alwinus<br />
|-<br />
| '''KODI Wiki account:''' || Alwinus<br />
|-<br />
| '''github.com:''' || AlwinEsch<br />
|-<br />
| '''SourceForge.net:''' || alwinus<br />
|-<br />
| '''Website:''' || http://esmasol.de<br />
|}</div>Alwinushttps://kodi.wiki/index.php?title=User:Alwinus&diff=97855User:Alwinus2015-06-22T22:39:27Z<p>Alwinus: /* alwinus */</p>
<hr />
<div>=alwinus=<br />
===Team-KODI Developer===<br />
{|<br />
|-<br />
| '''Real Name:''' || Alwin Esch<br />
|-<br />
| '''Nationality:''' || German<br />
|-<br />
| '''Residence:''' || Moenchengladbach, Germany<br />
|}<br />
<br />
===Contact===<br />
{|<br />
|-<br />
| '''Timezone:''' || Central European Time (CET) i.e. GMT+1/+2<br />
|-<br />
| '''IRC username:''' || alwinus<br />
|-<br />
| '''KODI e-mail alias:''' || alwinus@kodi.tv<br />
|-<br />
| '''XBMC Forum account:''' || alwinus<br />
|-<br />
| '''XBMC Wiki account:''' || Alwinus<br />
|-<br />
| '''github.com:''' || AlwinEsch<br />
|-<br />
| '''SourceForge.net:''' || alwinus<br />
|-<br />
| '''Website:''' || http://esmasol.de<br />
|}</div>Alwinushttps://kodi.wiki/index.php?title=User:Alwinus&diff=97854User:Alwinus2015-06-22T22:29:16Z<p>Alwinus: /* alwinus */</p>
<hr />
<div>=alwinus=<br />
Team-KODI Developer<br/><br />
Real Name: Alwin Esch<br />
Nationality: German<br />
Residence: Moenchengladbach, Germany<br />
<br />
===Contact===<br />
Timezone: Central European Time (CET) i.e. GMT+1/+2<br><br />
IRC username: alwinus<br><br />
KODI e-mail alias: alwinus@kodi.tv<br><br />
XBMC Forum account: alwinus<br><br />
XBMC Wiki account: Alwinus<br><br />
github.com: AlwinEsch<br><br />
SourceForge.net: alwinus<br><br />
Website/blog: http://esmasol.de<br></div>Alwinushttps://kodi.wiki/index.php?title=User:Alwinus&diff=97853User:Alwinus2015-06-22T22:27:23Z<p>Alwinus: </p>
<hr />
<div>=alwinus=<br />
Team-KODI Developer<br/><br />
Real Name: Alwin Esch<br />
===Contact===<br />
Timezone: Central European Time (CET) i.e. GMT+1/+2<br><br />
IRC username: alwinus<br><br />
KODI e-mail alias: alwinus@kodi.tv<br><br />
XBMC Forum account: alwinus<br><br />
XBMC Wiki account: Alwinus<br><br />
github.com: AlwinEsch<br><br />
SourceForge.net: alwinus<br><br />
Website/blog: http://esmasol.de<br></div>Alwinushttps://kodi.wiki/index.php?title=Archive:Team_Kodi/Members&diff=97852Archive:Team Kodi/Members2015-06-22T22:22:25Z<p>Alwinus: /* Developers (General) */</p>
<hr />
<div>{{mininav|[[Team Kodi]]}}<br />
{{notice|'''PLEASE DON'T E-MAIL OR PM ANYONE DIRECTLY ABOUT SUPPORT! INSTEAD USE THE COMMUNITY FORUM OR IRC-CHANNELS!'''}}<br />
<br />
<br />
<section begin=intro />Team Kodi is the formal group of people who develop and maintain [[Kodi]], the [http://kodi.tv Kodi websites], and/or other supporting roles.<section end=intro /><br />
<br />
<br />
'''''This list is likely incomplete, so give us a nudge if we forgot you'''''<br />
{{warning|This is probably very outdated... We're working on a better way to list active members. If you see anything wrong on this page them please poke a team member about it (or just Ned).}}<br />
{{TOCright}}<br />
= Active members =<br />
<br />
== XBMC Foundation Voting Board Members and Non-Voting Officers ==<br />
{{Main|XBMC Foundation}}<br />
{{#lst:XBMC Foundation|intro}}<br />
{{#lst:XBMC Foundation|Foundation members}}<br />
<br />
== Project Managers ==<br />
* [[User:Pike|Pike]] - The Bossman<br />
* [[User:Natethomas|Natethomas]] - Community Manager<br />
* [[User:Martijn|Martijn]] - GitHub Project Manager<br />
<br />
== Developers (General) ==<br />
* abelier - video decoding<br />
* [[User:alanwww1|alanwww1]] - Translations, Intel related stuff<br />
* [[User:Alcoheca|Alcoheca]]<br />
* [[User:Alwinus|Alwinus]] - C++ add-on systems<br />
* [[User:amet|amet]]<br />
* [[User:Anssi|Anssi]]<br />
* [[User:Arnova|Arnova]] - Curl/webdav filesystem(s), general bug fixes<br />
* [[User:bobo1on1|bobo1on1]] - Video Playback, General Bugfixes<br />
* [[User:Chadoe|Chadoe]] - general bug fixes<br />
* [[User:opdenkamp|opdenkamp]] - PVR, EPG<br />
* [[User:dteirney|dteirney]] - MythTV Integration<br />
* [[User:elupus|elupus]] - Kodi video player (DVDPlayer) god<br />
* [[User:firnsy|firnsy]] - Database<br />
* [[User:Fneufneu|Fneufneu]] - BSD Developer<br />
* [[User:freezy|freezy]] - Android Remote Developer<br />
* [[User:garbear|garbear]]<br />
* [[User:gnif|gnif]] - Audio, Audio Engine<br />
* [[User:jfcarroll|jfcarroll]] - swig integration, binary addon developer<br />
* [[User:Jmarshall|Jmarshall]] - Jedi-Master<br />
* JoeTheFox - iPhone Remote Developer<br />
* [[User:Malard|Malard]] - Web<br />
* [[User:Memphiz|Memphiz]] - vfs, zeroconf, AirPlay and general stuff<br />
* [[User:Montellese|Montellese]] - JSONRPC<br />
* night199uk - Music library<br />
* [[User:olympia|olympia]] - scraper developer/repo maintainer<br />
* [[User:phi2039|phi2039]] - Audio, Assembly, and anything that sounds like it might be challenging...<br />
* [[User:pieh|pieh]] - General code tinkering<br />
* [[User:taxigps|taxigps]]<br />
* [[User:Topfs2|Topfs2]] - JSONRPC, ARM, power, storage, dbus<br />
* [[User:the_alien|the_alien]] - Android Remote Developer<br />
* [[User:VDRfan|VDRfan]] - General<br />
* [[User:Herrnst|Herrnst]] - LCD display coding<br />
* [[User:Voyager|Voyager]] - hunting bugs in library, dvdplayer etc.<br />
* [[User:ulion|ulion]]<br />
<br />
== Developers (Linux) ==<br />
* [[User:AlTheKiller|AlTheKiller]]<br />
* [[User:Amejia|Amejia]] - Debian, etc.<br />
* [[User:Anssi|Anssi]]<br />
* [[User:Arnova|Arnova]]<br />
* [[User:bobo1on1|bobo1on1]]<br />
* [[User:opdenkamp|opdenkamp]]<br />
* [[User:Erhnam|Erhnam]] - XBMCFreak creater, Live Distro developer<br />
* [[User:firnsy|firnsy]]<br />
* [[User:l.capriotti|l.capriotti]] - LiveUSB Distro<br />
* [[User:malloc|malloc]]<br />
* [[User:monkeyman 67156|monkeyman 67156]]<br />
* [[User:Phaeodaria|Phaeodaria]]<br />
* [[User:sraue|sraue]] - OpenELEC.tv Developer<br />
* [[User:Topfs2|Topfs2]]<br />
* [[User:VDRfan|VDRfan]]<br />
* [[User:FernetMenta|FernetMenta]] linux, video, windowing, pvr etc developer<br />
* [[User:wsnipex|wsnipex]] Linux PPA<br />
* [[User:fritsch|fritsch]] Linux, ActiveAE, Pulseaudio, VAAPI, User Support, OpenELEC<br />
<br />
== Developers (Mac and iOS) ==<br />
* [[User:Beenje|Beenje]] - PowerPC (PPC) specialist<br />
* [[User:davilla|davilla]]<br />
* [[User:Jmarshall|Jmarshall]]<br />
* [[User:Memphiz|Memphiz]] - dark side padawan<br />
* [[User:ulion|ulion]]<br />
<br />
== Developers (Windows) ==<br />
* [[User:a11599|a11599]] - primarily windows video and dxva<br />
* [[User:blinkseb|blinkseb]]<br />
* [[User:bobo1on1|bobo1on1]]<br />
* [[User:Chadoe|Chadoe]]<br />
* [[User:CrystalP|CrystalP]]<br />
* [[User:jhsrennie|jhsrennie]]<br />
* [[User:Jmarshall|Jmarshall]]<br />
* [[User:tiben20|tiben20]] - butcher by day, coder by night<br />
* [[User:WiSo|WiSo (aka wsoltys)]]<br />
* [[User:DDDamian|DDDamian]]<br />
* [[User:DanielaE|DanielaE]]<br />
* [[User:Voyager|Voyager]] - general Windows, hunting bugs in library, dvdplayer etc.<br />
* [[User:Koying|Koying]] Windows, Android, mysql<br />
<br />
== Developers (ARM) ==<br />
* [[User:McGeagh|McGeagh]]<br />
* [[User:Phaeodaria|Phaeodaria]]<br />
* [[User:Topfs2|Topfs2]]<br />
<br />
== Skinners / Graphic-artists ==<br />
* da-anda - graphics<br />
* [[User:freezy|freezy]]<br />
* [[User:Jezz_X|Jezz_X]] - Team skinner & Project Manager of the [http://sourceforge.net/projects/xboxmediacenter Kodi Skinning Project]<br />
* [[User:ronie|ronie]] - xml coding<br />
* [[User:tree_jammer|tree_jammer]] - graphics<br />
<br />
== Addon Developers ==<br />
* [[User:Clumsy|Clumsy]]<br />
* [[User:opdenkamp|opdenkamp]] - PVR, EPG<br />
* [[User:Jmarshall|Jmarshall]] - on an as-needed basis<br />
* [[User:Martijn|Martijn]] - python addons<br />
* [[User:ronie|ronie]] - python addons<br />
<br />
== Q/A Testers ==<br />
* [[User:keith|keith]] - QA for iOS and OSX projects<br />
* [[User:kricker|kricker]]<br />
* [[User:alanwww1|alanwww1]] - QA for Intel HW, VAAPI<br />
* [[User:Gabbott|Gabbott]]<br />
* [[User:Milhouse|Milhouse]]<br />
<br />
== Website services ==<br />
* [[User:Clumsy|Clumsy]] - Forum Moderator<br />
* da-anda - Forum administration<br />
* [[User:DonJ|DonJ]] - Server and Mirror Contact<br />
* [[User:joebrady|joebrady]] - Forum Moderator<br />
* [[User:Ned Scott|Ned Scott]] - Wiki<br />
* [[User:Prae5|Prae5]] - Forum Moderator<br />
* [[User:Sho|Sho]] - WIKI Structure Guru<br />
* [[User:Zag|Zag]] - Add-on Frontend, Website, General Community Stuff<br />
* [[User:kibje|Kib]] - Server Administrator<br />
<br />
== Google Summer of Code 2012 ==<br />
:''See also: http://www.google-melange.com/gsoc/org/google/gsoc2012/xbmc ''<br />
* Alasdair Campbell (Alcoheca) - Improved UPnP serving and client <br />
** Joakim Plate (elupus) - Mentor<br />
* Andres Mejia (amejia) - Kodi Test Suite <br />
** Bob van Loosen (bobo1on1) - Mentor<br />
* Montellese - Advanced Library Filtering in Kodi<br />
** Jonathan Marshall (jmarshall) - Mentor<br />
* topfs2 - Clean scraping API <br />
** spiff - Mentor<br />
* Nathan Betzen (natethomas) - GSoC admin<br />
<br />
= Semi-active =<br />
* [[User:Gamester17|Gamester17]] - formally an active forum moderator, but he still contributes to the wiki.<br />
<br />
= Inactive members =<br />
<br />
== Project Founders (All Retired) ==<br />
* [[User:Frodo|Frodo]] - now [http://www.team-mediaportal.com MediaPortal] head programmer/founder<br />
* [[User:RUNTiME|RUNTiME]] - now [http://www.runtime360.com runtime360.com] & [http://www.runtime360.com/projects/transcode-360/ Transcode 360]<br />
* [[User:d7o3g4q|d7o3g4q (a.k.a. Duo Egaq)]] M.I.A. (Missing In Action)<br />
<br />
== Developers (Currently Inactive or Retired) ==<br />
* [[User:AlTheKiller|AlTheKiller]]<br />
* [[User:davilla|davilla]]<br />
* [[User:MaestroDD|MaestroDD]] - Mac OS X, and Apple TV<br />
* [[User:wattazoum|wattazoum]] - Kodi for Linux packaging specialist<br />
* [[User:AreaScout|AreaScout]]<br />
* [[User:oldnemesis|oldnemesis]]<br />
* [[User:motd2k|motd2k]]<br />
* [[User:Rudd|Rudd]]<br />
* [[User:Kraqh3d|Kraqh3d]]<br />
* [[User:C-Quel|C-Quel]]<br />
* [[User:Agathorn|Agathorn]]<br />
* [[User:Tut-ankh-amon|tut-ankh-amon]]<br />
* [[User:nad|nad]] - [[WebServerHTTP-API|Kodi HTTP API Mastermind]]<br />
* [[User:MrC|MrC]] - Kodi Visualisation/Screensaver Mastermind<br />
* [[User:c0diq|c0diq]] - UPnP (Universial Plug And Play) Mastermind<br />
* [[User:Yuvalt|Yuvalt]] - Kodi Linux port specialist<br />
* [[User:Vulkanr|Vulkanr]] - Kodi Linux and Mac port specialist<br />
* [[User:D4rk|D4rk]] - Kodi Linux and Mac port specialist<br />
* [[User:Bobbin007|Bobbin007]]<br />
* [[User:Tslayer|Tslayer]]<br />
* [[User:GeminiServer|GeminiServer]] - Low-level Hardware Guru<br />
* [[User:Darkie|Darkie]]<br />
* [[User:Forza|Forza]] - M.I.A. (Missing In Action)<br />
* [[User:Butcher|Butcher]]<br />
* [[User:Ysbox|Ysbox]]<br />
* [[User:Guybrush|Guybrush]] - M.I.A. (Missing In Action)<br />
* [[User:Kreet|Kreet]] - M.I.A. (Missing In Action)<br />
* [[User:monkeyhappy|monkeyhappy]] - M.I.A. (Missing In Action)<br />
* [[User:elan|elan (a.k.a. leafmuncher)]] - Kodi for Mac port specialist<br />
* [[User:LiquidIce629|LiquidIce629]] - [[The Web Interface|Kodi Web GUI control-interface]] ([http://www.cliqklabs.com/xbmcwebgui/ Website])<br />
* [[User:Spiff|Spiff]]<br />
* [[User:theuni|theuni]] - Business Relation Manager<br />
<br />
== Skinners / Graphic-artists (Retired) ==<br />
* [[User:CHI3f|CHI3f]] - XML Guru and all round Good Guy<br />
* [[User:SmokeHead|SmokeHead]] - Photoshop Guru (Missing In Action)<br />
* [[User:Chokemaniac|ChokeManiac]] - Project Mayhem<br />
<br />
== Python Scripters (Retired/Inactive) ==<br />
* [[User:Voinage|Voinage]] - Python Plugin coder<br />
* [[User:rwparris2|rwparris2]] - Python Plugin coder<br />
* [[User:Nuka1195|Nuka1195]] - Python Script coder<br />
<br />
== Web Services (Retired/Inactive) ==<br />
* [[User:Granqvist|Granqvist]] - Web Developer<br />
* [[User:blittan|blittan]] - Web and Python Developer<br />
<br />
== Testers (Retired/Inactive) ==<br />
* [[User:DDay|DDay]] - [http://forums.xbox-scene.com/index.php?showforum=180 Xbox-Scene.com Forum Mod God]<br />
* [[User:TeknoJuce|TeknoJuce]] CrAzY Canuck<br />
* [[User:Modhack|Modhack]] - French Guru [http://manuel.xboxmediacenter.fr .fr manuel]<br />
* [[User:Donno|Donno]] - 1337 d00d<br />
* [[User:SandmanCL|SandmanCL]] - Quality Assurance<br />
* [[User:ShortySco|ShortySco]] - Quality Assurance<br />
* [[User:Scape|sCAPe]] - Beta-Tester<br />
<br />
== #Kodi (FreeNode) IRC Support ==<br />
* [[User:Bizzeh|Bizzeh]] - Mr. Hater ("I want to be in all sections") ([http://www.bizzeh.com Blog])<br />
* [[User:Cocoliso|Cocoliso]] - Spanish<br />
* [[User:DOS4GW|DOS4GW]] - Multi-lingual<br />
* [[User:Jedi79|Jedi79]]<br />
* [[User:MattAAron|MattAAron]]<br />
* [[User:No1CaNTeL|No1CaNTeL]]<br />
* [[User:xLoial|xLoial]] - Seasoned newbie<br />
<br />
== Forum and Online Manual (WIKI) Moderators (Retired/Inactive) ==<br />
* [[User:Dankula|Dankula]] - WIKI Editor<br />
* [[User:Loto_Bak|Loto_Bak]] - Al'round support man<br />
* [[User:nimbles|nimbles]]<br />
* [[User:No_Good|No Good]]<br />
<br />
[[Category:Team Kodi]]<br />
[[Category:Team Kodi specific notes]]</div>Alwinushttps://kodi.wiki/index.php?title=Archive:Team_Kodi/Members&diff=97851Archive:Team Kodi/Members2015-06-22T22:20:48Z<p>Alwinus: /* Developers (Currently Inactive or Retired) */</p>
<hr />
<div>{{mininav|[[Team Kodi]]}}<br />
{{notice|'''PLEASE DON'T E-MAIL OR PM ANYONE DIRECTLY ABOUT SUPPORT! INSTEAD USE THE COMMUNITY FORUM OR IRC-CHANNELS!'''}}<br />
<br />
<br />
<section begin=intro />Team Kodi is the formal group of people who develop and maintain [[Kodi]], the [http://kodi.tv Kodi websites], and/or other supporting roles.<section end=intro /><br />
<br />
<br />
'''''This list is likely incomplete, so give us a nudge if we forgot you'''''<br />
{{warning|This is probably very outdated... We're working on a better way to list active members. If you see anything wrong on this page them please poke a team member about it (or just Ned).}}<br />
{{TOCright}}<br />
= Active members =<br />
<br />
== XBMC Foundation Voting Board Members and Non-Voting Officers ==<br />
{{Main|XBMC Foundation}}<br />
{{#lst:XBMC Foundation|intro}}<br />
{{#lst:XBMC Foundation|Foundation members}}<br />
<br />
== Project Managers ==<br />
* [[User:Pike|Pike]] - The Bossman<br />
* [[User:Natethomas|Natethomas]] - Community Manager<br />
* [[User:Martijn|Martijn]] - GitHub Project Manager<br />
<br />
== Developers (General) ==<br />
* abelier - video decoding<br />
* [[User:alanwww1|alanwww1]] - Translations, Intel related stuff<br />
* [[User:Alcoheca|Alcoheca]]<br />
* [[User:amet|amet]]<br />
* [[User:Anssi|Anssi]]<br />
* [[User:Arnova|Arnova]] - Curl/webdav filesystem(s), general bug fixes<br />
* [[User:bobo1on1|bobo1on1]] - Video Playback, General Bugfixes<br />
* [[User:Chadoe|Chadoe]] - general bug fixes<br />
* [[User:opdenkamp|opdenkamp]] - PVR, EPG<br />
* [[User:dteirney|dteirney]] - MythTV Integration<br />
* [[User:elupus|elupus]] - Kodi video player (DVDPlayer) god<br />
* [[User:firnsy|firnsy]] - Database<br />
* [[User:Fneufneu|Fneufneu]] - BSD Developer<br />
* [[User:freezy|freezy]] - Android Remote Developer<br />
* [[User:garbear|garbear]]<br />
* [[User:gnif|gnif]] - Audio, Audio Engine<br />
* [[User:jfcarroll|jfcarroll]] - swig integration, binary addon developer<br />
* [[User:Jmarshall|Jmarshall]] - Jedi-Master<br />
* JoeTheFox - iPhone Remote Developer<br />
* [[User:Malard|Malard]] - Web<br />
* [[User:Memphiz|Memphiz]] - vfs, zeroconf, AirPlay and general stuff<br />
* [[User:Montellese|Montellese]] - JSONRPC<br />
* night199uk - Music library<br />
* [[User:olympia|olympia]] - scraper developer/repo maintainer<br />
* [[User:phi2039|phi2039]] - Audio, Assembly, and anything that sounds like it might be challenging...<br />
* [[User:pieh|pieh]] - General code tinkering<br />
* [[User:taxigps|taxigps]]<br />
* [[User:Topfs2|Topfs2]] - JSONRPC, ARM, power, storage, dbus<br />
* [[User:the_alien|the_alien]] - Android Remote Developer<br />
* [[User:VDRfan|VDRfan]] - General<br />
* [[User:Herrnst|Herrnst]] - LCD display coding<br />
* [[User:Voyager|Voyager]] - hunting bugs in library, dvdplayer etc.<br />
* [[User:ulion|ulion]]<br />
<br />
== Developers (Linux) ==<br />
* [[User:AlTheKiller|AlTheKiller]]<br />
* [[User:Amejia|Amejia]] - Debian, etc.<br />
* [[User:Anssi|Anssi]]<br />
* [[User:Arnova|Arnova]]<br />
* [[User:bobo1on1|bobo1on1]]<br />
* [[User:opdenkamp|opdenkamp]]<br />
* [[User:Erhnam|Erhnam]] - XBMCFreak creater, Live Distro developer<br />
* [[User:firnsy|firnsy]]<br />
* [[User:l.capriotti|l.capriotti]] - LiveUSB Distro<br />
* [[User:malloc|malloc]]<br />
* [[User:monkeyman 67156|monkeyman 67156]]<br />
* [[User:Phaeodaria|Phaeodaria]]<br />
* [[User:sraue|sraue]] - OpenELEC.tv Developer<br />
* [[User:Topfs2|Topfs2]]<br />
* [[User:VDRfan|VDRfan]]<br />
* [[User:FernetMenta|FernetMenta]] linux, video, windowing, pvr etc developer<br />
* [[User:wsnipex|wsnipex]] Linux PPA<br />
* [[User:fritsch|fritsch]] Linux, ActiveAE, Pulseaudio, VAAPI, User Support, OpenELEC<br />
<br />
== Developers (Mac and iOS) ==<br />
* [[User:Beenje|Beenje]] - PowerPC (PPC) specialist<br />
* [[User:davilla|davilla]]<br />
* [[User:Jmarshall|Jmarshall]]<br />
* [[User:Memphiz|Memphiz]] - dark side padawan<br />
* [[User:ulion|ulion]]<br />
<br />
== Developers (Windows) ==<br />
* [[User:a11599|a11599]] - primarily windows video and dxva<br />
* [[User:blinkseb|blinkseb]]<br />
* [[User:bobo1on1|bobo1on1]]<br />
* [[User:Chadoe|Chadoe]]<br />
* [[User:CrystalP|CrystalP]]<br />
* [[User:jhsrennie|jhsrennie]]<br />
* [[User:Jmarshall|Jmarshall]]<br />
* [[User:tiben20|tiben20]] - butcher by day, coder by night<br />
* [[User:WiSo|WiSo (aka wsoltys)]]<br />
* [[User:DDDamian|DDDamian]]<br />
* [[User:DanielaE|DanielaE]]<br />
* [[User:Voyager|Voyager]] - general Windows, hunting bugs in library, dvdplayer etc.<br />
* [[User:Koying|Koying]] Windows, Android, mysql<br />
<br />
== Developers (ARM) ==<br />
* [[User:McGeagh|McGeagh]]<br />
* [[User:Phaeodaria|Phaeodaria]]<br />
* [[User:Topfs2|Topfs2]]<br />
<br />
== Skinners / Graphic-artists ==<br />
* da-anda - graphics<br />
* [[User:freezy|freezy]]<br />
* [[User:Jezz_X|Jezz_X]] - Team skinner & Project Manager of the [http://sourceforge.net/projects/xboxmediacenter Kodi Skinning Project]<br />
* [[User:ronie|ronie]] - xml coding<br />
* [[User:tree_jammer|tree_jammer]] - graphics<br />
<br />
== Addon Developers ==<br />
* [[User:Clumsy|Clumsy]]<br />
* [[User:opdenkamp|opdenkamp]] - PVR, EPG<br />
* [[User:Jmarshall|Jmarshall]] - on an as-needed basis<br />
* [[User:Martijn|Martijn]] - python addons<br />
* [[User:ronie|ronie]] - python addons<br />
<br />
== Q/A Testers ==<br />
* [[User:keith|keith]] - QA for iOS and OSX projects<br />
* [[User:kricker|kricker]]<br />
* [[User:alanwww1|alanwww1]] - QA for Intel HW, VAAPI<br />
* [[User:Gabbott|Gabbott]]<br />
* [[User:Milhouse|Milhouse]]<br />
<br />
== Website services ==<br />
* [[User:Clumsy|Clumsy]] - Forum Moderator<br />
* da-anda - Forum administration<br />
* [[User:DonJ|DonJ]] - Server and Mirror Contact<br />
* [[User:joebrady|joebrady]] - Forum Moderator<br />
* [[User:Ned Scott|Ned Scott]] - Wiki<br />
* [[User:Prae5|Prae5]] - Forum Moderator<br />
* [[User:Sho|Sho]] - WIKI Structure Guru<br />
* [[User:Zag|Zag]] - Add-on Frontend, Website, General Community Stuff<br />
* [[User:kibje|Kib]] - Server Administrator<br />
<br />
== Google Summer of Code 2012 ==<br />
:''See also: http://www.google-melange.com/gsoc/org/google/gsoc2012/xbmc ''<br />
* Alasdair Campbell (Alcoheca) - Improved UPnP serving and client <br />
** Joakim Plate (elupus) - Mentor<br />
* Andres Mejia (amejia) - Kodi Test Suite <br />
** Bob van Loosen (bobo1on1) - Mentor<br />
* Montellese - Advanced Library Filtering in Kodi<br />
** Jonathan Marshall (jmarshall) - Mentor<br />
* topfs2 - Clean scraping API <br />
** spiff - Mentor<br />
* Nathan Betzen (natethomas) - GSoC admin<br />
<br />
= Semi-active =<br />
* [[User:Gamester17|Gamester17]] - formally an active forum moderator, but he still contributes to the wiki.<br />
<br />
= Inactive members =<br />
<br />
== Project Founders (All Retired) ==<br />
* [[User:Frodo|Frodo]] - now [http://www.team-mediaportal.com MediaPortal] head programmer/founder<br />
* [[User:RUNTiME|RUNTiME]] - now [http://www.runtime360.com runtime360.com] & [http://www.runtime360.com/projects/transcode-360/ Transcode 360]<br />
* [[User:d7o3g4q|d7o3g4q (a.k.a. Duo Egaq)]] M.I.A. (Missing In Action)<br />
<br />
== Developers (Currently Inactive or Retired) ==<br />
* [[User:AlTheKiller|AlTheKiller]]<br />
* [[User:davilla|davilla]]<br />
* [[User:MaestroDD|MaestroDD]] - Mac OS X, and Apple TV<br />
* [[User:wattazoum|wattazoum]] - Kodi for Linux packaging specialist<br />
* [[User:AreaScout|AreaScout]]<br />
* [[User:oldnemesis|oldnemesis]]<br />
* [[User:motd2k|motd2k]]<br />
* [[User:Rudd|Rudd]]<br />
* [[User:Kraqh3d|Kraqh3d]]<br />
* [[User:C-Quel|C-Quel]]<br />
* [[User:Agathorn|Agathorn]]<br />
* [[User:Tut-ankh-amon|tut-ankh-amon]]<br />
* [[User:nad|nad]] - [[WebServerHTTP-API|Kodi HTTP API Mastermind]]<br />
* [[User:MrC|MrC]] - Kodi Visualisation/Screensaver Mastermind<br />
* [[User:c0diq|c0diq]] - UPnP (Universial Plug And Play) Mastermind<br />
* [[User:Yuvalt|Yuvalt]] - Kodi Linux port specialist<br />
* [[User:Vulkanr|Vulkanr]] - Kodi Linux and Mac port specialist<br />
* [[User:D4rk|D4rk]] - Kodi Linux and Mac port specialist<br />
* [[User:Bobbin007|Bobbin007]]<br />
* [[User:Tslayer|Tslayer]]<br />
* [[User:GeminiServer|GeminiServer]] - Low-level Hardware Guru<br />
* [[User:Darkie|Darkie]]<br />
* [[User:Forza|Forza]] - M.I.A. (Missing In Action)<br />
* [[User:Butcher|Butcher]]<br />
* [[User:Ysbox|Ysbox]]<br />
* [[User:Guybrush|Guybrush]] - M.I.A. (Missing In Action)<br />
* [[User:Kreet|Kreet]] - M.I.A. (Missing In Action)<br />
* [[User:monkeyhappy|monkeyhappy]] - M.I.A. (Missing In Action)<br />
* [[User:elan|elan (a.k.a. leafmuncher)]] - Kodi for Mac port specialist<br />
* [[User:LiquidIce629|LiquidIce629]] - [[The Web Interface|Kodi Web GUI control-interface]] ([http://www.cliqklabs.com/xbmcwebgui/ Website])<br />
* [[User:Spiff|Spiff]]<br />
* [[User:theuni|theuni]] - Business Relation Manager<br />
<br />
== Skinners / Graphic-artists (Retired) ==<br />
* [[User:CHI3f|CHI3f]] - XML Guru and all round Good Guy<br />
* [[User:SmokeHead|SmokeHead]] - Photoshop Guru (Missing In Action)<br />
* [[User:Chokemaniac|ChokeManiac]] - Project Mayhem<br />
<br />
== Python Scripters (Retired/Inactive) ==<br />
* [[User:Voinage|Voinage]] - Python Plugin coder<br />
* [[User:rwparris2|rwparris2]] - Python Plugin coder<br />
* [[User:Nuka1195|Nuka1195]] - Python Script coder<br />
<br />
== Web Services (Retired/Inactive) ==<br />
* [[User:Granqvist|Granqvist]] - Web Developer<br />
* [[User:blittan|blittan]] - Web and Python Developer<br />
<br />
== Testers (Retired/Inactive) ==<br />
* [[User:DDay|DDay]] - [http://forums.xbox-scene.com/index.php?showforum=180 Xbox-Scene.com Forum Mod God]<br />
* [[User:TeknoJuce|TeknoJuce]] CrAzY Canuck<br />
* [[User:Modhack|Modhack]] - French Guru [http://manuel.xboxmediacenter.fr .fr manuel]<br />
* [[User:Donno|Donno]] - 1337 d00d<br />
* [[User:SandmanCL|SandmanCL]] - Quality Assurance<br />
* [[User:ShortySco|ShortySco]] - Quality Assurance<br />
* [[User:Scape|sCAPe]] - Beta-Tester<br />
<br />
== #Kodi (FreeNode) IRC Support ==<br />
* [[User:Bizzeh|Bizzeh]] - Mr. Hater ("I want to be in all sections") ([http://www.bizzeh.com Blog])<br />
* [[User:Cocoliso|Cocoliso]] - Spanish<br />
* [[User:DOS4GW|DOS4GW]] - Multi-lingual<br />
* [[User:Jedi79|Jedi79]]<br />
* [[User:MattAAron|MattAAron]]<br />
* [[User:No1CaNTeL|No1CaNTeL]]<br />
* [[User:xLoial|xLoial]] - Seasoned newbie<br />
<br />
== Forum and Online Manual (WIKI) Moderators (Retired/Inactive) ==<br />
* [[User:Dankula|Dankula]] - WIKI Editor<br />
* [[User:Loto_Bak|Loto_Bak]] - Al'round support man<br />
* [[User:nimbles|nimbles]]<br />
* [[User:No_Good|No Good]]<br />
<br />
[[Category:Team Kodi]]<br />
[[Category:Team Kodi specific notes]]</div>Alwinus