Addon.xml

From Official Kodi Wiki
Jump to navigation Jump to search
Home icon grey.png   ▶ Development ▶ Add-on development ▶ Addon.xml

Every skin, script, or plugin in Kodi contains an addon.xml 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.

Every addon.xml file has the same basic structure, this example is for a video plugin:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="plugin.addon.id" name="Your Add-on" version="1.2.3" provider-name="You">
  <requires>
    <import addon="xbmc.python" version="2.25.0" />
  </requires>
  <extension point="xbmc.python.pluginsource" library="addon.py">
    <provides>video</provides>
  </extension>
  <extension point="xbmc.addon.metadata">
    <summary lang="en_GB">Your add-on's summary</summary>
    <description lang="en_GB">Your add-on's description</description>
    <disclaimer lang="en_GB"></disclaimer>
    <language>en</language> <!-- language of the content the add-on provides, omit if the add-on does not provide any content -->
    <platform>all</platform>
    <license>GPL-2.0-or-later</license>
    <forum>https://forum.kodi.tv/showthread.php?tid=xxxx</forum> <!-- may be omitted -->
    <website>http://myplugin.com</website> <!-- URL of the website that supplies the content, or the website for your plugin; may be omitted. -->
    <email>[email protected]</email> <!-- may be omitted -->
    <source>http://github.com/you/plugin.addon.id</source>
    <news>v1.2.3 (01/02/2013)
      [new] some new feature
      [fix] some fix
    </news>
    <assets>
        <icon>resources/icon.png</icon>
        <fanart>resources/fanart.jpg</fanart>
        <banner></banner> <!-- optional -->
        <clearlogo>resources/clearlogo.png</clearlogo> <!-- optional -->
        <screenshot></screenshot> <!-- optional, max. 10 -->
    </assets>
  </extension>
</addon>

There are a few important things to note in the above sample:

  • The <addon> element must be present, and be the root node. It presents data about the add-on package as a whole. Inside it should be:
    • A <requires> element, listing all the dependencies that this add-on needs in order to function inside individual <import> elements for each one.
    • One or more <extension> elements, each of which describes a part of Kodi that the add-on extends.
      • Finally, there is a specific extension element, <extension point="xbmc.addon.metadata"> that describes the add-on to the user.
        • Image assets such as icons, a banner and screenshots declared inside their own named elements inside of an <assets> tag (exclusive to Kodi v18+)

Core elements

<addon>

The <addon> element has 4 attributes, and they are all required: id, version, name, and provider-name.

Example: <addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2">

id attribute

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.

version attribute

The version attribute is used by Kodi to determine whether updates are available. This should be use a version scheme like x.y.z (major.minor.patch). For example: version="0.0.1". Generally, you'll start with a version of 0.y.z for test releases and once you feel it is ready for a full release, you'd bump the version to 1.0.0.

How versioning works
  • 2.2.9 is newer than 2.2.1
  • 2.2.10 is newer than 2.2.1
  • 2.3.0 is newer than 2.2.9
  • 2.2.1 is newer than 2.2.1~alpha
  • 2.2.1 is newer than 2.2.1~beta
  • 2.2.1~beta is newer than 2.2.1~alpha
  • 2.2.1~beta3 is newer than 2.2.1~beta2
  • 2.2.1~beta10 is newer than 2.2.1~beta1
Tip Tip: Text should only be added for a beta version. In other cases version number should only contain numbers.

name attribute

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.

provider-name attribute

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 (,).

<requires>

The <requires> element contains one or more <import> 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.

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.

Examples: Here is a sample <requires> block that imports two required modules:

<requires>
  <import addon="xbmc.python"               version="2.25.0" />
  <import addon="script.module.elementtree" version="1.2.7" />
</requires>

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:

<requires>
  <import addon="os.librelec.tv" version="2.0" />
</requires>

<import>

Each <import> element describes one dependency for an add-on, with two required attributes: addon and version. There is also an optional attribute called, fittingly, optional.

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 <import> element, since Kodi wouldn't know what to do with them.

addon attribute

The addon attribute specifies the id of the required add-on, e.g. script.module.elementtree.

version attribute

The version attribute specifies the minimum version of the required add-on to be installed.

Dependency versions

Each different Kodi version might require you to use a higher version of the xbmc.* add-on dependencies to control on which version of Kodi the add-on can be installed.

