Official Kodi Wiki - User contributions [en]

Add-on rules

2016-05-22T16:11:41Z

Learningit: /* Repository Submission Guidelines - Please Read Before Submitting Your Addon */

{{mininav|[[Development]]|[[Add-on development]]}}

=== Repository Submission Guidelines - Please Read Before Submitting Your Addon ===

Inclusion in the Kodi.org repository is at the sole discretion of Team Kodi. Because maintaining such a large repository is a large task, we have set some guidelines for inclusion. Please ensure that these guidelines are met before submitting request to be added.
In order to be considered for the official repository, the following guidelines must be met:
* All add-ons must be developed as described on the [[Add-on development]] page.
* You ''must'' include a license file (named LICENSE.txt). We recommend the [http://creativecommons.org/choose/non-web-popup?license_code=by-sa&jurisdiction=&version=3.0&lang=en CC-BY-SA 3.0] for skins and the [http://www.gnu.org/licenses/gpl-howto.html GPL v2+] for others, but most copy left licenses will suffice. Please investigate which license suits your needs and you fully understand the contents.
* All files must be free and legal to distribute.
* The add-on must not violate any known copyright laws - if in doubt, let us know and we'll look into it for you.
* All source files must be included. No pre-compiled files will be allowed.
* You acknowledge that you are the maintainer of your add-on.
* Team-Kodi reserves the right to update or remove it at any time as we deem necessary.
* If a new stable Kodi is going to be released no new submissions are accepted to the repository for the previous version. This will start from when the first [http://en.wikipedia.org/wiki/Release_candidate#Release_candidate release candidate (RC)] of the new version is released. Only fixes and updates will be accepted and processed for the previous version (e.g. if the current stable is 13.x, no updates are allowed for 11.x any more). See: [[Submitting Add-ons#Allowed submissions|Allowed submissions]]
* Monetization of add-ons (for instance advertising or paid subscriptions) will not be allowed. We can make an exception in case you own the copyright for the content the add-on provides. Please contact us on the forum (or add-on mailing list) if you believe such an exception may apply to your add-on.
* All xbmc.python.module addons must be used by at least one other add-on in official repository.

=== Updates ===
Keep in mind that add-ons in the official repository should be considered ''stable''. This means that they should be well-tested before you submit them for inclusion.
Because they are for stable users, they should avoid being updated too often. Too often is of course subjective. If your add-on is in rapid development, and features are constantly being added, hold off until you have hit a good stopping point and ''tested'' the current version.

This means that you should ''not'' submit a request every time you change your code. If you are submitting updates more than once per week something is wrong. Once or twice per month is probably a better goal, barring unforeseen conditions (like a content source changing its paths). With good reasons provided we will of course make exceptions as we strive to prove the best user experience.

=== General requirements ===
Here's a list of what basic sanity checks are done by repository maintainer on each submission.

'''Basic file checks:'''

* all strings used by add-ons must be localized, no hard-coded language strings should ever be used
* all paths should be treated as case-sensitive, so that they work on all OSs and file systems.
* all paths and files should be lower-case due to the previous point
** exceptions are README, COPYING, LICENSE.txt that should be upper-case and the "Default" directory in <tt>resources/skins</tt>, for add-ons that need it.
* exception are the translation Language folders with should be first letter capitalised.
* the following file-types are not allowed: .so .dll .pyo .exe .xbt .xpr Thumbs.db and so on<any binary files>
* all text files should use UNIX end-of-line
* all .xml files must pass xml validation
* all .xml files must have xml declaration as header
* all .xml/.txt must have unix style EOL's
* don't use a BOM at the start of your files
* file permissions: files should not be marked as executable
* filenames must have correct encoding (for skins: check your studio logos for corrupt filenames)

'''Things that must be included:'''

* [[Add-on structure#addon.xml|addon.xml]] must contain correct and valid info / version
* [[Add-on structure#icon.png|icon.png]] must be present (256x256)
* [[Add-on structure#fanart.jpg|fanart.jpg]] must be present (1280x720 or 1920x1080)
* [[Add-on structure#LICENSE.txt|LICENCE.txt]] must be present
* [[Add-on structure#changelog.txt|changelog.txt]] must be present
*: start with last changes at top of the file
{{See also|Add-on_structure}}

'''Things that can't be included:'''

* no .xbt files (these will be generated by our repository)
* no other add-ons included (skinners: if you need a script, submit it separately and depend on it)
* don't include unneeded files (.pdf, .doc, thumbs.db, etc...)
* no licensed fonts / background images / anything

=== Requirements for skins ===

'''Basic checks:'''

* The file size must be sane. There is no hard limit, but a 100mb skin is pushing it.
* No mods. Mods are great, and pop up frequently in the forums. But they are only confusing to non-forum-goers. This can be vague, each is evaluated on its own merit. By naming your "mod" different and make it substantial different enough, we will of course take it in consideration.
* Due to a bug in TexturePacker, all graphics files should have a resolution of at least 4x4.
* themes must be in a subfolder of the themes/ folder in the skin root (eg. skin.foo/themes/blue/<files>). The .xbt file will be created by our repo backend.
* If you want to have some images outside of Textures.xbt, then make sure you place those images outside of the media/ folder and reference them using special://skin/backdrops/* or similar. This is most useful for backgrounds - it keeps the size of the packed textures down. Any images you have in the media/ folder will be placed in Textures.xbt in the official repository.
* Please be careful with addon dependencies. Only add dependencies that are needed for the skin to function properly.

'''Things that must be included:'''

* _screenshots folder must be present, containing max. 10 .jpg screenshots (1280x720) with a reasonable file size.

'''Code checks:'''

* all labels must be localized
* code should be case-sensitive
* skins should not create warning/errors in the logfile, this can be a lot of things:
:* invalid includes
:* undefined actions
:* unable to evaluate condition
:* undefined vars
:* can't focus 'id'

{{Note|This of course also applies to script add-ons that use skin files}}

==== Optional support ====

This is optional and should not block inclusion in official repo.

* mouse support
* touchscreen support
* peripheral dialogs
* PVR support
* ADSP support
* RDS support

=== Requirements for scripts and plugins ===

* all special:// paths should be translated using xbmc.translatePath("special://foo/bar")
* xbmc.translatePath(xbmcaddon.Addon().getAddonInfo('path')).decode('utf-8') should be used for files included with the add-on
* xbmc.translatePath(xbmcaddon.Addon().getAddonInfo('profile')).decode('utf-8') should be used for storing add-on related files
* direct access to the Kodi database is '''not''' allowed. You must use [[JSON RPC]] for this.
* directly using analytics (Google Analytics for example) from within add-ons is not allowed. This should be handled server side by using user-agent.
* addons should use the xbmc.log() method to write to the logfile and use the debug logging level only. print statements should not be used.
* add-ons should store all their data in their own subfolder inside the addon_data directory. Access (read/write/delete) to any other files / folders is not allowed by default.
''Exceptions to this rule may be granted in specific cases only. Please contact Team XBMC's add-on repository maintainers via the add-on mailing list if your add-on needs access to such files.''
In case we grant such an exception for your addon, access (read/write/delete) to other files/directories must be opt-in by the user, and be clear for the user to understand what is being accessed.

'''Things that shouldn't be included:'''

* _screenshots folder (only in remote cases it could have some added value)

=== Requirements for scrapers ===
* scraper must return the following minimum information: movie title, year, plot, cast, poster, fanart
* use 'chain function' for calling functions in common scrapers
* remove the deprecated XML tags from the scraper header in case you use a scraper editor made for pre-Dharma versions of XBMC

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

Audio-video add-on tutorial

2015-06-19T02:53:34Z

Learningit:

{{mininav|[[Development]]|[[Add-on development]]}}

This page will outline the basics of creating your first Python add-on for XBMC. It assumes you're at least familiar with the basics of Python (or at least, programming in general). If not, we recommend visiting the [http://docs.python.org/2/tutorial/ Python tutorial] first, and then returning here.

= Before we get started =
{{See also|Add-on structure}}

The first step to making an add-on is to put the basic structure in place. Make sure your directory is properly named, e.g. <code>plugin.video.my-addon</code>, and that you have a properly-constructed <code>[[addon.xml]]</code> file. Once these are done, you can get started writing the actual code for your add-on!

= Hello, World! =

The simplest form of Python add-on is one that gets run, adds some list items, and exits to let Kodi take over the navigation; people who have written server-side code for the web should be familiar with how this works. (More complex add-ons can process user input in real-time, but we'll discuss those later.) Let's start by looking at an extremely basic example script:

<syntaxhighlight lang="python" enclose="div">
import sys
import xbmcgui
import xbmcplugin

addon_handle = int(sys.argv[1])

xbmcplugin.setContent(addon_handle, 'movies')

url = 'http://localhost/some_video.mkv'
li = xbmcgui.ListItem('My First Video!', iconImage='DefaultVideo.png')
xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)

xbmcplugin.endOfDirectory(addon_handle)
</syntaxhighlight>

While not particularly exciting, this shows the minimal amount of code you need to get an Kodi add-on up and running in Python. First, we get the add-on's process handle from <code>sys.argv[1]</code>. We need this to tell Kodi who we are. Next, we tell Kodi that we're going to show a list of <code>'movies'</code>. There are other options, like <code>'audio'</code> or <code>'episodes'</code>; these just change some details of how Kodi presents your add-on.

The most important part is that we create an <code>xbmcgui.ListItem</code> with the name and icon we want (<code>'DefaultVideo.png'</code> comes from the Kodi skin), set it to be a video item, and then add it to the directory. Once we're done adding items, we need to be sure to call <code>xbmcplugin.endOfDirectory</code> to let Kodi know we're done!

= Navigating between pages =

While the first example might be enough for extremely simple add-ons, most add-ons will want to have the ability to navigate between different pages. Most add-ons are designed to imitate a folder hierarchy where opening folder items shows a different list of items, and going "up" returns you to the parent folder.

== Retrieving arguments ==

As we saw in the first example, Kodi passes some arguments to us via <code>sys.argv</code>. This is important, since it's what will let us tailor the output on the add-on based on user input. Remember, much like a web site, each folder (or page) in an Kodi add-on is the result of a separate invocation of our script. The arguments available to us are:

{| class="prettytable"
! Index !! Description
|-
| 0 || The base URL of your add-on, e.g. <code>'plugin://plugin.video.myaddon/'</code>
|-
| 1 || The process handle for this add-on, as a numeric string
|-
| 2 || The query string passed to your add-on, e.g. <code>'?foo=bar&baz=quux'</code>
|}

Of particular interest is <code>sys.argv[2]</code>, which is what we'll generally use to show different things in the add-on.

=== Multiple content types ===
{{See also|Addon.xml#<provides> element}}

If your add-on provides multiple content types, e.g. <code>audio</code> and <code>video</code>, when the user invokes your add-on from the add-on list, Kodi will add a <code>content_type</code> parameter to your add-on's query string. For example: <code>'?content_type=audio'</code>. This will allow you to modify the output depending on what context your add-on was invoked in.

== Passing arguments ==

Now that we know how to retrieve the arguments passed to our add-on, we'll have to actually pass some along to it. Generally speaking, this involves creating a folder <code>ListItem</code> with a URL back to your add-on; then the next invocation of the add-on will parse those arguments and do something with them. Let's look at another brief example that adds some folders to let the user navigate between different pages of the add-on:

<syntaxhighlight lang="python" enclose="div">
import sys
import urllib
import urlparse
import xbmcgui
import xbmcplugin

base_url = sys.argv[0]
addon_handle = int(sys.argv[1])
args = urlparse.parse_qs(sys.argv[2][1:])

xbmcplugin.setContent(addon_handle, 'movies')

def build_url(query):
return base_url + '?' + urllib.urlencode(query)

mode = args.get('mode', None)

if mode is None:
url = build_url({'mode': 'folder', 'foldername': 'Folder One'})
li = xbmcgui.ListItem('Folder One', iconImage='DefaultFolder.png')
xbmcplugin.addDirectoryItem(handle=addon_handle, url=url,
listitem=li, isFolder=True)

url = build_url({'mode': 'folder', 'foldername': 'Folder Two'})
li = xbmcgui.ListItem('Folder Two', iconImage='DefaultFolder.png')
xbmcplugin.addDirectoryItem(handle=addon_handle, url=url,
listitem=li, isFolder=True)

xbmcplugin.endOfDirectory(addon_handle)

elif mode[0] == 'folder':
foldername = args['foldername'][0]
url = 'http://localhost/some_video.mkv'
li = xbmcgui.ListItem(foldername + ' Video', iconImage='DefaultVideo.png')
xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)
xbmcplugin.endOfDirectory(addon_handle)
</syntaxhighlight>

As you can see, many parts of our code are very similar to the first example. There are a few important additions, however. First, we want to respond to the arguments supplied to our script, so we parse the query string with:

<syntaxhighlight lang="python" enclose="div">
urlparse.parse_qs(sys.argv[2][1:])
</syntaxhighlight>

We skip the first character, since it's always <code>'?'</code>. This will give us a <code>dict</code> of <code>list</code>s; for example, <code>'?foo=bar&foo=baz&quux=spam'</code> would be converted to <code>{'foo': ['bar', 'baz'], 'quux': ['spam']}</code>. With this information, we can tailor the output of our add-on to the supplied arguments.

We also need to be able to create links back to our add-on in order to display related pages (e.g. subfolders). We can do this by creating an <code>xbmc.ListItem</code>, passing <code>isFolder=True</code>, and setting the URL of the item to point back to our add-on. We create the URL in the helper function <code>build_url()</code>, which gives us a URL that looks something like:

plugin://plugin.video.myaddon/?mode=folder&foldername=Folder+One

= Working with user settings =
{{See also|Add-on settings}}

Your add-on may require some configurable options for the user (e.g. login credentials for a service). These can be stored as settings. To use settings with your add-on, you'll need to make a file defining the settings in <code>resources/settings.xml</code>. For example:

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings>
<setting id="my_setting" type="bool" default="true" label="My Setting"/>
</settings>
</syntaxhighlight>

This will allow the user to open the settings for your add-on and modify this setting as needed. Then, in your add-on, you can retrieve or set this setting with the following code:

<syntaxhighlight lang="python" enclose="div">
my_addon = xbmcaddon.Addon()
my_setting = my_addon.getSetting('my_setting') # returns the string 'true' or 'false'
my_addon.setSetting('my_setting', 'false')
</syntaxhighlight>

= Showing additional metadata =

We've already seen how to show some basic metadata, like the icon image and the type of the item (<code>'video'</code> in our case). However, there are many more pieces of metadata that Kodi understands, and adding them can make life easier on your users. We'll take a look at some of the more important ones. You can also find a full list in the [http://mirrors.kodi.tv/docs/python-docs Python documentation] for <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem xbmcgui.ListItem]</code>.

== Icons and thumbnails ==

Our previous examples already showed how to set an icon, but you can also set a larger thumbnail for each list item. Both of these can be set in the <code>ListItem</code> constructor:

<syntaxhighlight lang="python" enclose="div">
li = xbmcgui.ListItem(label='My video', iconImage='icon.png', thumbnailImage='thumbnail.png')
</syntaxhighlight>

You can also set these ''after'' creating the list item:

<syntaxhighlight lang="python" enclose="div">
li.setIconImage('icon.png')
li.setThumbnailImage('thumbnail.png')
</syntaxhighlight>

== Fanart ==

Fanart (full-screen background images) are another common thing for add-ons to show. This works a bit differently from icons and thumbnails, but it's still a simple process:

<syntaxhighlight lang="python" enclose="div">
li.setProperty('fanart_image', 'fanart.jpg')
</syntaxhighlight>

If you'd prefer to show the default fanart from your add-on, you can get the path to that image from the <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcaddon.html#Addon xbmcaddon.Addon]</code> object:

<syntaxhighlight lang="python" enclose="div">
my_addon = xbmcaddon.Addon('plugin.video.myaddon')
# ...
li.setProperty('fanart_image', my_addon.getAddonInfo('fanart'))
</syntaxhighlight>

== Info labels ==

XBMC also lets you add useful information about each list item, like the cast, episode number, play count, and duration. The specific fields available depend on whether your list item is video, audio, or a picture. In all cases though, the format is roughly the same. For example, to add info labels to a movie, you might do the following:

<syntaxhighlight lang="python" enclose="div">
li.setInfo('video', { 'genre': 'Horror',
'year': 1979,
'title': 'Alien' })
</syntaxhighlight>

For a full list of the available info labels, consult the documentation for <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem-setInfo ListItem.setInfo]</code>.

== Stream info ==

In addition to metadata about the file's contents, you can add information about the audio/video streams themselves. For a video, you might do the following:

<syntaxhighlight lang="python" enclose="div">
li.addStreamInfo('video', { 'codec': 'h264', 'aspect': 1.78, 'width': 1280,
'height': 720, 'duration': 60 })
li.addStreamInfo('audio', { 'codec': 'dts', 'language': 'en', 'channels': 2 })
li.addStreamInfo('subtitle', { 'language': 'en' })
</syntaxhighlight>

For complete documentation about this function, see <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem-addStreamInfo ListItem.addStreamInfo]</code>.

= Adding context menus =

In addition to the default action for a list item (e.g. playing the video), your add-on can provide additional actions for an item in the context menu. Note that this only applies to list items in ''your'' add-on. Currently, you're not able to modify the context menu for movies in the user's library. To add a context menu item, you need to give it a label and a [[List of built-in functions|built-in function]] as a string:

<syntaxhighlight lang="python" enclose="div">
li.addContextMenuItems([ ('Refresh', 'Container.Refresh'),
('Go up', 'Action(ParentDir)') ])
</syntaxhighlight>

You can also elect to show ''only'' your context menu items:

<syntaxhighlight lang="python" enclose="div">
li.addContextMenuItems([ ('Refresh', 'Container.Refresh') ], replaceItems=True)
</syntaxhighlight>

[[Category:Add-on development|*]]

Audio-video add-on tutorial

2015-06-19T02:43:26Z

Learningit:

{{mininav|[[Development]]|[[Add-on development]]}}

This page will outline the basics of creating your first Python add-on for XBMC. It assumes you're at least familiar with the basics of Python (or at least, programming in general). If not, we recommend visiting the [http://docs.python.org/2/tutorial/ Python tutorial] first, and then returning here.

= Before we get started =
{{See also|Add-on structure}}

The first step to making an add-on is to put the basic structure in place. Make sure your directory is properly named, e.g. <code>plugin.video.my-addon</code>, and that you have a properly-constructed <code>[[addon.xml]]</code> file. Once these are done, you can get started writing the actual code for your add-on!

= Hello, World! =

The simplest form of Python add-on is one that gets run, adds some list items, and exits to let Kodi take over the navigation; people who have written server-side code for the web should be familiar with how this works. (More complex add-ons can process user input in real-time, but we'll discuss those later.) Let's start by looking at an extremely basic example script:

<syntaxhighlight lang="python" enclose="div">
import sys
import xbmcgui
import xbmcplugin

addon_handle = int(sys.argv[1])

xbmcplugin.setContent(addon_handle, 'movies')

url = 'http://localhost/some_video.mkv'
li = xbmcgui.ListItem('My First Video!', iconImage='DefaultVideo.png')
li.setProperty('IsPlayable', 'true')
xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)

xbmcplugin.endOfDirectory(addon_handle)
</syntaxhighlight>

While not particularly exciting, this shows the minimal amount of code you need to get an Kodi add-on up and running in Python. First, we get the add-on's process handle from <code>sys.argv[1]</code>. We need this to tell Kodi who we are. Next, we tell Kodi that we're going to show a list of <code>'movies'</code>. There are other options, like <code>'audio'</code> or <code>'episodes'</code>; these just change some details of how Kodi presents your add-on.

The most important part is that we create an <code>xbmcgui.ListItem</code> with the name and icon we want (<code>'DefaultVideo.png'</code> comes from the Kodi skin), set it to be a video item, and then add it to the directory. Once we're done adding items, we need to be sure to call <code>xbmcplugin.endOfDirectory</code> to let Kodi know we're done!

= Navigating between pages =

While the first example might be enough for extremely simple add-ons, most add-ons will want to have the ability to navigate between different pages. Most add-ons are designed to imitate a folder hierarchy where opening folder items shows a different list of items, and going "up" returns you to the parent folder.

== Retrieving arguments ==

As we saw in the first example, Kodi passes some arguments to us via <code>sys.argv</code>. This is important, since it's what will let us tailor the output on the add-on based on user input. Remember, much like a web site, each folder (or page) in an Kodi add-on is the result of a separate invocation of our script. The arguments available to us are:

{| class="prettytable"
! Index !! Description
|-
| 0 || The base URL of your add-on, e.g. <code>'plugin://plugin.video.myaddon/'</code>
|-
| 1 || The process handle for this add-on, as a numeric string
|-
| 2 || The query string passed to your add-on, e.g. <code>'?foo=bar&baz=quux'</code>
|}

Of particular interest is <code>sys.argv[2]</code>, which is what we'll generally use to show different things in the add-on.

=== Multiple content types ===
{{See also|Addon.xml#<provides> element}}

If your add-on provides multiple content types, e.g. <code>audio</code> and <code>video</code>, when the user invokes your add-on from the add-on list, Kodi will add a <code>content_type</code> parameter to your add-on's query string. For example: <code>'?content_type=audio'</code>. This will allow you to modify the output depending on what context your add-on was invoked in.

== Passing arguments ==

Now that we know how to retrieve the arguments passed to our add-on, we'll have to actually pass some along to it. Generally speaking, this involves creating a folder <code>ListItem</code> with a URL back to your add-on; then the next invocation of the add-on will parse those arguments and do something with them. Let's look at another brief example that adds some folders to let the user navigate between different pages of the add-on:

<syntaxhighlight lang="python" enclose="div">
import sys
import urllib
import urlparse
import xbmcgui
import xbmcplugin

base_url = sys.argv[0]
addon_handle = int(sys.argv[1])
args = urlparse.parse_qs(sys.argv[2][1:])

xbmcplugin.setContent(addon_handle, 'movies')

def build_url(query):
return base_url + '?' + urllib.urlencode(query)

mode = args.get('mode', None)

if mode is None:
url = build_url({'mode': 'folder', 'foldername': 'Folder One'})
li = xbmcgui.ListItem('Folder One', iconImage='DefaultFolder.png')
xbmcplugin.addDirectoryItem(handle=addon_handle, url=url,
listitem=li, isFolder=True)

url = build_url({'mode': 'folder', 'foldername': 'Folder Two'})
li = xbmcgui.ListItem('Folder Two', iconImage='DefaultFolder.png')
xbmcplugin.addDirectoryItem(handle=addon_handle, url=url,
listitem=li, isFolder=True)

xbmcplugin.endOfDirectory(addon_handle)

elif mode[0] == 'folder':
foldername = args['foldername'][0]
url = 'http://localhost/some_video.mkv'
li = xbmcgui.ListItem(foldername + ' Video', iconImage='DefaultVideo.png')
li.setProperty('IsPlayable', 'true')
xbmcplugin.addDirectoryItem(handle=addon_handle, url=url, listitem=li)
xbmcplugin.endOfDirectory(addon_handle)
</syntaxhighlight>

As you can see, many parts of our code are very similar to the first example. There are a few important additions, however. First, we want to respond to the arguments supplied to our script, so we parse the query string with:

<syntaxhighlight lang="python" enclose="div">
urlparse.parse_qs(sys.argv[2][1:])
</syntaxhighlight>

We skip the first character, since it's always <code>'?'</code>. This will give us a <code>dict</code> of <code>list</code>s; for example, <code>'?foo=bar&foo=baz&quux=spam'</code> would be converted to <code>{'foo': ['bar', 'baz'], 'quux': ['spam']}</code>. With this information, we can tailor the output of our add-on to the supplied arguments.

We also need to be able to create links back to our add-on in order to display related pages (e.g. subfolders). We can do this by creating an <code>xbmc.ListItem</code>, passing <code>isFolder=True</code>, and setting the URL of the item to point back to our add-on. We create the URL in the helper function <code>build_url()</code>, which gives us a URL that looks something like:

plugin://plugin.video.myaddon/?mode=folder&foldername=Folder+One

= Working with user settings =
{{See also|Add-on settings}}

Your add-on may require some configurable options for the user (e.g. login credentials for a service). These can be stored as settings. To use settings with your add-on, you'll need to make a file defining the settings in <code>resources/settings.xml</code>. For example:

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings>
<setting id="my_setting" type="bool" default="true" label="My Setting"/>
</settings>
</syntaxhighlight>

This will allow the user to open the settings for your add-on and modify this setting as needed. Then, in your add-on, you can retrieve or set this setting with the following code:

<syntaxhighlight lang="python" enclose="div">
my_addon = xbmcaddon.Addon()
my_setting = my_addon.getSetting('my_setting') # returns the string 'true' or 'false'
my_addon.setSetting('my_setting', 'false')
</syntaxhighlight>

= Showing additional metadata =

We've already seen how to show some basic metadata, like the icon image and the type of the item (<code>'video'</code> in our case). However, there are many more pieces of metadata that Kodi understands, and adding them can make life easier on your users. We'll take a look at some of the more important ones. You can also find a full list in the [http://mirrors.kodi.tv/docs/python-docs Python documentation] for <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem xbmcgui.ListItem]</code>.

== Icons and thumbnails ==

Our previous examples already showed how to set an icon, but you can also set a larger thumbnail for each list item. Both of these can be set in the <code>ListItem</code> constructor:

<syntaxhighlight lang="python" enclose="div">
li = xbmcgui.ListItem(label='My video', iconImage='icon.png', thumbnailImage='thumbnail.png')
</syntaxhighlight>

You can also set these ''after'' creating the list item:

<syntaxhighlight lang="python" enclose="div">
li.setIconImage('icon.png')
li.setThumbnailImage('thumbnail.png')
</syntaxhighlight>

== Fanart ==

Fanart (full-screen background images) are another common thing for add-ons to show. This works a bit differently from icons and thumbnails, but it's still a simple process:

<syntaxhighlight lang="python" enclose="div">
li.setProperty('fanart_image', 'fanart.jpg')
</syntaxhighlight>

If you'd prefer to show the default fanart from your add-on, you can get the path to that image from the <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcaddon.html#Addon xbmcaddon.Addon]</code> object:

<syntaxhighlight lang="python" enclose="div">
my_addon = xbmcaddon.Addon('plugin.video.myaddon')
# ...
li.setProperty('fanart_image', my_addon.getAddonInfo('fanart'))
</syntaxhighlight>

== Info labels ==

XBMC also lets you add useful information about each list item, like the cast, episode number, play count, and duration. The specific fields available depend on whether your list item is video, audio, or a picture. In all cases though, the format is roughly the same. For example, to add info labels to a movie, you might do the following:

<syntaxhighlight lang="python" enclose="div">
li.setInfo('video', { 'genre': 'Horror',
'year': 1979,
'title': 'Alien' })
</syntaxhighlight>

For a full list of the available info labels, consult the documentation for <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem-setInfo ListItem.setInfo]</code>.

== Stream info ==

In addition to metadata about the file's contents, you can add information about the audio/video streams themselves. For a video, you might do the following:

<syntaxhighlight lang="python" enclose="div">
li.addStreamInfo('video', { 'codec': 'h264', 'aspect': 1.78, 'width': 1280,
'height': 720, 'duration': 60 })
li.addStreamInfo('audio', { 'codec': 'dts', 'language': 'en', 'channels': 2 })
li.addStreamInfo('subtitle', { 'language': 'en' })
</syntaxhighlight>

For complete documentation about this function, see <code>[http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/xbmcgui.html#ListItem-addStreamInfo ListItem.addStreamInfo]</code>.

= Adding context menus =

In addition to the default action for a list item (e.g. playing the video), your add-on can provide additional actions for an item in the context menu. Note that this only applies to list items in ''your'' add-on. Currently, you're not able to modify the context menu for movies in the user's library. To add a context menu item, you need to give it a label and a [[List of built-in functions|built-in function]] as a string:

<syntaxhighlight lang="python" enclose="div">
li.addContextMenuItems([ ('Refresh', 'Container.Refresh'),
('Go up', 'Action(ParentDir)') ])
</syntaxhighlight>

You can also elect to show ''only'' your context menu items:

<syntaxhighlight lang="python" enclose="div">
li.addContextMenuItems([ ('Refresh', 'Container.Refresh') ], replaceItems=True)
</syntaxhighlight>

[[Category:Add-on development|*]]

Add-on:MeTV

2014-04-29T14:46:16Z

Learningit:

{{Addon
|Name=MeTV
|provider-name=t1m
|ID=plugin.video.metv
|latest-version=1.0.1
|extension point=xbmc.python.pluginsource
|provides=video
|Summary=MeTV Video Addon
|Description=Chosen from a wide array of genres, the programs of Me-TV pay tribute to classic television. Comedies like The Mary Tyler Moore Show, I Love Lucy, The Honeymooners and The Bob Newhart Show. Dramas such as Perry Mason, Ironside, The Streets of San Francisco, The Rockford Files and Columbo great westerns like Gunsmoke, Bonanza, The Rifleman and The Big Valley and otherworldly classics like Star Trek, Lost In Space and The Twilight Zone
|Platform=all
|Language=en
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=
|Website=http://www.metvnetwork.com
|Source=https://github.com/learningit/plugin.video.metv/
|Email=
|broken=
|icon url=http://mirrors.xbmc.org/addons/frodo/plugin.video.metv/icon.png}}

{{-}}
==Screenshots==
<img src="http://i.imgur.com/91GiZpl.png" border="0" alt="" width="880" height="495"/>

<img src="http://i.imgur.com/KgUlgCb.png" border="0" alt="" width="880" height="495"/>

<img src="http://i.imgur.com/drFqxez.png" border="0" alt="" width="880" height="495"/>

[[Category:Frodo add-on repository]]

Add-on:I24 News

2014-02-25T14:29:49Z

Learningit:

{{Addon
|Name=i24 News
|provider-name=t1m
|ID=plugin.video.i24News
|latest-version=1.0.1
|extension point=xbmc.python.pluginsource
|provides=video
|Summary=i24News XBMC Addon
|Description=i24News is an international 24-hour news and current affairs television channel based in Jaffa Port, Tel Aviv, Israel. It broadcasts in English, French and Arabic.
|Platform=all
|Language=en
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?tid=187224
|Website=
|Source=https://github.com/learningit/plugin.video.i24News
|Email=
|broken=
|icon url=http://mirrors.xbmc.org/addons/frodo/plugin.video.i24News/icon.png}}

==Screenshots==

<img src="http://i.imgur.com/RP208rV.png" border="0" alt="" width="880" height="495"/>

<img src="http://i.imgur.com/fBU9iof.png" border="0" alt="" width="880" height="495"/>

<img src="http://i.imgur.com/GEBoCFx.png" border="0" alt="" width="880" height="495"/>

[[Category:Frodo add-on repository]]

Add-on:I24 News

2014-02-25T14:29:06Z

Learningit:

{{Addon
|Name=i24 News
|provider-name=t1m
|ID=plugin.video.i24News
|latest-version=1.0.1
|extension point=xbmc.python.pluginsource
|provides=video
|Summary=i24News XBMC Addon
|Description=i24News is an international 24-hour news and current affairs television channel based in Jaffa Port, Tel Aviv, Israel. It broadcasts in English, French and Arabic.
|Platform=all
|Language=en
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?tid=187224
|Website=
|Source=https://github.com/learningit/plugin.video.i24News
|Email=
|broken=
|icon url=http://mirrors.xbmc.org/addons/frodo/plugin.video.i24News/icon.png}}

<img src="http://i.imgur.com/RP208rV.png" border="0" alt="" width="880" height="495"/>

<img src="http://i.imgur.com/fBU9iof.png" border="0" alt="" width="880" height="495"/>

<img src="http://i.imgur.com/GEBoCFx.png" border="0" alt="" width="880" height="495"/>

[[Category:Frodo add-on repository]]

Add-on:The Wall Street Journal Live

2013-11-24T13:51:44Z

Learningit:

{{Addon
|Name=The Wall Street Journal Live
|provider-name=t1m
|ID=plugin.video.wsj
|latest-version=1.7.2
|extension point=xbmc.python.pluginsource
|provides=video
|Summary=The Wall Street Journal Live
|Description=The Wall Street Journal Live XBMC Plugin
|Platform=all
|Language=en
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?tid=172865
|Website=
|Source=http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/
|Email=
|broken=
|icon url=http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/icon.png}}

{{-}}
==Screen shots==
<img src="http://i.imgur.com/FJ1HV9c.jpg" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/P1q1qDK.png" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/u2LFEgO.jpg" border="0" alt="" width="880" height="495" />

[[Category:Frodo add-on repository]]

Add-on:The Wall Street Journal Live

2013-11-24T13:50:40Z

Learningit:

{{Addon
|Name=The Wall Street Journal Live
|provider-name=t1m
|ID=plugin.video.wsj
|latest-version=1.7.2
|extension point=xbmc.python.pluginsource
|provides=video
|Summary=The Wall Street Journal Live
|Description=The Wall Street Journal Live XBMC Plugin
|Platform=all
|Language=en
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?tid=166867
|Website=
|Source=http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/
|Email=
|broken=
|icon url=http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/icon.png}}

{{-}}
==Screen shots==
<img src="http://i.imgur.com/FJ1HV9c.jpg" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/P1q1qDK.png" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/u2LFEgO.jpg" border="0" alt="" width="880" height="495" />

[[Category:Frodo add-on repository]]

Add-on:The Wall Street Journal Live

2013-09-12T03:37:54Z

Learningit:

{{forum link2|[[forum:172865|See {{color|blue|'''''The Wall Street Journal Live'' on the XBMC forum'''}} for more information]]}}
{{Add-on
|Name=The Wall Street Journal Live
|provider-name=learningit (t1m)
|Email=
|Website=
|Forum=
|ID=plugin.video.wsj
|latest-version=1.0.1
|extension point=xbmc.python.pluginsource
|provides= video
|Platform= all
|Language=
|License= GPL v2.0
|Source=
|Repo=
|icon url= http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/icon.png
| repo =
| zip =
|broken=
|Summary=The Wall Street Journal Live for XBMC
|Description=
}}



 
 

<img src="http://i.imgur.com/FJ1HV9c.jpg" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/P1q1qDK.png" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/u2LFEgO.jpg" border="0" alt="" width="880" height="495" />

[[Category:Frodo add-on repository]]

Add-on:The Wall Street Journal Live

2013-09-12T03:34:53Z

Learningit:

{{forum link2|[[forum:172865|See '''''The Wall Street Journal Live'' on the XBMC forum''' for more information]]}}
{{Add-on
|Name=The Wall Street Journal Live
|provider-name=learningit (t1m)
|Email=
|Website=
|Forum=
|ID=plugin.video.wsj
|latest-version=1.0.1
|extension point=xbmc.python.pluginsource
|provides= video
|Platform= all
|Language=
|License= GPL v2.0
|Source=
|Repo=
|icon url= http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/icon.png
| repo =
| zip =
|broken=
|Summary=The Wall Street Journal Live for XBMC
|Description=
}}



 
 

<img src="http://i.imgur.com/FJ1HV9c.jpg" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/P1q1qDK.png" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/u2LFEgO.jpg" border="0" alt="" width="880" height="495" />

[[Category:Frodo add-on repository]]

Add-on:The Wall Street Journal Live

2013-09-12T03:20:10Z

Learningit:

{{Add-on
|Name=The Wall Street Journal Live
|provider-name=learningit (t1m)
|Email=
|Website=
|Forum=
|ID=plugin.video.wsj
|latest-version=1.0.1
|extension point=xbmc.python.pluginsource
|provides= video
|Platform= all
|Language=
|License= GPL v2.0
|Source=
|Repo=
|icon url= http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/icon.png
| repo =
| zip =
|broken=
|Summary=The Wall Street Journal Live for XBMC
|Description=
}}


== XBMC Forum link for The Wall Street Journal Live ==
http://forum.xbmc.org/showthread.php?tid=172865 
 

<img src="http://i.imgur.com/FJ1HV9c.jpg" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/P1q1qDK.png" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/u2LFEgO.jpg" border="0" alt="" width="880" height="495" />

[[Category:Frodo add-on repository]]

Add-on:The Wall Street Journal Live

2013-09-12T03:16:10Z

Learningit:

{{Add-on
|Name=The Wall Street Journal Live
|provider-name=learningit (t1m)
|Email=
|Website=
|Forum=
|ID=plugin.video.wsj
|latest-version=1.0.1
|extension point=xbmc.python.pluginsource
|provides= video
|Platform= all
|Language=
|License=
|Source=
|Repo=
|icon url= http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/icon.png
| repo =
| zip =
|broken=
|Summary=The Wall Street Journal Live for XBMC
|Description=
}}


== XBMC Forum link for The Wall Street Journal Live ==
http://forum.xbmc.org/showthread.php?tid=172865 
 

<img src="http://i.imgur.com/FJ1HV9c.jpg" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/P1q1qDK.png" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/u2LFEgO.jpg" border="0" alt="" width="880" height="495" />

[[Category:Frodo add-on repository]]

Add-on:The Wall Street Journal Live

2013-09-12T02:10:15Z

Learningit:

{{Add-on
|Name=The Wall Street Journal Live
|provider-name=learningit (t1m)
|Email=
|Website=
|Forum=
|ID=plugin.video.wsj
|latest-version=1.0.1
|extension point=xbmc.python.pluginsource
|provides= video
|Platform= all
|Language=
|License=
|Source=
|Repo=
|icon url= http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/icon.png
| repo =
| zip =
|broken=
|Summary=The Wall Street Journal Live for XBMC
|Description=
}}



<img src="http://i.imgur.com/FJ1HV9c.jpg" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/P1q1qDK.png" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/u2LFEgO.jpg" border="0" alt="" width="880" height="495" />

[[Category:Frodo add-on repository]]

Add-on:The Wall Street Journal Live

2013-09-12T02:07:36Z

Learningit:

{{Add-on
|Name=The Wall Street Journal Live
|provider-name=learningit (t1m)
|Email=
|Website=
|Forum=
|ID=plugin.video.wsj
|latest-version=1.0.1
|extension point=xbmc.python.pluginsource
|provides= video
|Platform= all
|Language=
|License=
|Source=
|Repo=
|icon url= http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/icon.png
| repo = http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/
| zip =http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/plugin.video.wsj-1.0.1.zip
|broken=
|Summary=The Wall Street Journal Live for XBMC
|Description=
}}



<img src="http://i.imgur.com/FJ1HV9c.jpg" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/P1q1qDK.png" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/u2LFEgO.jpg" border="0" alt="" width="880" height="495" />

[[Category:Frodo add-on repository]]

Add-on:The Wall Street Journal Live

2013-09-12T01:05:53Z

Learningit:

{{Add-on
|Name=The Wall Street Journal Live
|provider-name=learningit
|Email=
|Website=
|Forum=
|ID=plugin.video.wsj
|latest-version=1.0.1
|extension point=xbmc.python.pluginsource
|provides= video
|Platform= all
|Language=
|License=
|Source=
|Repo=
|icon url= http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/icon.png
| repo = http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/
| zip =http://mirrors.xbmc.org/addons/frodo/plugin.video.wsj/plugin.video.wsj-1.0.1.zip
|broken=
|Summary=The Wall Street Journal Live for XBMC
|Description=
}}



<img src="http://i.imgur.com/FJ1HV9c.jpg" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/P1q1qDK.png" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/u2LFEgO.jpg" border="0" alt="" width="880" height="495" />

[[Category:Frodo add-on repository]]

Add-on:The Wall Street Journal Live

2013-09-12T00:41:32Z

Learningit:

{{Add-on
|Name=
|provider-name=
|Email=
|Website=
|Forum=
|ID=
|latest-version=
|extension point=
|provides=
|Platform=
|Language=
|License=
|Source=
|Repo=
|icon url=
| repo =
| zip =
|broken=
|Summary=
|Description=
}}



<img src="http://i.imgur.com/FJ1HV9c.jpg" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/P1q1qDK.png" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/u2LFEgO.jpg" border="0" alt="" width="880" height="495" />

Add-on:The Wall Street Journal Live

2013-09-12T00:28:08Z

Learningit:

{{Add-on
|Name=
|provider-name=
|Email=
|Website=
|Forum=
|ID=
|latest-version=
|extension point=
|provides=
|Platform=
|Language=
|License=
|Source=
|Repo=
|icon url=
| repo =
| zip =
|broken=
|Summary=
|Description=
}}



<img src="http://i.imgur.com/FJ1HV9c.jpg" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/P1q1qDK.png" border="0" alt="" width="880" height="495" /> <img src="http://i.imgur.com/u2LFEgO.jpg" border="0" alt="" width="880" height="495" />

[[Category:Add-ons not in the XBMC.org repo]]

Add-on:The Wall Street Journal Live

2013-09-12T00:04:10Z

Learningit:

{{Add-on
|Name=
|provider-name=
|Email=
|Website=
|Forum=
|ID=
|latest-version=
|extension point=
|provides=
|Platform=
|Language=
|License=
|Source=
|Repo=
|icon url=
| repo =
| zip =
|broken=
|Summary=
|Description=
}}



<img src="http://i.imgur.com/FJ1HV9c.jpg" border="0" alt="[Image: FJ1HV9c.jpg]" /> <img src="http://i.imgur.com/P1q1qDK.png" border="0" alt="[Image: P1q1qDK.png]" /> <img src="http://i.imgur.com/u2LFEgO.jpg" border="0" alt="[Image: u2LFEgO.jpg]" />

[[Category:Add-ons not in the XBMC.org repo]]

Add-on:The Wall Street Journal Live

2013-09-11T23:59:24Z

Learningit:

{{Add-on
|Name=
|provider-name=
|Email=
|Website=
|Forum=
|ID=
|latest-version=
|extension point=
|provides=
|Platform=
|Language=
|License=
|Source=
|Repo=
|icon url=
| repo =
| zip =
|broken=
|Summary=
|Description=
}}



[[Category:Add-ons not in the XBMC.org repo]]

Add-on:The Wall Street Journal Live

2013-09-11T23:55:35Z

Learningit:

{{Add-on
|Name=
|provider-name=
|Email=
|Website=
|Forum=
|ID=
|latest-version=
|extension point=
|provides=
|Platform=
|Language=
|License=
|Source=
|Repo=
|icon url=
| repo =
| zip =
|broken=
|Summary=
|Description=
}}

Add-on:The Wall Street Journal Live

2013-09-11T23:40:19Z

Learningit: Created page with " {{Add-on |Name= |prov..."

{{Add-on
|Name=
|provider-name=
|Email=
|Website=
|Forum=
|ID=
|latest-version=
|extension point=
|provides=
|Platform=
|Language=
|License=
|Source=
|Repo=
|icon url=
| repo =
| zip =
|broken=
|Summary=
|Description=
}}



[[Category:Add-ons not in the XBMC.org repo]]