Each Kodi version contain a certain backwards compatibility. For example add-ons made for Gotham 13.x can still work on 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".

optional attribute

The dependency may be made optional by setting the optional attribute to true. 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.

<extension>

The <extension> 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 addon.xml file for the Confluence skin extends the xbmc.gui.skin part of xbmc. All available extension points are given below.

point attribute

The various extension points that Kodi provides are given in the list below.

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.

xbmc.python.pluginsource

The most common extension point that will be used by plugin addon developers is xbmc.python.pluginsource.

library attribute

The <extension point="xbmc.python.pluginsource"> element has an extra attribute: library. 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.

<provides> element

The extension has an additional child element named <provides>, which contains a whitespace separated list of audio, executable, image and/or video. 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 pluginsource extension points):

Note: If the <provides> element is not defined, behavior will depend on the structure of your add-on. 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 add-on will be shown in Programs). If your add-on has multiple extension points and none specifies a <provides> element, different entries for your add-on will be shown in "Programs" (multiple fallbacks to "executable"). If your add-on 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 add-on's 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 add-on from the interface.

Example:

<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py">
  <provides>audio video</provides>
</extension>
xbmc.addon.metadata

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. 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.

Localization

Language specific elements must always be present in English as a minimum. Many of these elements can be translated into multiple languages and should be added once for each supported language. The lang attribute should contain a 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)

<summary>

One or more <summary> elements provide a short summary of what the add-on does. This should be a single sentence. It may be translated into multiple languages.

Example: <summary lang="en_GB">Hello World script provides some basic examples on how to create your first script.</summary>

<description>

One or more <description> elements provide a more detailed summary of what the add-on does. It may be translated into multiple languages.

Example:

<description lang="en_GB">Hello World script provides some basic examples on how to create your first script and hopefully will increase the number of Kodi users to start creating their own addons.</description>
<disclaimer>

One or more <disclaimer> 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.

Example: <disclaimer lang="en_GB">Feel free to use this script. For information visit the wiki.</disclaimer>

<news>

Note: Used in Kodi v17 Krypton and later only. Older versions are forward compatible.

The <news> 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.) Please keep it short (it's limited to 1500 characters); you might want to only include the changes for the last version here.

Here is an example:

<news>v0.1.2  (2014-01-15)
- Added notification for Ubuntu users checking through apt command</news>
<platform>

The <platform> tag specifies which platforms (operating systems, hardware, architecture) this add-on runs on. Many add-ons will run on all platforms, so all is an option. If the platform tag is missing, we assume the add-on runs on all platforms. A space-delimited combination of these is also possible. Currently available options are:

  • all
  • linux
  • osx
  • osx64
  • osx-x86_64
  • osx32
  • osx-i686
  • ios
  • ios-armv7
  • ios-aarch64
  • windx
  • windows
  • windows-i686
  • windows-x86_64
  • windowsstore
  • android
  • android-armv7
  • android-aarch64
  • android-i686

Note: Kodi v19 Matrix and later.

  • tvos
  • tvos-aarch64

Example: <platform>linux osx-x86_64 windows-x86_64</platform>

<language>

The <language> 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.

Example: <language>en de fr</language>

<license>

The <license> element indicates what license is used for this add-on. In general, the SPDX License Expression for the license(s) are preferable to the full license name:

Examples:
SPDX License Expression: <license>GPL-2.0-or-later</license>
vs
Full license name: <license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>

If your add-on includes multiple licenses:

  • Separate license names using | (the pipe or vertical bar character) when there is a choice between licenses:
    • <license>GPL-2.0-or-later | LGPL-2.0-or-later</license>
  • Separate license names using & (ampersand), or , (comma), when multiple licenses exist that cover different parts of the source.
    • <license>GPL-2.0-or-later & MIT</license>
    • <license>GPL-2.0-or-later, MIT</license>
<forum>

The <forum> element provides the forum thread URL for this specific add-on. Omit this element if there is no forum thread.

Example: <forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum>

<website>

The <website> element provides the website URL for this specific add-on.

Example: <website>https://www.myaddonwebsite.com/</website>

<source>

The <source> element provides the URL for the source code for this specific add-on.

Example: <source>https://github.com/someone/myaddon</source>

<email>

The <email> element provides the e-mail address of the author, if they wish to do so for this specific add-on. Here are two examples of how you can format it (the second one is harder for spambots to scrape). This can be left blank if you do not wish to make your e-mail address public.

Examples:

<lifecyclestate>

Note: Kodi v19 Matrix and later.

The <lifecyclestate> element 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 add-on installed, so please try to be specific about the underlying reason for the tag. Also, the <lifecyclestate> tag presupposes that a version bump has been made to the add-on.

Example: <lifecyclestate type="deprecated">Description why deprecated</lifecyclestate>

At your discretion, it can also be translated into several languages.

<lifecyclestate type="broken" lang="en_GB">Description why broken</lifecyclestate>

Valid values for type attribute
Value Meaning
broken To mark add-on as broken and no more usable.
deprecated To mark add-on as deprecated and that it has been replaced by another add-on.
normal (Default) To set add-on as normal. This value is not really needed, but made available to be able to declare all possible life paths.
<broken>

Note: Kodi v18 Leia and earlier. For Matrix and later, see § <lifecyclestate>

The <broken> element 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 underlying reason for the tag. Also, the broken tag presupposes that a version bump has been made to the add-on.

Example: <broken>deprecated</broken>

<assets>

Note: Kodi v17 Krypton and later.

The <assets> element is a manifest that describes the various assets the add-on provides and where they are located. Supported sub-elements (some optional) are:

  • <icon> See icon.png - if an icon.png file exists it must be listed here (mandatory since Kodi v17 Krypton)
  • <fanart> See fanart.jpg - if a fanart.jpg file exists it must be listed here (mandatory since Kodi v17 Krypton)
  • <screenshot> See screenshots - (optional)

Note: Kodi v18 Leia and later.

If some elements are empty or not specified, they will be treated as non-existent/not provided. Of all the above sub-elements, only <icon> and <fanart> are mandatory for add-ons since Kodi v17 Krypton and later.

Example:

<assets>
    <icon>resources/icon.png</icon>
    <fanart>resources/fanart.jpg</fanart>
    <banner>resources/banner.jpg</banner>
    <clearlogo>resources/clearlogo.png</clearlogo>
    <screenshot>resources/screenshot-01.jpg</screenshot>
    <screenshot>resources/screenshot-02.jpg</screenshot>
    <screenshot>resources/screenshot-03.jpg</screenshot>
    <screenshot>resources/screenshot-04.jpg</screenshot>
  </assets>

With the above example definition, the files must be placed in the resources folder.

<reuselanguageinvoker>

Note: Kodi v18 Leia and later.

The <reuselanguageinvoker> element is a feature introduced with Kodi 18.0 "Leia" that changes the way the Python invoker works - specifically, attempting to reuse the invoker instances as much as possible. As a result, the add-on performance should be greatly improved. However, note that for the element to work, some changes may be required in your add-on. Namely, since the invoker is reused, make sure sys.argv is always passed to your entrypoint and propagated throughout your codebase. Do not store it as a class variable.

Example: <reuselanguageinvoker>true</reuselanguageinvoker>

Furthermore, it is advised to set this element to false while developing the add-on, only setting its value to true for the production version (after testing).

Skin-specific elements

<effectslowdown> A multiplier that is applied to all <animation> effects lengths in the skin; useful for globally slowing down all animations so that you can better configure timings and see interactions between animating controls.
<debugging> When set to true, it will display on-screen debugging information (XML filename, mouse position and focused control type/name) on top of the skin.
<res> Support for arbitrary skin resolutions.

How window xml files are found

Kodi can run in many different resolutions, and a skin should try and cater to all of them. 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.

However, you may choose to develop alternative window xml files for differing resolutions (such as for HDTV resolutions, or for widescreen versus 4:3 aspect ratios).

The order that Kodi looks for it's skin files are as follows:

  1. It first looks in the current screenmode folder (one of 1080i, 720p, NTSC16x9, NTSC, PAL16x9 or PAL)
  2. If the current screenmode is 1080i and there's no 1080i folder, it then looks in the 720p folder.
  3. Finally, it looks in the res folder.

This allows you to just put any window files that do not require special treatment for 16:9 aspect ratios, etc., in the <defaultresolution> folder, preventing needless repetition.

Examples

Skin add-on

<?xml version="1.0" encoding="UTF-8"?>
<addon id="skin.estuary" version="3.0.10" name="Estuary" provider-name="phil65, Ichabod Fletchman">
  <requires>
    <import addon="xbmc.gui" version="5.16.0" />
  </requires>
  <extension point="xbmc.gui.skin" debugging="false">
    <res width="1920" height="1440" aspect="4:3" default="false" folder="xml" />
    <res width="1920" height="1280" aspect="3:2" default="false" folder="xml" />
    <res width="1920" height="1200" aspect="16:10" default="false" folder="xml" />
    <res width="2040" height="1080" aspect="17:9" default="false" folder="xml" />
    <res width="1920" height="1080" aspect="16:9" default="true" folder="xml" />
    <res width="2560" height="1080" aspect="21:9" default="false" folder="xml" />
    <res width="2338" height="1080" aspect="19.5:9" default="false" folder="xml" />
    <res width="2160" height="1080" aspect="18:9" default="false" folder="xml" />
  </extension>
  <extension point="xbmc.addon.metadata">
    <platform>all</platform>
    <license>CC BY-SA 4.0, GNU GENERAL PUBLIC LICENSE Version 2.0</license>
    <forum>https://forum.kodi.tv/</forum>
    <source>https://github.com/xbmc/xbmc/tree/master/addons/skin.estuary</source>
    <assets>
      <icon>resources/icon.png</icon>
      <fanart>resources/fanart.jpg</fanart>
      <screenshot>resources/screenshot-01.jpg</screenshot>
      <screenshot>resources/screenshot-02.jpg</screenshot>
      <screenshot>resources/screenshot-03.jpg</screenshot>
      <screenshot>resources/screenshot-04.jpg</screenshot>
      <screenshot>resources/screenshot-05.jpg</screenshot>
      <screenshot>resources/screenshot-06.jpg</screenshot>
      <screenshot>resources/screenshot-07.jpg</screenshot>
      <screenshot>resources/screenshot-08.jpg</screenshot>
    </assets>
    <summary lang="en_GB">Estuary skin by phil65. (Kodi&apos;s default skin)</summary>
    <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>
    <disclaimer lang="en_GB">Estuary is the default skin for Kodi, removing it may cause issues</disclaimer>
  </extension>
</addon>

One thing to note is that all tag names are lower case. XML tag names are case-sensitive!

Script add-on

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="script.artwork.downloader" name="Artwork Downloader" version="12.0.28" provider-name="Martijn">
  <requires>
    <import addon="xbmc.python"                version="2.1.0" />
    <import addon="xmbc.json"                  version="6.0.0" />
    <import addon="xbmc.addon"                 version="12.0.0" />
    <import addon="script.module.simplejson"   version="3.3.0" />
    <import addon="script.common.plugin.cache" version="1.3.0" />
  </requires>
  <extension point="xbmc.python.script"        library="default.py">
    <provides>executable</provides>
  </extension>
  <extension point="xbmc.addon.metadata">
    <summary lang="en_GB">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary>
    <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>
    <disclaimer lang="en_GB">For bugs, requests or general questions visit the Artwork Downloader thread on the XBMC forum.</disclaimer>
    <platform>all</platform>
    <license>GPL-2.0-or-later</license>
    <forum>https://forum.kodi.tv/showthread.php?tid=114633</forum>
    <website>https://kodi.wiki/view/Add-on:Artwork_Downloader</website>
    <email>[email protected]</email>
    <source>https://github.com/XBMC-Addons/script.artwork.downloader</source>
    <news>
      v12.0.28
        - Don't set simplejson module to optional
      v12.0.27
        - Fix wrong order of listing using votes for artwork from fanart.tv
      …
    </news>
    <assets>
        <icon>resources/images/icon.png</icon>
        <fanart>resources/images/fanart.png</fanart>
        <screenshot>resources/images/screenshot.png</screenshot>
    </assets>
  </extension>
</addon>

Common errors

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:

  1. Invalid characters - does any of your description text, addon name, etc. have any of the following? !, ?, -, etc
  2. Too large description can sometimes cause issues
  3. You may have an opening tag but not a closing tag further in the file e.g. <description> but not later on </description>
  4. 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):
    • .kodi/addons/temp
    • .kodi/temp/temp
    • .kodi/temp/archive_cache

Schema Definition

The XML schema definition for addon.xml is located here.