Official Kodi Wiki - User contributions [en]

Add-on rules

2018-02-24T12:10:50Z

Martijn: /* General requirements */ add 4k fanart

{{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 which should be first letter capitalized.
* 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) or (512x512)
* [[Add-on structure#fanart.jpg|fanart.jpg]] must be present (1280x720 or 1920x1080 or 3840x2160)
* [[Add-on structure#LICENSE.txt|LICENSE.txt]] must be present
{{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.

'''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.
* Plugins should '''not''' force certain skin viewtypes on their own. They should set the correct media content from which the correct skin view type is automatically provided.
''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.

=== 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]]

Archive:Google Summer of Code/2018

2018-02-12T19:21:31Z

Martijn: Fix forum links

{{mininav| [[Google Summer of Code]] }}
[[File:GSOC_2016_logo.png|left|150px]]Welcome to the Kodi [http://summerofcode.withgoogle.com Google Summer of Code] ideas page. 

We encourage interested students to review some of the ideas on this page, and then feel free to provide input on any ideas you may have in the '''[http://forum.kodi.tv/forumdisplay.php?fid=257 Kodi GSoC forum]''' and chat about any project you’d love to cover. To propose a project, see '''[[#Students project proposal ideas]]'''.

From the 12th to the 27th of March, any interested students may apply at the [http://summerofcode.withgoogle.com GSOC home page] to work with Kodi. After that, Google will notify applicants whether we get to work with each other according to the [http://developers.google.com/open-source/gsoc/timeline GSOC schedule].
{{-}}
{| width="100%"
| align=left |
__TOC__
| align=right |
{{YouTube|kQq0mx-wshk}}
|}
== About Us ==
As there may be many students who have landed here as a result of GSOC, but are unfamiliar with the project, here are a few resources that may help explain what we are about.

:Kodi (formerly known as XBMC) is an award-winning free and open source (GPL) software media player and entertainment hub for digital media, designed around the 10-foot interface (living room) environment. Created in 2003 by a group of like minded programmers, Kodi is a non-profit project run and developed by volunteers located around the world. More than 500 software developers have contributed to Kodi, and 100-plus translators have worked to expand its reach, making it available in more than 60 languages. For more information, see the page '''[[Kodi]]'''.

<br />
To get an idea of what Kodi is truly capable of, it really must be seen. Check out a few other user-created videos:<br />
[http://www.youtube.com/watch?v=NcogPuSo-DU Kodi with the default Confluence skin]<br />
[http://www.youtube.com/watch?v=4asUCtE0ONU Kodi with Aeon Nox skin]<br />
[http://www.youtube.com/watch?v=4NR57ELY28s Kodi on Raspberry Pi]<br />
[http://www.youtube.com/watch?v=e_0PB5hfz_k Kodi's new PVR functionality]<br />
<br />

Kodi is written primarily in c++ and runs on a variety of platforms including Android, iOS, Linux, OS X, and Windows. It has been ported to work on several low-power platforms including the Raspberry Pi and Android.

Kodi was a mentoring organization in [[Google Summer of Code 2008|2008]], [[Google Summer of Code 2012|2012]], [[Google Summer of Code 2013|2013]], [[Google Summer of Code 2015|2015]], and [[Google Summer of Code/2017|2017]], and had team members involved in GSoC for other projects during 2011.

If Kodi is selected as a mentoring organization for 2018, students will need to review the Overview of a good project proposal, follow the outline for proposals when applying, and review the list of project ideas detailed below. Students are welcome to propose ideas outside the list and are encouraged to be as creative as they like.

=== Mentors ===
All mentors and backup mentors are extremely experienced in the Kodi codebase and will thus be able to assist students in getting to know the codebase and in quickly identifying projects that are both achievable for someone unfamiliar with the internal workings of Kodi and desirable to the wider Kodi community.

==Prerequisites==
C++ coding skills, basic familiarity with [[Git usage|Git]], solid understanding and interest in programming. Ability to quickly understand existing code is beneficial.

== Project Proposals ==
=== Overview ===
Qualifications for a good Summer of Code proposal:
* Discrete, well-defined, modular
* Comprised of a series of measurable sub-goals
* Based on open specs that are available free of charge
* Based on complete specs
An example of a good proposal is the implementation of a new feature or function that is not yet available in Kodi.

An example of a less desirable proposal is one that's not as measurable, such as refactoring an existing API. Bad proposals tend to be ones that would require touching a lot of core code.

To re-iterate:
* Localized/isolated code projects = ''good''
* Global code refactoring = ''bad''
* A project should have a set of subgoals, so even if the end goal turns out to be too big some of the parts will be of benefit.
* Not too big! This is an important problem when choosing a project, while it is fun to think about solving a grand project its not always realistic. Its better to finish a smaller project than to start a grand one.

=== Where to submit proposals ===
In addition to submitting to the [https://summerofcode.withgoogle.com/ Google Summer of Code] website, you are highly encouraged to submit your idea/proposal to the [http://forum.kodi.tv/forumdisplay.php?fid=274 Kodi forum] for discussion. Any proposal not submitted to the forum for discussion will likely not be considered.

=== Outline for proposals ===
{{divbox|blue||
PROJECT TITLE GOES HERE

* '''Name:'''
* '''forum/e-mail:'''
* '''Summary:''' A somewhat small but explanatory walk through of the project. It should not be overly detailed just enough to understand the problem trying to be fixed and how this project opt to solve it.
* '''How will I achieve this:''' Explain how the project will be done, what technologies are needed and how to implement them.
* '''What will the project focus on:''' Explain what the project will focus on, what is the important parts of the project.
* '''Benefits:''' Who will benefit and why from this project. Think about what a user or developer may need or do to benefit from it. Why does it benefit many users.
* '''Goals:''' What is the goal of the project, a project may not always solve the problem entirely as it may take to much time. Think hard about what can be accomplished during a summer with your skill and deduct that quite a bit. If the project can't be done after this perhaps its better to opt for a smaller one or one with subgoals.
* '''What does it touch in Kodi:''' Think about what parts of the code this may touch, Kodi is a big application and a lot of the code is spread out and very complex. If a project touches to much it may be impossible to complete.
* '''Requirements:''' What is needed to complete the project, what code language knowledge what hardware etc.
* '''Possible mentors:''' Place to add possible mentors (Team-Kodi will add this).
}}

== Team-Kodi proposal ideas up for discussion ==

===Intro/outro Detection===
'''Description:''' It would be nice to detect intros and outros of a file dynamically. Then make the intros and outros skipable. One way to do this would be to create a machine learning model per show and distribute those via an api. The scope of this project would focus on some examples and making it easy to add more later. Then implement an addon or core addition that takes those models and acts on them when playing a file, ultimatly making it possible to skip forward.

'''Expected outcome:''' Being able to skip past intros or outros of shows and maybe even movies.

'''Skills preferred:''' Python, C++, something to run an api - GO or Elixir would be prefered

'''Possible mentors:''' Razze

'''Difficulty:''' Hard

'''Type:''' Risky/Exploratory

=== Better Profile Support ===
'''Description:''' Profile support inside Kodi remains extremely hacked together. Improving profile projects would likely be broken down into smaller chunks to make each chunk truly achieveable in a summer. Database handling for profiles needs to be reviewed and changed so that the user expirience is more streamlined. It should also be possible to better guard code paths that need to check for specific profile rights.

'''Expected outcome:''' Profiles should be more user frendly then before and not be an after thought. Being able to easily add more profile features is the big ultimate goal, as we want to support profiles for kids, that automatically hide media that's not for them. Just as an example.

'''Skills preferred:''' C++

'''Possible mentors:''' spiff

'''Difficulty:''' Hard

'''Type:''' Core development

=== Replacing depends with a CMake-based system ===

'''Description:''' Kodi has its own system for building the many libraries Kodi depends on that supports most platforms (Linux, Android, OS X, iOS) and cross-compiling called depends. At the moment, it is implemented with autotools and hand-crafted Makefiles. This has lead to a lot of code duplication, poor maintainability, and not being very user-friendly. Also, it does not currently work on Windows. This task would be about replacing the current system with a new implementation in CMake that has better maintainability.

'''Expected outcome:''' A CMake-based dependency build system that offers roughly the same features as depends (i.e. all required libraries covered, diverse platform support, crosscompilation). If the solution can also be applied to Windows by e.g. adding minimal CMake files to replace some UNIX-only build systems, that would be a big plus, but it is not necessary.

'''Skills preferred:''' CMake, shell scripting, general familiarity with UNIX/Linux

'''Possible mentors:''' wsnipex

'''Difficulty:''' Medium

'''Type:''' Infrastructure/Automation

===Add-ons===
====Add code validation and do statistical analysis in kodis addon checker====
'''Description:''' Kodis addon checker checks each Kodi addon PR on github for certain problems, which ultimatly makes reviewing python addons easier for the team. These checks are fairly simple right now and would greatly benefit from improvements. It would be very nice to actually check the python code that is submitted for errors and also do statistical analysis on each PR. The addon checker is written in python and can be fround here https://github.com/xbmc/addon-check

'''Expected outcome:''' Safer and faster acceptance and reviews for the official kodi addon repos. As most of the code will be checked by the machine. Also fewer slipups with regard to oversight.

'''Skills preferred:''' Python

'''Possible mentors:''' Razze

'''Difficulty:''' Medium

'''Type:''' Low-hanging fruit

====Automatic addon checker for binary addons====
'''Description:''' Kodis addon checker checks each Kodi addon PR on github for certain problems, which ultimatly makes reviewing python addons easier for the team. But the other type of addons, binary addons is not being checked so far. Which makes reviews and codeing guidlines hard to handle. Thus it would be nice to also check those addons, either via the current checker written in python or a new binary addon specific checker. Goals would include checking the addon.xml, the C++ code and a check for potentially malicious code.

'''Expected outcome:''' Being able to run the checker against all binary repo PRs on github.

'''Skills preferred:''' Python, C++

'''Possible mentors:''' Razze

'''Difficulty:''' Hard

'''Type:''' Low-hanging fruit

====Addon Submissions====
'''Description:''' Write a tool or an website to easily submit addons to our addon repo. The tool will need to login at github and send a PR in the name of the author to the correct repo and branch on kodis github. The user experiance needs to be very good to not keep anyone from submitting. It should also be able to offer some oppinions on the code that will be commited before it actually get's send. So it would catch the most common errors on the client side.

'''Expected outcome:''' A tool to get more submissions with better quality and lower the bar for addon authors to get started with repo submissions.

'''Skills preferred:''' Depending if this will be a standalone tool or an website the choice of technology would be quiet different. It would be a new tool, so that's fine. For an website python/djang, elixir/phoenix or something similar would be a good choice. For a stand alone tool we might do a full ui in java or electron or settle for a commandline interface via javascript.

'''Possible mentors:''' Razze

'''Difficulty:''' Easy

'''Type:''' Low-hanging fruit

===Achievements in Retroplayer===
'''Description''': Retroarch has developed support for achievements in certain select libretro cores. This project would consist of porting whatever work might be portable and otherwise integrating the existing libretro achievement system into Kodi's retroplayer implemented using Kodi's UI system. Could be tackled a few different ways, including simply linking the user to the retroachievements.org or creating a full achievement database in Kodi.

'''Expected Outcome''': Users should be able to see their achievements in Kodi. Player manager and Player profile support may be in development concurrently, so thought should be given to those systems.

'''Skills preferred''': C++, python, possibly php

'''Possible mentor''': garbear

'''Difficulty''': medium

'''Type''': Fun/Peripheral

'''Notes''': Garbear has broken down the Retroplayer project into manageable pieces including input, core, game addons, peripheral addons, netplay, a game library implementation, and shaders to do things like emulate a CRT monitor. This is one example, but many pieces are currently being worked on or are near completion, and many more could use help from a student familiar with the area. Visit the retroplayer section of the Kodi forum to see all the major projects still to do.

===Add a picture library===
'''Description:''' At the moment kodi has the concept of libaries for movies, tvshows and music. Libraries are far nicer for users to handle as they keep their data and basically act upon the data that got collected without having to get it on each directory traversal. It also enables filtering, sorting and searches. The project would focus on adding a picture database and getting it filled via file scrapping. When that's done we would progress to write basic libary views for pictures.

'''Expected outcome:''' A functional picture library for kodi with the possiblity to scan file and having them added to your library. It should also be possible to look at your files via a libary frontend, just like it's possible for tvshows, movies or music.

'''Skills preferred:''' C++, SQLite, MySQL/MariaDB

'''Possible mentors:''' Razze

'''Difficulty:''' Easy

'''Type:''' Core development

===Use machine learning to improve suggestions===
'''Description:''' Kodi currently can't suggest simiar media to watch/listen to. It would be possible to just show media that's similar on the base of a tag, but that would be quiet rudimentary. Better would be to create something driven by the user or profile that's currently logged in. This would mean that watched/listend and collected data be added to the model and we would serve the best possible suggstion for a user. Machine learning might be the best approach as we would be able to create a model and just ship that model and act on it when kodi tries to serve suggestions.

'''Expected outcome:''' Far better suggestions then before. Some places might even just get suggestions due to this project, as it did not make much sense to do suggestions before this.

'''Skills preferred:''' Python, TensorFlow, C++, SQLite, MariaDB/MySQL

'''Possible mentors:''' Razze

'''Difficulty:''' Hard

'''Type:''' Risky/Exploratory

===Using fuzz testing to fuzz test Kodi===

'''Description:''' Adding fuzz testing to Kodi would be very valuable to find problems in the current code base. Especially security problems. First step would be choosing a framework either american fuzzy lop, libFuzzer or other similar projects. After we decided on that it would be time to start to fuzz different methods that are widely used in Kodi and try to expose flaws in those. If this leads to success, it should be documented and made repeatable.

'''Expected outcome:''' Being able to easily add more fuzz tests and having the process to do this documented.

'''Skills preferred:''' C++, CMake

'''Possible mentors:''' Razze

'''Difficulty:''' Medium

'''Type:''' Risky/Exploratory

===other ideas===
These ideas still need expanding and/or assigned a potential mentor. If one of these ideas interests you, feel free to ask for more info in the GSOC 2018 forum area. We may be able to assign a mentor if enough interest is shown
*Using fruit or similar to use DI in Kodi and write tests
*High quality scalers for OpenGL(GLSL). Scale Y and UV plane separately ('''mentor''': fernet menta)
*Support downloading of of media items (the actual file not just the metadata) from another Kodi instance (e.g. through UPnP) into the local library. This could be done in a "send to" way and in a "download" way and it could also be combined with transcoding depending on the target device. (possible mentor: montellese)
*UPnP device profiles. there's already a PR that goes in that direction and the problem is that right now we can only really provide device specific MIME type hacks but if we have transcoding we'll definitely need this (possible mentor: montellese)

=== More ===
We feel it is important to note that, while we are interested in a focus on the listed three areas, we would like to stress passion, expertise, and creativity above all else. If you would like to do something completely different, definitely send in that proposal. The ideas listed above are, as always, merely suggestions. We will be interested in any idea, so long as you can communicate your interest, your background, and your solution the problem.

== Students project proposal ideas ==

Submit your own proposals on the '''[https://forum.kodi.tv/forumdisplay.php?fid=284 Kodi GSoC forum]'''. They can be as big or as small as you feel you can comfortably accomplish between '''PROJECT START DATE''' and '''PROJECT END DATE'''. In the end, it's better to have a smaller, completed project, rather than a larger, incomplete project.

To submit a proposal idea:
# Copy the text from '''[[#Outline for proposals]]'''.
# Create a new forum post '''[https://forum.kodi.tv/forumdisplay.php?fid=284 HERE]''' and paste the text.
# Fill out everything using your specific proposal.

[[Category:Google Summer of Code]]

Kodi v18 (Leia) changelog

2018-01-29T20:45:56Z

Martijn: /* Android Specific */

{{mininav|[[Releases]] {{l2| [[Leia]] }} }}

{{notice|Kodi v17 (Krypton) final has just been released, so please keep in mind that a final non-alpha/beta v18 (Leia) release is still far far away into the future. As such, these new features/functions and API changes is a placeholder containing changes to the current Kodi mainline (the git master tree repository on GitHub). It is a very much a work in progress, this is only listing changes commited to the master branch after Jarvis branching, and many many many features/functions and API additions, alterations or removal are still subject to future change.}}
{{incomplete}}
{{future|18}}

{{see also|Kodi v18 (Leia) FAQ|Leia API changes|Releases}}

This is a placeholder and Kodi Wiki copy of the condensed changelog for the future Kodi v18.x version (codename: "Leia") releases with a summery of the most important core features and functions as well as other notable changes to key areas of the application software or its user interface.

== Changelog ==

=== Gaming (Games interface and Game Clients)===
* Added a RetroPlayer player core supporting game clients as well as emulator cores via libretro API<ref name="RetroPlayer">RetroPlayer http://forum.kodi.tv/showthread.php?tid=164725</ref><ref>http://github.com/xbmc/xbmc/pull/11022</ref>
* Added extentions to Kodi's Addons AP to support Game Client Addons, supporting Kodi's VFS (Virtual File System), etc.<ref name="RetroPlayer"/>
* Added support for Game Client Addons as new type of addons with just-in-time emulator installation<ref name="RetroPlayer"/>
* Added a Games window and Game OSD (On-Screen-Display) entries to the GUI<ref name="RetroPlayer"/><ref>https://github.com/xbmc/xbmc/pull/12367</ref>
* Added a gaming and game configuration interface for Game settings to the GUI<ref name="RetroPlayer"/>
* Added support for Game Info Tags (game info tag) and exposed properties to Python list items<ref name="RetroPlayer"/>
* Added a savestate (savestate) manager to Kodi for games<ref>http://github.com/xbmc/xbmc/pull/11034</ref>
* Added initial support for basic gameplay persistence (auto-save & auto-load)<ref>https://github.com/xbmc/xbmc/pull/12434</ref>
* Added support for in-game (save RAM) saves<ref>http://github.com/xbmc/xbmc/pull/11380</ref>
* Added support for Keyboard players via Joystick Emulation<ref name="RetroPlayer"/>
* Added support for libretro API and game cores (emulators and games) that support it
* Added [[Game_Add-ons|game clients addons]] for many popular third-party game console emulators and native open source games *
** ''* [[Game_Add-ons|Game clients addons]] for Kodi is changing quickly so checkout the [[Game_Add-ons|game clients addons]] article for a current list''
* ?

=== Live TV and PVR (Personal Video Recorder) ===
* Major GUI actions refactoring to eliminate duplicate and dead code. Add context menu support for Estuary PVR home screen widgets <ref>https://github.com/xbmc/xbmc/pull/10870</ref>
* Guide window: Get rid of obsolete views "channel", "now" and "next" <ref>https://github.com/xbmc/xbmc/pull/10838</ref>
* Core: Refactor and fix "play minimized" settings handling <ref>https://github.com/xbmc/xbmc/pull/11203</ref>
* Guide, channel, video fullscreen, music visualisation window: Direct channel number input. <ref>https://github.com/xbmc/xbmc/pull/11434</ref>
* Settings: Remove setting 'hide connection lost warning' <ref>https://github.com/xbmc/xbmc/pull/11500</ref>
* Search dialog: Refactor and complete implementation of EPG search filter <ref>https://github.com/xbmc/xbmc/pull/11570</ref>
* Timer settings dialog: Prefill recordings folder with timer title <ref>https://github.com/xbmc/xbmc/pull/11679</ref>
* Recordings window: Content view filter <ref>https://github.com/xbmc/xbmc/pull/11704</ref>
* Settings: Remove non-working recording settings defaults <ref>https://github.com/xbmc/xbmc/pull/11746</ref>
* Guide window: 'Smart selection' of epg events. <ref>https://github.com/xbmc/xbmc/pull/11782</ref>
* Channelgroup manager: Add support for radio channel groups <ref>https://github.com/xbmc/xbmc/pull/11877</ref>
* Guide window: Add possibility to switch between horizontal and vertical epg grid view <ref>https://github.com/xbmc/xbmc/pull/11958</ref>
* Search window: improvements and fixes <ref>https://github.com/xbmc/xbmc/pull/12001</ref>
* Estuary home screen: Add Info support to recently played channel widget <ref>https://github.com/xbmc/xbmc/pull/12254</ref>
* Estuary: Add episodename to live tv and recordings osd sub label, cleanup seek bar for live tv <ref>https://github.com/xbmc/xbmc/pull/12306</ref>
* Estuary: PVR info dialog, recordings window: cleanup and extend <ref>https://github.com/xbmc/xbmc/pull/12416</ref>
* Drop 'channel guide' button from epg event info dialog, add 'channel guide' to context menu <ref>https://github.com/xbmc/xbmc/pull/12526</ref>
* Settings: Introduce new setting 'Startup action' and add 'Play TV/Radio <ref>https://github.com/xbmc/xbmc/pull/12548</ref>
* Settings: Make 'epg.lingertime' an official setting, remove the respective advanced setting <ref>https://github.com/xbmc/xbmc/pull/12740</ref>
* Setting: Remove obsolete and unused setting 'pvrplayback.scantime' <ref>https://github.com/xbmc/xbmc/pull/12800</ref>
* Core: Fixes/Improvements for multiple enable PVR client addons <ref>https://github.com/xbmc/xbmc/pull/12959</ref>
* Core: Fixes/Improvements for subchannel numbers support (ATSC) <ref>https://github.com/xbmc/xbmc/pull/13069</ref>
* Core: Global direct channel number input & global unique channel numbers <ref>https://github.com/xbmc/xbmc/pull/13135</ref>
* Database: Fix error "Abort due to constraint violation. Query: INSERT INTO channels..." <ref>https://github.com/xbmc/xbmc/pull/13150</ref>
* Estuary: Rework PVR seekbar + Fix PVR info dialog <ref>https://github.com/xbmc/xbmc/pull/13158</ref>
* Core: Make next/previous chapter work for PVR recordings <ref>https://github.com/xbmc/xbmc/pull/13164</ref>
* Direct channel number input: No delay on switch to previous channel with key 0 <ref>https://github.com/xbmc/xbmc/pull/13232</ref>
* Settings: Make shared channel selection optional <ref>https://github.com/xbmc/xbmc/pull/13237</ref>
* Estuary: PVR info panel cleanup <ref>https://github.com/xbmc/xbmc/pull/13255</ref>
* Guide window: 'Go to date' context menu item <ref>https://github.com/xbmc/xbmc/pull/13282</ref>
* Estuary: Season/Episode info in Guide window and dialog <ref>https://github.com/xbmc/xbmc/pull/13300</ref>
* Estuary: Add percent played progress bar to PVR info panel (for recordings) <ref>https://github.com/xbmc/xbmc/pull/13338</ref>
* Guide window: Channel groups selector <ref>https://github.com/xbmc/xbmc/pull/13364</ref>
* Guide window: Tweaks for more consistency and readability <ref>https://github.com/xbmc/xbmc/pull/13402</ref>
* PVR-Addon API changes <ref>https://github.com/xbmc/xbmc/pull/12028</ref><ref>https://github.com/xbmc/xbmc/pull/12303</ref><ref>https://github.com/xbmc/xbmc/pull/12552</ref><ref>https://github.com/xbmc/xbmc/pull/12609</ref><ref>https://github.com/xbmc/xbmc/pull/12660</ref><ref>https://github.com/xbmc/xbmc/pull/12689</ref><ref>https://github.com/xbmc/xbmc/pull/12755</ref><ref>https://github.com/xbmc/xbmc/pull/13228</ref>
* Added, updated, and improved PVR backend clients addons for all popular third-party external [[PVR backend]] platforms:
** New: [[Add-on:Zattoo PVR Client|Zattoo PVR Client]] PVR Addon backend client maintained and available from Kodi's community
** New: [[Add-on:Teleboy PVR Client|Teleboy PVR Client]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:PVR Demo Client|PVR Demo Client]] dummy addon with fake (method stub) [[PVR backend]] for [[PVR]] skinning and regression testing
** [[Add-on:IPTV Simple Client|IPTV Simple Client]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:FilmOn PVR Client|FilmOn]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:Stalker Client|Stalker Middleware]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:HDHomeRun PVR|HDHomeRun]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:Digital Devices Octopus NET Client|Digital Devices Octopus NET Client]] PVR Addon backend client maintained and made available by [http://digitaldevices.de/home/ Digital Devices]
** [[Add-on:VU+ / Enigma2 Client|Enigma2 (Dreambox / Vu+ / DBox2)]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:VBox TV Gateway PVR Client|VBox TV Gateway]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:Njoy N7 PVR Client|Njoy Digital (N7)]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:PCTV Systems Client|PCTV Systems (Broadway)]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:Tvheadend HTSP Client|Tvheadend HTSP Client]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:VDR VNSI Client|VDR VNSI Client]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:MythTV PVR Client|MythTV PVR Client]] Addon backend client maintained and available from the Kodi's community
** [[Add-on:NextPVR PVR Client|NextPVR (former GB-PVR)]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:Argus TV Client|Argus TV (former ForTheRecord)]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:DVBLink PVR Client|DVBLink PVR Client]] Addon backend client maintained and available from Kodi's community
** [[Add-on:DVBViewer Client|DVBViewer Client]] PVR Addon backend client maintained and available from Kodi's community
** [[Add-on:MediaPortal PVR Client|MediaPortal PVR Client]] Addon backend client maintained and available from Kodi's community
** [[Add-on:PVR.WMC|WMC (Windows Media Center)]] PVR Addon backend client maintained and available from Kodi's community
* ?

=== Add-ons Framework, API, and Manager ===
For full changelogs of all Addons APIs, see [[Leia API changes]], [http://forum.kodi.tv/forumdisplay.php?fid=174 JSON-RPC], and [http://forum.kodi.tv/forumdisplay.php?fid=26 Add-ons] Development Forums
* Major refactoring of Kodi's core handling and GUI management of binary addons<ref>http://github.com/xbmc/xbmc/pulls?q=label%3A%22Binary+Addons%22+is%3Aclosed</ref>
* Added framework to support VFS (Virtual File System) as binary addons<ref>http://github.com/xbmc/xbmc/pull/8966</ref>
* Added framework support for binary addons for video decoder codecs<ref name="Addon video codec implementation">https://github.com/xbmc/xbmc/pull/12340</ref>
* Added framework support for binary addons for image (picture) decoder codecs
* Added extentions to Kodi's Addons API to support binary addons for video decoder codecs<ref name="Addon video codec implementation"/>
* Added extentions to Kodi's Addons API to support binary addons for image decoder codecs
* Added support for Python addons to use PyCryptoDome crypto module for decryption<ref>https://github.com/xbmc/xbmc/pull/11477</ref>
* Added option to pass HTTP cookies with AVOption to Kodi's Video Player<ref>https://github.com/xbmc/xbmc/pull/12257</ref>
* Added support to allow addons to edit all used controls on their processed window<ref>https://github.com/xbmc/xbmc/pull/12259</ref>
* Added support to allow Python addons to set the videoinfotag path<ref>http://github.com/xbmc/xbmc/pull/11012</ref>
* Added support to allow Python addons to get/set the dbid of a (music) listitem<ref>http://github.com/xbmc/xbmc/pull/10858</ref>
* Added support for mediatype to musicinfotag tag retrieving via Python API<ref>http://github.com/xbmc/xbmc/pull/11110</ref>
* Added support "int/float slider" to Kodi's Python API<ref>http://github.com/xbmc/xbmc/pull/11230</ref>
* Added support "setContent for mediawindows" to Kodi's Python API<ref>http://github.com/xbmc/xbmc/pull/11258</ref>
* Added help for load of shared library and allow the use of their own addon temp folder<ref>https://github.com/xbmc/xbmc/pull/12379</ref>
* Added support to inspect add-on dependencies prior to installation<ref>https://github.com/xbmc/xbmc/pull/12242</ref>
* Added ability to remove add-on settings upon uninstall<ref>https://github.com/xbmc/xbmc/pull/11499</ref>
* Changed to new addon gui interface for list items to use on addon window<ref>https://github.com/xbmc/xbmc/pull/12214</ref>
* Changed service addons to use event handlers instead of synchronous addon hooks<ref>https://github.com/xbmc/xbmc/pull/12370</ref>
* Updated "Peripheral Addons" for game controllers, gamepads, joysticks, and input peripherals profiles (in Kodi-game repo<ref>http://github.com/kodi-game/ kodi-game repo on GitHub</ref>):
** [http://github.com/xbmc/peripheral.joystick Joystick Controller Addon]
** [http://github.com/kodi-game/peripheral.xarcade X-Arcade (XGaming Tankstick) support for Kodi Addon]
** [http://github.com/kodi-game/peripheral.steamcontroller Steam Controller (gamepad) Addon]
** [http://github.com/kodi-game/kodi-game-controllers/tree/master/addons/game.controller.default Default Game Controller Addon (reference game controller addon based on Xbox 360 gamepad)]
*** [http://github.com/kodi-game/kodi-game-controllers/tree/master/addons/game.controller.ps PlayStation Game Controller Addon]
*** [http://github.com/kodi-game/kodi-game-controllers/tree/master/addons/game.controller.nes Nintendo NES Game Controller Addon]
*** [http://github.com/kodi-game/kodi-game-controllers/tree/master/addons/game.controller.snes Nintendo SNES Game Controller Addon]
*** [http://github.com/kodi-game/kodi-game-controllers/tree/master/addons/game.controller.n64 Nintendo N64 Game Controller Addon]
*** [http://github.com/kodi-game/kodi-game-controllers/tree/master/addons/game.controller.gba Nintendo GBA Game Controller Addon]
*** [http://github.com/kodi-game/kodi-game-controllers/tree/master/addons/game.controller.genesis Sega Genesis Game Controller Addon]
*** [http://github.com/kodi-game/kodi-game-controllers/tree/master/addons/game.controller.dreamcast Sega Dreamcast Game Controller Addon]
* ?

=== GUI Engine (Skinning Engine) ===
For full changelog on changes to the skinning engine, see [[Leia API changes]] and the [http://forum.kodi.tv/showthread.php?tid=298565 Skin Development Forum]
* Added windows to support Games and Game OSD in the new default skins (Estuary and Estouchy)
* Added player process info dialog to Kodi's default skin (Estuary)<ref>https://github.com/xbmc/xbmc/pull/11718</ref>
* Added support for addons to use banner and ClearLogo<ref>https://github.com/xbmc/xbmc/pull/12244</ref>
* Added support for skins/gui to allow implicit container referencing for non-media windows<ref>http://github.com/xbmc/xbmc/pull/10883</ref>
* Added support for addons to add "Enable/Disable" to context menu<ref>http://github.com/xbmc/xbmc/pull/11124</ref>
* Added support for remember last used keyboard layout in GUI<ref>http://github.com/xbmc/xbmc/pull/11242</ref>
* Added support for ISO 639-2/T language code retrieval (required by libbluray)<ref>https://github.com/xbmc/xbmc/pull/12258</ref>
* Added window that display Kodi privacy policy in GUI settings under system info<ref>https://github.com/xbmc/xbmc/pull/10785</ref>
* Added support to map a key to browse for subtitle in video fullscreen window<ref>https://github.com/xbmc/xbmc/pull/11649</ref>
* Improved Kodi's GUI engine with optimizations for message handling and SmartRedraw<ref>https://github.com/xbmc/xbmc/pull/12213</ref>
* Improved Kodi's GUI engine support for scaling container layouts<ref>http://github.com/xbmc/xbmc/pull/11229</ref>
* Improved Kodi's GUI engine by allowing %-values for origin, camera and animation attribs<ref>http://github.com/xbmc/xbmc/pull/11233</ref>
* Changed so that context menu reloading loads async to aviod GUI lockup on wait<ref>https://github.com/xbmc/xbmc/pull/11841</ref>
* Updated guilib ABI (for libgui) to version 5.13.0<ref>http://github.com/xbmc/xbmc/pull/11306</ref>
* Updated keyboard layout for some languages and added support Croatian, Slovenian, and Thai (Kedmanee)
* Updated image resource addons (as example weather icons, weather fanart, studio logos, and genre icons)
* ?

=== Platform Independent Playback ===
* Added support for "InputStream" (input stream) addons to pass CryptoSession flags field<ref>https://github.com/xbmc/xbmc/pull/12428</ref>
* Added support for BD-J / Blu-ray Disc Java menu support (requires system Java runtime enviroment)<ref>https://github.com/xbmc/xbmc/pull/12339</ref><ref>https://github.com/xbmc/xbmc/pull/12310</ref>
* Added support for Blu-ray Disc detection and use provided meta data for Blu-ray Disc names<ref>https://github.com/xbmc/xbmc/pull/12488</ref>
* Added support for video buffers to be used by decoders and renderers<ref name="VideoPlayer updates for Leia">https://github.com/xbmc/xbmc/pull/12212</ref>
** Added support for platforms to register custom buffers, like example dma<ref name="VideoPlayer updates for Leia"/>
* Added a VC1-Packet bitstream parser implementation for improved VC-1 playback<ref>http://github.com/xbmc/xbmc/pull/11417</ref>
* Added and updated many (binary) audio decoder and encoder addons for Kodi
* Added a few (binary) video decoder addons for Kodi<ref name="Addon video codec implementation"/>
* Added a "RAW" (libraw based) image decoder addon to Kodi<ref>https://github.com/xbmc/xbmc/pull/11671</ref>
* Improved MMAL playback of H.264 MVC (Blu-ray 3D) stereoscopic video with framepacking decoding on Raspberry Pi
* Improved Stereoscopic 3D playback of 3D videos (as well as better 2D playback of 3D videos)
* Improved and enhanced Blu-ray support (including updated libbluray dependecies from the VideoLAN project<ref>https://github.com/xbmc/xbmc/pull/12305</ref><ref>http://git.videolan.org/?p=libbluray.git;a=blob;f=ChangeLog</ref>
* Improved support for "InputStream" (input stream) addons as system addons
* Updated "InputStream" (input stream) client addons for common network streaming protocols and popular services:
** [http://github.com/xbmc/xbmc/tree/master/addons/kodi.inputstream InputStream Addon (default reference InputStream Addon by Team Kodi]
** [http://github.com/mapfau/inputstream.test Test InputStream Addon (Test InputStream Addon for Kodi's new inputstream interface]
** [http://github.com/peak3d/inputstream.adaptive Adaptive InputStream Addon (InputStream Client addon for several manifest types)]
** [http://github.com/xbmc/repo-binary-addons/tree/master/inputstream.rtmp RTMP InputStream Addon (InputStream Client for RTMP streams using librtmp)]
** [http://github.com/peak3d/inputstream.mpd MPD (MPEG-DASH) InputStream Addon]
** [http://github.com/peak3d/inputstream.smoothstream SmoothStream InputStream Addon for MS-SSTR (SmoothStreamingMedia) Smooth Streaming Protocol]
** [http://github.com/mapfau/inputstream.nxmsl NXMSL InputStream Addon for Netflix style manifests over MSL]
* Updated FFmpeg multimedia codec and demux libraries to stable branch release version [http://www.ffmpeg.org/download.html#release_3.3.2 FFmpeg 3.3 (3.3.2)]<ref>http://git.videolan.org/?p=ffmpeg.git;a=blob_plain;f=Changelog;hb=release/3.3.2 FFmpeg 3.3.2 release changelog</ref><ref>https://github.com/xbmc/xbmc/pull/12358</ref>
* Removed certain audio codecs from core and made them into audio decoder and audio encoder add-ons
* Removed certain video codecs from core and made them into video decoder add-ons<ref name="Addon video codec implementation"/>
* Removed certain image codecs from core and made them into image decoder add-ons
* ?

=== Library ===
* Addded support to use the Favourites function in context menus<ref>https://github.com/xbmc/xbmc/pull/11967</ref>
* Added support for context menus to favourites home screen widget<ref>https://github.com/xbmc/xbmc/pull/11929</ref>
* Added support for processing of WRITER tag for ID3 v2, Vorbis and APE formats<ref>https://github.com/xbmc/xbmc/pull/11735</ref>
* Added support for sorting using artist sort name tags in music<ref>https://github.com/xbmc/xbmc/pull/11738</ref>
* Added support to "Sort By Date Added" in Music Video title node<ref>https://github.com/xbmc/xbmc/pull/12495</ref>
* Changed to never cache listing of PVR directories on library scans<ref>https://github.com/xbmc/xbmc/pull/11761</ref>
* ?

=== Web Scrapers ===
* Added support for Python (script) based web scrapers for Kodi<ref>http://github.com/xbmc/xbmc/pull/9984</ref>
* Refactored and updated many XML based scrapers in Kodi for music, movies, tv shows, and music videos
* Updated music, movies, tv shows, and music video scrapers for Kodi
* ?

=== AudioEngine ===
* Added a new Sndio sink for [[AudioEngine#ActiveAE|ActiveAE]] for BSD, other BSD Unix based systems, and Linux<ref>https://github.com/xbmc/xbmc/pull/11962</ref>
* Improved the default cross-platform event driven active state machine pattern [[AudioEngine#ActiveAE|ActiveAE]] (Kodi's [[AudioEngine]])
* Improved ALSA sink for [[AudioEngine#ActiveAE|ActiveAE]] for Linux Desktop and generic Linux based Embedded Systems
* Improved PulseAudio sink for [[AudioEngine#ActiveAE|ActiveAE]] for Linux Desktop
* Improved OSS (Open Sound System) sink for [[AudioEngine#ActiveAE|ActiveAE]] for BSD, like FreeBSD and similar BSD Unix based systems
* Improved AUDIOTRACK sink for [[AudioEngine#ActiveAE|ActiveAE]] for [[Amlogic]]
* Improved Pi Audio sink for [[AudioEngine#ActiveAE|ActiveAE]] for [[Raspberry Pi]]
* Improved DirectSound sink for [[AudioEngine#ActiveAE|ActiveAE]] for Windows
* Improved WASAPI sink for [[AudioEngine#ActiveAE|ActiveAE]] for Windows
* Improved CoreAudio sink for [[AudioEngine#ActiveAE|ActiveAE]] for (Mac) OS X and iOS
* Improved Darwin sink for [[AudioEngine#ActiveAE|ActiveAE]] for (Mac) OS X and iOS
* ?

=== Other ===
* Added a new unified setting for "Startup action" and added "Play TV/Radio"<ref>https://github.com/xbmc/xbmc/pull/12548</ref>
* Added support to build Kodi with support for Bluetooth<ref>http://github.com/xbmc/xbmc/pull/11137</ref>
* Added possibility for CMake build system to add additional libraries on install<ref>https://github.com/xbmc/xbmc/pull/12423</ref>
* Updated and improved mappings for new and existing remote controls
* Improved Kodi's JSON-RPC API
* Improved compiling/building and code documentation (following doxygen coding guidelines)
* Changed to use spdlog for Kodi logging as well as improved and further optimized logging (including debug logs)<ref>https://github.com/xbmc/xbmc/pull/11833</ref>
* Changed XML format of setting values for Kodi's settings configuration<ref>https://github.com/xbmc/xbmc/pull/12277</ref>
* Updated default web interface (webinterface is called "Chorus2" and is currently at version 2.4.4)<ref>https://github.com/xbmc/xbmc/pull/11872</ref>
* Updated critical dependency libraries such as openssl, gnutls, and CMake (used to compile Kodi and its binary addons)
* Removed last dependencies of SDL (Simple DirectMedia Layer) which was hardware abstraction for input devices<ref>https://github.com/xbmc/xbmc/pull/12272</ref><ref>https://github.com/xbmc/xbmc/pull/11881</ref>
* Removed all glew (libglew library) dependencies in Kodi's code<ref>http://github.com/xbmc/xbmc/pull/11128</ref>
* ?

=== Android Specific ===
* Added support for speech-to-text in Kodi OSD keyboard on Android TV (triggered by voice button on remote)
* Added support for Android to move the Kodi app to SD card<ref>https://github.com/xbmc/xbmc/pull/12168</ref>
* Added support for Android TV Leanback search and recommendations meta data from Kodi<ref>|https://github.com/xbmc/xbmc/pull/11901</ref>
** Default setting for Android TV Leanback suggestion to random unwatched movies and music albums<ref>https://github.com/xbmc/xbmc/pull/11963</ref>
* Moved to Android NDK 16
* Changed Rendertype from GUILayer to VideoLayer for Android MediaCodecSurface<ref>https://github.com/xbmc/xbmc/pull/12097</ref>
* Changed to use NDK native C interface for Android MediaCodec (for performance gains)<ref>https://github.com/xbmc/xbmc/pull/11931</ref>
* Changed to support ZeroConf via native Android API (and deprecates mDNSresponder)<ref>http://github.com/xbmc/xbmc/pull/11393</ref>
* Changed to support network information via native Android API (and deprecates POSIX)<ref>https://github.com/xbmc/xbmc/pull/12243</ref>
* Changed handling of Kodi's Java interfaces via JNI for better consistency<ref>https://github.com/xbmc/xbmc/pull/12292</ref>
* ?

=== BSD Specific ===
* Improved Kodi support for [http://en.wikipedia.org/wiki/Berkeley_Software_Distribution BSD (operating system)] on FreeBSD, PC-BSD, and other similar BSD platforms
* Improved VAAPI (Video Acceleration API) support (requires VAAPI compatible hardware and drivers)
* Improved VDPAU (NVIDIA) Hardware Video Acceleration (requires VDPAU compatible hardware and drivers)
* ?

=== Linux Specific ===
* Added support for a generic DRM/KMS implementation using GBM to create required surfaces<ref>https://github.com/xbmc/xbmc/pull/11955</ref>
* Added support for Mir windowing system (Mir 1.0) for Kodi<ref>http://github.com/xbmc/xbmc/pull/10898</ref> and added support for VAAPI on Mir using DRM<ref>http://github.com/xbmc/xbmc/pull/11040</ref>
* Added support for the middle mouse button on embedded platforms<ref>https://github.com/xbmc/xbmc/pull/11956</ref>
* Added support more yuv420p bitwidths for direct rendering on Linux<ref>https://github.com/xbmc/xbmc/pull/12479</ref>
* Added support for using VAAPI hardware video decoding with OpenGL ES<ref>https://github.com/xbmc/xbmc/pull/12113</ref>
* Added support for build Kodi with imx support using CMake<ref>http://github.com/xbmc/xbmc/pull/11288</ref>
* Moved the CMake build system to the top of the code tree (moved to root)<ref>http://github.com/xbmc/xbmc/pull/10446</ref>
* Improved support for UltraHD decoding / 4K resolution output when hardware supports it
* Improved ARM processor architecture (using [[Raspberry Pi]] as reference device)
* Improved OpenGL ES and EGL support (using [[Raspberry Pi]] as reference device)
* Improved VAAPI (Video Acceleration API) support (requires VAAPI compatible hardware and drivers)
* Improved VDPAU (NVIDIA) Hardware Video Acceleration (requires VDPAU compatible hardware and drivers)
* Improved XvBA (AMD/ATI) Hardware Video Acceleration (requires XvBA compatible hardware and drivers)
* Improved dedicated AMLCodec hardware accelerated video decoding support for Linux on Amlogic devices
* Removed the unused and unmaintained OpenMAX video decoder from Kodi's VideoPlayer<ref>https://github.com/xbmc/xbmc/pull/12197</ref>
* Removed support for autotools based build system for Kodi and binary addons (in favour of CMake)<ref>http://github.com/xbmc/xbmc/pull/10429</ref>
* ?

=== iOS Specific ===
* Added support for iOS 10.0 by adding support for compiling Kodi with Xcode 8 IDE and iOS SDK 10.0<ref>https://github.com/xbmc/xbmc/pull/10539</ref>
* Improved Apple VDADecoder Video Acceleration support for iOS (on iPad, iPhone, and iPod iDevices)
* Improved support for TVOS (Apple's iOS fork for Apple TV 4) in Kodi mainline
* Improved support for iOS on ARM64 (64-bit iOS)
* ?

=== OS X Specific ===
* Added support for compiling Kodi with Xcode 8 IDE for OSX 10.11 (El Capitan) and macOS 10.12 (Sierra)
* Improved Apple VDADecoder Video Acceleration support for (Mac) OS X
* ?

=== Windows Specific ===
* Added support to build Kodi for Windows 64 / Windows for Intel 64-bit (x86-64)<ref>https://github.com/xbmc/xbmc/pull/12065</ref>
* Added support for 3D LUT (3D Lookup Table) and dithering to Windows video renderer<ref name="WinRenderer re-work">https://github.com/xbmc/xbmc/pull/12475</ref>
* Improved support to compiling Kodi for Microsoft's UWP (Universal Windows Platform) APIs
* Changed the inner working of render buffers and rendering methods<ref name="WinRenderer re-work"/>
* Changed to using unicode win32 api methods<ref>https://github.com/xbmc/xbmc/pull/11780</ref>
* Changed windowing systems for screen saver handling on Windows OS platforms
* Changed to make Kodi for Windows platform independent of posix/main.cpp<ref>https://github.com/xbmc/xbmc/pull/12215</ref>
* Removed support for Windows Vista as the operating-system is no longer supported by Microsoft<ref>https://github.com/xbmc/xbmc/pull/11953</ref>
* ?

== References ==
<references/>

== See also ==
* [[Leia API changes]]
{{Changelogs}}

[[Category:Manual]]
[[Category:Leia|*]]
[[Category:Changelogs|18]]

Submitting Add-ons

2017-02-08T21:09:29Z

Martijn:

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

=== Submitting a Compliant Add-on to the Kodi.tv Repo ===

After you have read the [[Add-on rules|repository guidelines]] and made sure your addon is compliant with them, you may begin the submission process using the following steps.

=== Allowed submissions ===

We have restricted the allowed submissions of add-ons to past Kodi versions.
Several reasons:
* Kodi code improvements
* Reduce support load for add-on developers
* Reduce workload for repository maintainers

Below is a table of on which submissions are allowed to official Kodi repository.

{| class="prettytable" border="1"
|+ Allowed add-on submissions
! codename !! version !! update !! new
|-
| Dharma || 10.x || no || no
|-
| Eden || 11.x || no || no
|-
| Frodo || 12.x || no || no
|-
| Gotham || 13.x || yes || no
|-
| Helix || 14.x || yes || no
|-
| Isengard || 15.x || yes || no
|-
| Jarvis || 16.x || yes || no
|-
| Krypton || 17.x || yes || yes
|-
| Leia || 18.x || yes || yes
|}

Additional feature is that we now use combined repositories. So if your add-on is Gotham/Helix compatible, you only need to send it to Gotham repository.
If it's only Helix compatible you need to send it to Helix repository.
This of course requires that the minimal Kodi dependencies are set accordingly.

{| class="prettytable" border="1"
|+ Which repos are used
! codename !! version !! repo
|-
| Dharma || 10.x || Dharma
|-
| Eden || 11.x || Eden
|-
| Frodo || 12.x || Frodo
|-
| Gotham || 13.x || Gotham
|-
| Helix || 14.x || Gotham || Helix
|-
| Isengard || 15.x || Gotham || Helix || Isengard
|-
| Jarvis || 16.x || Gotham || Helix || Isengard || Jarvis
|-
| Krypton || 17.x || Gotham || Helix || Isengard || Jarvis || Krypton
|}

{{see also|Addon.xml#Dependency_versions}}

=== Github ===

==== Pull requests ====
New add-ons or updates may be submitted directly to the [[Official add-on repository]] on Github as pull requests. We encourage add-on developers to use this method as the process is easier for both parties involved. Of course this requires some initial git knowledge and we strongly suggest to read up on this subject before using this method. To reduce size we have split up the git repositories in several locations. Please visit [[Official add-on repository]] to see where they are. Each contains a small readme with a short description of it's contents as well as a link to a short explanation on how to submit using git command line. There are also git tools available that have a graphic interface and the steps above should be done in a similar way. Please consult the manual of those programs.

In addition to the [[Add-on rules|repository guidelines]] the following rules apply when submitting PRs on Github:

* PR should contain one commit only.
* Commit message should have the format "[addonid] version". Example: "[my.cool.addon] 1.0.1"

Only PRs from the add-on author or his successor will be accepted. Patches should be submitted upstream to the original author first. For an easy way to create PR from your own git repository, see [[HOW-TO: create add-on PRs using Git Subtree Merging]].

==== Issue ticket ====
If you are not experienced yet with git and pull requests you may also use the "issue" option where you submit a request to get you add-on added. In this ticket you need to provide the basic information needed so our repo maintainers know where to get the correct version.
This consists of
- Add-on name:
- Add-on ID:
- Version number:
- Kodi/repository version:
- Code location URL:
- Revision/tag:
- Branch:

Further information is provide when you initially create the issue on github as comments in the ticket.
Same [[Add-on rules|repository guidelines]] apply here as well.

WARNING: Do not create bug tickets in these repositories as they will be closed without notice.

==== How to submit your add-on and subsequent updates ====
Submitting updates is done the same way as with pull requests or issue ticket.

==== Repository lists ====
You can create pull requests or tickets on the following individual repositories.

https://github.com/xbmc/repo-plugins
https://github.com/xbmc/repo-resources
https://github.com/xbmc/repo-scrapers
https://github.com/xbmc/repo-scripts
https://github.com/xbmc/repo-skins
https://github.com/xbmc/repo-webinterfaces

=== Additional information ===
Note that skin .xbt files will be generated automatically for skins so you do not include this in your pull request or created tickets.
After the add-on has been added or updated it will be available from the Kodi repository in Kodi itself, on http://addons.kodi.tv/ and on the wiki page http://kodi.wiki/index.php?title=Category:All_add-ons.

{{Note|Please locate you add-on in the root of the git repository. This to make sure we can easily pull the add-on into our repository.
Example: https://github.com/XBMC-Addons/service.xbmc.versioncheck}}

{{tip|We automatically combine all repos into one single repo list on our server and provide that list to Kodi. You only need to do a request for the minimum repo your add-on supports.}}

=== The mailing list ===

''' MAILINGLIST IS NOT USED ANYMORE. ALL REQUESTS SHOULD GO THROUGH GITHUB '''

[[Category:Add-on development]]

Submitting Add-ons

2017-02-08T21:07:42Z

Martijn:

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

=== Submitting a Compliant Add-on to the Kodi.tv Repo ===

After you have read the [[Add-on rules|repository guidelines]] and made sure your addon is compliant with them, you may begin the submission process using the following steps.

=== Allowed submissions ===

We have restricted the allowed submissions of add-ons to past Kodi versions.
Several reasons:
* Kodi code improvements
* Reduce support load for add-on developers
* Reduce workload for repository maintainers

Below is a table of on which submissions are allowed to official Kodi repository.

{| class="prettytable" border="1"
|+ Allowed add-on submissions
! codename !! version !! update !! new
|-
| Dharma || 10.x || no || no
|-
| Eden || 11.x || no || no
|-
| Frodo || 12.x || no || no
|-
| Gotham || 13.x || yes || no
|-
| Helix || 14.x || yes || no
|-
| Isengard || 15.x || yes || no
|-
| Jarvis || 16.x || yes || no
|-
| Krypton || 17.x || yes || yes
|}

Additional feature is that we now use combined repositories. So if your add-on is Gotham/Helix compatible, you only need to send it to Gotham repository.
If it's only Helix compatible you need to send it to Helix repository.
This of course requires that the minimal Kodi dependencies are set accordingly.

{| class="prettytable" border="1"
|+ Which repos are used
! codename !! version !! repo
|-
| Dharma || 10.x || Dharma
|-
| Eden || 11.x || Eden
|-
| Frodo || 12.x || Frodo
|-
| Gotham || 13.x || Gotham
|-
| Helix || 14.x || Gotham || Helix
|-
| Isengard || 15.x || Gotham || Helix || Isengard
|-
| Jarvis || 16.x || Gotham || Helix || Isengard || Jarvis
|-
| Krypton || 17.x || Gotham || Helix || Isengard || Jarvis || Krypton
|}

{{see also|Addon.xml#Dependency_versions}}

=== Github ===

==== Pull requests ====
New add-ons or updates may be submitted directly to the [[Official add-on repository]] on Github as pull requests. We encourage add-on developers to use this method as the process is easier for both parties involved. Of course this requires some initial git knowledge and we strongly suggest to read up on this subject before using this method. To reduce size we have split up the git repositories in several locations. Please visit [[Official add-on repository]] to see where they are. Each contains a small readme with a short description of it's contents as well as a link to a short explanation on how to submit using git command line. There are also git tools available that have a graphic interface and the steps above should be done in a similar way. Please consult the manual of those programs.

In addition to the [[Add-on rules|repository guidelines]] the following rules apply when submitting PRs on Github:

* PR should contain one commit only.
* Commit message should have the format "[addonid] version". Example: "[my.cool.addon] 1.0.1"

Only PRs from the add-on author or his successor will be accepted. Patches should be submitted upstream to the original author first. For an easy way to create PR from your own git repository, see [[HOW-TO: create add-on PRs using Git Subtree Merging]].

==== Issue ticket ====
If you are not experienced yet with git and pull requests you may also use the "issue" option where you submit a request to get you add-on added. In this ticket you need to provide the basic information needed so our repo maintainers know where to get the correct version.
This consists of
- Add-on name:
- Add-on ID:
- Version number:
- Kodi/repository version:
- Code location URL:
- Revision/tag:
- Branch:

Further information is provide when you initially create the issue on github as comments in the ticket.
Same [[Add-on rules|repository guidelines]] apply here as well.

WARNING: Do not create bug tickets in these repositories as they will be closed without notice.

==== How to submit your add-on and subsequent updates ====
Submitting updates is done the same way as with pull requests or issue ticket.

==== Repository lists ====
You can create pull requests or tickets on the following individual repositories.

https://github.com/xbmc/repo-plugins
https://github.com/xbmc/repo-resources
https://github.com/xbmc/repo-scrapers
https://github.com/xbmc/repo-scripts
https://github.com/xbmc/repo-skins
https://github.com/xbmc/repo-webinterfaces

=== Additional information ===
Note that skin .xbt files will be generated automatically for skins so you do not include this in your pull request or created tickets.
After the add-on has been added or updated it will be available from the Kodi repository in Kodi itself, on http://addons.kodi.tv/ and on the wiki page http://kodi.wiki/index.php?title=Category:All_add-ons.

{{Note|Please locate you add-on in the root of the git repository. This to make sure we can easily pull the add-on into our repository.
Example: https://github.com/XBMC-Addons/service.xbmc.versioncheck}}

{{tip|We automatically combine all repos into one single repo list on our server and provide that list to Kodi. You only need to do a request for the minimum repo your add-on supports.}}

=== The mailing list ===

''' MAILINGLIST IS NOT USED ANYMORE. ALL REQUESTS SHOULD GO THROUGH GITHUB '''

[[Category:Add-on development]]

Addon.xml

2017-01-28T11:43:36Z

Martijn: /* Dependency versions */

{{mininav|[[Development]]|[[Add-on development]]}}
<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.

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

<syntaxhighlight lang="xml" enclose="div">
<?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.1.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></language>
<platform>all</platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
<news></news>
<assets>
<icon></icon>
<fanart></fanart>
<screenshot></screenshot>
</assets>
</extension>
</addon>
</syntaxhighlight>

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

* The <code><addon></code> element must be present, and be the root node. It presents data about the add-on package as a whole.
* 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.
* Then there are one or more <code><extension></code> elements, each of which describes a part of Kodi that the add-on extends.
* Finally, there is a specific <code><extension></code> element that extends <code>"xbmc.addon.metadata"</code>. This describes the add-on to the user.

= Elements =

== <addon> ==

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:

<source lang="xml">
<addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2">
</source>

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

==== How versioning works ====

* <code>2.2.9</code> is newer than <code>2.2.1</code>
* <code>2.2.10</code> is newer than <code>2.2.1</code>
* <code>2.3.0</code> is newer than <code>2.2.9</code>
* <code>2.2.1</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1</code> is newer than <code>2.2.1~beta</code>
* <code>2.2.1~beta</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1~beta3</code> is newer than <code>2.2.1~beta2</code>
* <code>2.2.1~beta10</code> is newer than <code>2.2.1~beta1</code>

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

== <requires> ==

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.

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 <code><requires></code> block that imports two required modules:

<source lang="xml">
<requires>
<import addon="xbmc.python" version="2.14.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10"/>
</requires>
</source>

Here's another example, which will only install on OpenELEC:

<source lang="xml">
<requires>
<import addon="os.openelec.tv" version="2.0"/>
</requires>
</source>

== <import> ==

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

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.

=== addon attribute ===

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

=== version attribute ===

The <code>version</code> 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 <code>xbmc.*</code> add-on dependencies to control on which version of Kodi the add-on can be installed.

{| class="prettytable" border="1"
|+ Current versions
! Kodi version !! xbmc.python !! xbmc.gui !! xbmc.json !! xbmc.metadata !! xbmc.addon
|-
| Dharma 10.1 <font color="red">Deprecated</font>|| 1.0 || 2.11 || 2.0|| 1.0 || 0.1
|-
| Eden 11.0 <font color="red">Deprecated</font> || 2.0 || 3.0 || 4.0 || 1.0 || 11.0
|-
| Frodo 12.x <font color="red">Deprecated</font>|| 2.1.0 || 4.0.0 || 6.0.0 || 2.1.0 || 12.0.0
|-
| Gotham 13.x || 2.14.0 (ABI 2.1.0) || 5.0.1 || 6.6.0 (ABI 6.0.0) || 2.1.0 || 13.0.0 (ABI 12.0.0)
|-
| Helix 14.x || 2.19.0 (ABI 2.1.0) || 5.3.0 || 6.20.0 (ABI 6.0.0) || 2.1.0 || 14.0.0 (ABI 12.0.0)
|-
| 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 || 15.0.0 (ABI 12.0.0)
|-
| Jarvis 16.x || 2.24.0 (ABI 2.1.0) || 5.10.0 || 6.32.4 (ABI 6.0.0) || 2.1.0 || 16.0.0 (ABI 12.0.0)
|-
| Krypton 17.x || 2.25.0 (ABI 2.1.0) || 5.12.0 || 7.0.0 (ABI 6.0.0) || 2.1.0 || 17.0.0 (ABI 12.0.0)
|-
| Krypton 18.x || 2.25.0 (ABI 2.1.0) || 5.13.0 || 7.0.0 (ABI 6.0.0) || 2.1.0 || 16.9.701 (ABI 12.0.0)
|}

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

=== optional attribute ===

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.

== <extension> ==

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.

The various extension points that Kodi provides are given in the list below.
{| class="prettytable"
!Extension point
!Add-on Category
|-
|<code>[[Skinning|xbmc.gui.skin]]</code>
|Skin
|-
|<code>xbmc.webinterface</code>
|Web interface
|-
|<code>[[Add-on repositories|xbmc.addon.repository]]</code>
|''None''
|-
|<code>[[HOW-TO:_Automatically_start_addons_using_services|xbmc.service]]</code>
|Services
|-
|<code>xbmc.metadata.scraper.albums</code>
|Album information
|-
|<code>xbmc.metadata.scraper.artists</code>
|Artist information
|-
|<code>xbmc.metadata.scraper.movies</code>
|Movie information
|-
|<code>xbmc.metadata.scraper.musicvideos</code>
|Music video information
|-
|<code>xbmc.metadata.scraper.tvshows</code>
|TV information
|-
|<code>xbmc.metadata.scraper.library</code>
|''None''
|-
|<code>xbmc.ui.screensaver</code>
|Screensaver
|-
|<code>xbmc.player.musicviz</code>
|Visualization
|-
|<code>[[Plugin sources#What Kodi requires for your add-on|xbmc.python.pluginsource]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>[[Script sources#What Kodi requires for your add-on|xbmc.python.script]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>xbmc.python.weather</code>
|Weather
|-
|<code>xbmc.subtitle.module</code>
|Subtitle service module
|-
|<code>[[Script lyrics#What Kodi requires for your add-on|xbmc.python.lyrics]]</code>
|Lyrics
|-
|<code>[[Script library#What Kodi requires for your add-on|xbmc.python.library]]</code>
|''None''
|-
|<code>xbmc.python.module</code>
|These don't show up in the addon browser and are purely as support for other scripts.
|-
|<code>xbmc.addon.video</code>
|Video Add-ons (video)
|-
|<code>xbmc.addon.audio</code>
|Music Add-ons (audio)
|-
|<code>xbmc.addon.image</code>
|Picture Add-ons (image)
|-
|<code>kodi.resource.images</code>
|Additional image files
|-
|<code>kodi.resource.language</code>
|Additional language files
|}

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 ===
{{See also|Plugin sources}}

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

==== library attribute ====

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.

==== <provides> element ====

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):

{| class="prettytable"
!Provides
!Appears in
|-
|<code>image</code>
|Pictures
|-
|<code>audio</code>
|Music
|-
|<code>video</code>
|Video
|-
|<code>executable</code>
|Programs
|-
|''(blank)''
|Not visible
|}

==== Example ====

<source lang="xml">
<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py">
<provides>audio video</provides>
</extension>
</source>

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

==== Required elements ====

There are several elements that this should contain and all are compulsory (except the broken tag). Each of the elements below 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 <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)]]).

===== <summary> =====

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.

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

===== <description> =====

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.

<source lang="xml">
<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>
</source>

===== <disclaimer> =====

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.

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

===== <news> =====

{{note|Used in Kodi v17 Krypton and later only. Older versions are forward compatible.}}

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

Here is an example:

<source lang="xml">
<news>v0.1.2 (2014-1-15)
- Added notification for Ubuntu users checking through apt command</news>
</source>

===== <platform> =====

The <code><platform></code> tag specifies which platforms (operating systems, hardware) 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:

* <code>all</code>
* <code>linux</code>
* <code>osx</code>
* <code>osx64</code>
* <code>osx32</code>
* <code>ios</code>
* <code>windx</code>
* <code>android</code>

<source lang="xml">
<platform>all</platform>
</source>

===== <language> =====

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, leave it blank.

<source lang="xml">
<language>en de fr</language>
or
<language></language>
</source>

===== <license> =====

The <code><license></code> element indicates what license is used for this add-on.

<source lang="xml">
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
</source>

===== <forum> =====

The <code><forum></code> element provides the forum thread URL for this specific add-on. Leave this blank if there is no forum thread.
<source lang="xml">
<forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum>
</source>

===== <website> =====

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

<source lang="xml">
<website>http://www.myaddonwebsite.com/</website>
</source>

===== <nowiki><source></nowiki> =====

The <code><nowiki><source></nowiki></code> element provides the URL for the source code for this specific add-on.
<syntaxhighlight lang="xml" enclose="div">
<source>http://github.com/someone/myaddon</source>
</syntaxhighlight>

===== <email> =====

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.
<source lang="xml">
<email>foo@bar.com</email>
or
<email>foo at bar dot com</email>
</source>

===== <broken> =====

The <code><broken></code> tag will mark the add-on as broken in the Kodi repo and provide the reason why. You don't need to do a version bump for this to work. However a bump is recommended as you could also add this to the changelog.

<source lang="xml">
<broken>deprecated</broken>
</source>

===== <assets> =====

{{note|Kodi v17 Krypton and later.}}

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 are:

* <code><icon></code> See [[Add-on_structure#icon.png]]
* <code><fanart></code> See [[Add-on_structure#fanart.jpg]]
* <code><screenshot></code>

If some elements are empty or not specified, it will be treated as non-existing/not provided.

Example:
<source lang="xml">
<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>
</assets>
</source>

With the above example definition, the files must be placed in the <code>resources</code> folder.

== Skin specific elements ==
=== Overview ===
{| class="prettytable"
| '''effectslowdown'''
| 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.
|-
| '''debugging'''
| When set to true, it'll display onscreen debug information (xml filename, mouse position and focused control type and name) in the skin.
|-
| '''res'''
| Support for arbitrary skin resolutions.
|}

=== How window xml files are found ===

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.

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

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

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

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.

= Examples =

== addon.xml for skins ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<addon
id="skin.confluence"
version="2.1.3"
name="Confluence"
provider-name="Jezz_X, Team Kodi">
<requires>
<import addon="xbmc.gui" version="4.0.0"/>
</requires>
<extension
point="xbmc.gui.skin"
debugging="false"
effectslowdown="0.75">
<res width="1280" height="720" aspect="16:9" default="true" folder="720p" />
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Confluence skin by Jezz_X. (Kodi's default skin)</summary>
<description lang="en">Confluence is the default skin for Kodi 9.11 and above. It is a combination of concepts from many popular skins, and attempts to embrace and integrate their good ideas into a skin that should be easy for first time Kodi users to understand and use.</description>
<disclaimer lang="en">Confluence is the default skin for Kodi, removing it may cause issues</disclaimer>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
<news></news>
<assets>
<icon></icon>
<fanart></fanart>
<screenshot></screenshot>
</assets>
</extension>
</addon>
</syntaxhighlight>
One thing to note is that <font color="red">all tag names are lower case.</font> XML tag names are case sensitive!

== addon.xml for scripts ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon
id="script.artwork.downloader"
name="Artwork Downloader"
version="12.0.12"
provider-name="Martijn">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
<import addon="xbmc.json" version="6.0.0"/>
<import addon="xbmc.addon" version="12.0.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10" optional="true"/>
<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.service" library="service.py" start="login"/>
<extension point="xbmc.addon.metadata">
<summary lang="en">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary>
<description lang="en">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">For bugs, requests or general questions visit the Artwork Downloader thread on the Kodi forum.</disclaimer>
<language></language>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
<news></news>
<assets>
<icon></icon>
<fanart></fanart>
<screenshot></screenshot>
</assets>
</extension>
</addon>
</syntaxhighlight>

= Schema Definition =

The XML schema definition for <code>addon.xml</code> is located [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.addon/metadata.xsd here].

{{frodo updated}}

[[Category:Add-on development]]
[[Category:Skin development]]

Language support

2016-12-30T10:22:43Z

Martijn:

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

{{cleanup}}
The following page explains exactly how to add a new language translation to Kodi, and how to maintain/update an existing language file in Kodi. English (United Kingdom) is the default language of Kodi so it is the English language in the Git repository that is always up-to-date, please always base your translations of the latest English language file from Git. The latest language files for Kodi can be found and downloaded [https://github.com/xbmc/xbmc/tree/master/language here (link)].

=== Language add-ons ===
By default Kodi only includes one language which is English (united Kingdom). All other languages have been moved to individual language add-ons which are available form our Kodi repository for download and install. They are auto update by Team Kodi once in a while and pushed to our repository from which you will receive these updates depending on what language(s) you have installed.

=== What is langinfo.xml ===
The langinfo.xml file contains language and region specific localization settings used internally by Kodi. Basically it is the default [http://en.wikipedia.org/wiki/Code_page code page] Kodi uses for this language file.

==== Layout of a langinfo.xml file ====
<syntaxhighlight lang="xml" enclose="div">
<language>
<charsets>
<gui>GB2312</gui>
<subtitle>GB2312</subtitle>
</charsets>

<dvd>
<menu>cn</menu>
<audio>cn</audio>
<subtitle>cn</subtitle>
</dvd>
</language>
</syntaxhighlight>

The <charset> section:
<gui>: Specifies the character encoding of everything within Kodi that is not unicode. E.g. id3 tags with none unicode encoding.
<subtitle>: Default character encoding of subtitles when using a TTF (True-Type-Font).
Choose one encoding for each in the list below. The values may differ if you like.
<br />
The <dvd> section:
Defines the default languages for DVD-Video menu, audio and subtitle language for the [[DVDPlayer]]. Choose one for each entry out of the list of ISO-639 language abbreviations. If the DVD-Video you are playing does not support the language that you specified then it will default to English.

=== What is strings.po ===
This files contains all strings displayed in the user interface of Kodi.

==== Layout of the strings.po file ====

<syntaxhighlight lang="python" enclose="div">
# Kodi Media Center language file
# Addon Name: Skin Widgets
# Addon id: service.skin.widgets
# Addon Provider: Martijn, phil65
msgid ""
msgstr ""
"Project-Id-Version: Kodi Addons\n"
"Report-Msgid-Bugs-To: alanwww1@kodi.org\n"
"POT-Creation-Date: YEAR-MO-DA HO:MI+ZONE\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: Kodi Translation Team\n"
"Language-Team: English (http://www.transifex.com/projects/p/xbmc-addons/language/en/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Language: en\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"

msgctxt "#32001"
msgid "Recommended"
msgstr ""

msgctxt "#32002"
msgid "Random Items"
msgstr ""

#empty string with id 32003

msgctxt "#32004"
msgid "Randomize time (minutes)"
msgstr ""

msgctxt "#32005"
msgid "Use season folders"
msgstr ""

</syntaxhighlight>

==== Layout of the language folders ====

Kodi loads the strings.po file depending on the set interface language. Should it find a matching language it will try to load that strings.po. If not available it will always fall back to English (United Kingdom).
For this to work you will need to place the strings.po in the correctly named folder depending on the language. These folders use "language-country" naming scheme.
<syntaxhighlight lang="python" enclose="div">
/resources/language/resource.language.en_gb/strings.po
/resources/language/resource.language.fr_fr/strings.po
/resources/language/resource.language.it_it/strings.po
</syntaxhighlight>

An extensive example list of used languages can be found here https://github.com/xbmc/xbmc/tree/master/addons/skin.estuary/language

==== Layout of the old strings.xml file ====

DEPRECATED! Please Change all your language files and folders to the .po format as mentioned above.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<strings>
<string id="32001">Recommended</string>
<string id="32002">Random Items</string>
<string id="32003">Only unplayed</string>
<string id="32004">Randomize time (minutes)</string>
<string id="32005">Use season folders</string>
<string id="32006">Use timer</string>
<string id="32007">After database update</string>
<string id="32008">Update method</string>
<string id="32009">Recent Items</string>
</strings>

Each string is enclosed in a <string> tag. It contains a tag named id="32001" with a number Kodi uses to reference a string internally.

'''Hint: Multi-Line Text-Values'''<br />
If you want your text-values to span multiple lines, you can insert a new line character [br] in your tag. Although we highly discourage this as it could cause skin problems as not all text boxes have enough room to display these.

For example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<strings>
<string id="32001"><value>This will be on the first line[br]And this will be on the second line</string>
</strings>

The encoding attribute of the XML header sets the charset the file is encoded with. See List of charsets of possible values.
If you don't know what charset your language uses please follow [http://www.science.co.il/Language/Locale-Codes.asp this link] to find out.

=== String ID range ===

Follow the specified string ID range

* strings 30000 thru 30999 reserved for plugins and plugin settings
* strings 31000 thru 31999 reserved for skins
* strings 32000 thru 32999 reserved for scripts
* strings 33000 thru 33999 reserved for common strings used in add-ons

== Adding a new language to Kodi ==

{{see|Translation System}}

== Maintaining a language ==
The English (UK) language file ([https://github.com/xbmc/xbmc/blob/master/addons/resource.language.en_gb/resources/strings.po]) is the master for all language files. From time to time the English (UK) language file changes. This will be automatically update from time to time to Transifex translation pages.

How to keep track of changes:
Use our [[Translation System]]

== Related articles in the Kodi online manual ==
* [[List of Supported Charsets]]
* [[List of language codes (ISO-639:1988)]]

== Notes for developers ==
Kodi uses UTF-8 as internal character encoding. Please make sure if you add new features to Kodi which depend on external data to convert these to UTF-8 if they aren't already. Use the languagefile from branches/linuxport, since we merge that file into trunk.

[[Category:Manual]]
[[Category:Development]]
[[Category:Skin development]]
[[Category:Languages|*]]

Submitting Add-ons

2016-12-13T18:50:47Z

Martijn: death to the mailinglist

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

=== Submitting a Compliant Add-on to the Kodi.tv Repo ===

After you have read the [[Add-on rules|repository guidelines]] and made sure your addon is compliant with them, you may begin the submission process using the following steps.

=== Allowed submissions ===

We have restricted the allowed submissions of add-ons to past Kodi versions.
Several reasons:
* Kodi code improvements
* Reduce support load for add-on developers
* Reduce workload for repository maintainers

Below is a table of on which submissions are allowed to official Kodi repository.

{| class="prettytable" border="1"
|+ Allowed add-on submissions
! codename !! version !! update !! new
|-
| Dharma || 10.x || no || no
|-
| Eden || 11.x || no || no
|-
| Frodo || 12.x || no || no
|-
| Gotham || 13.x || yes || no
|-
| Helix || 14.x || yes || no
|-
| Isengard || 15.x || yes || no
|-
| Jarvis || 16.x || yes || yes
|-
| Krypton || 17.x || yes || yes
|}

Additional feature is that we now use combined repositories. So if your add-on is Gotham/Helix compatible, you only need to send it to Gotham repository.
If it's only Helix compatible you need to send it to Helix repository.
This of course requires that the minimal Kodi dependencies are set accordingly.

{| class="prettytable" border="1"
|+ Which repos are used
! codename !! version !! repo
|-
| Dharma || 10.x || Dharma
|-
| Eden || 11.x || Eden
|-
| Frodo || 12.x || Frodo
|-
| Gotham || 13.x || Gotham
|-
| Helix || 14.x || Gotham || Helix
|-
| Isengard || 15.x || Gotham || Helix || Isengard
|-
| Jarvis || 16.x || Gotham || Helix || Isengard || Jarvis
|-
| Krypton || 17.x || Gotham || Helix || Isengard || Jarvis || Krypton
|}

{{see also|Addon.xml#Dependency_versions}}

=== Github ===

==== Pull requests ====
New add-ons or updates may be submitted directly to the [[Official add-on repository]] on Github as pull requests. We encourage add-on developers to use this method as the process is easier for both parties involved. Of course this requires some initial git knowledge and we strongly suggest to read up on this subject before using this method. To reduce size we have split up the git repositories in several locations. Please visit [[Official add-on repository]] to see where they are. Each contains a small readme with a short description of it's contents as well as a link to a short explanation on how to submit using git command line. There are also git tools available that have a graphic interface and the steps above should be done in a similar way. Please consult the manual of those programs.

In addition to the [[Add-on rules|repository guidelines]] the following rules apply when submitting PRs on Github:

* PR should contain one commit only.
* Commit message should have the format "[addonid] version". Example: "[my.cool.addon] 1.0.1"

Only PRs from the add-on author or his successor will be accepted. Patches should be submitted upstream to the original author first. For an easy way to create PR from your own git repository, see [[HOW-TO: create add-on PRs using Git Subtree Merging]].

==== Issue ticket ====
If you are not experienced yet with git and pull requests you may also use the "issue" option where you submit a request to get you add-on added. In this ticket you need to provide the basic information needed so our repo maintainers know where to get the correct version.
This consists of
- Add-on name:
- Add-on ID:
- Version number:
- Kodi/repository version:
- Code location URL:
- Revision/tag:
- Branch:

Further information is provide when you initially create the issue on github as comments in the ticket.
Same [[Add-on rules|repository guidelines]] apply here as well.

WARNING: Do not create bug tickets in these repositories as they will be closed without notice.

==== How to submit your add-on and subsequent updates ====
Submitting updates is done the same way as with pull requests or issue ticket.

==== Repository lists ====
You can create pull requests or tickets on the following individual repositories.

https://github.com/xbmc/repo-plugins
https://github.com/xbmc/repo-resources
https://github.com/xbmc/repo-scrapers
https://github.com/xbmc/repo-scripts
https://github.com/xbmc/repo-skins
https://github.com/xbmc/repo-webinterfaces

=== Additional information ===
Note that skin .xbt files will be generated automatically for skins so you do not include this in your pull request or created tickets.
After the add-on has been added or updated it will be available from the Kodi repository in Kodi itself, on http://addons.kodi.tv/ and on the wiki page http://kodi.wiki/index.php?title=Category:All_add-ons.

{{Note|Please locate you add-on in the root of the git repository. This to make sure we can easily pull the add-on into our repository.
Example: https://github.com/XBMC-Addons/service.xbmc.versioncheck}}

{{tip|We automatically combine all repos into one single repo list on our server and provide that list to Kodi. You only need to do a request for the minimum repo your add-on supports.}}

=== The mailing list ===

''' MAILINGLIST IS NOT USED ANYMORE. ALL REQUESTS SHOULD GO THROUGH GITHUB '''

[[Category:Add-on development]]

Add-on rules

2016-12-04T08:07:35Z

Martijn: /* Requirements for scripts and plugins */

{{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) or (512x512)
* [[Add-on structure#fanart.jpg|fanart.jpg]] must be present (1280x720 or 1920x1080)
* [[Add-on structure#LICENSE.txt|LICENCE.txt]] must be present
{{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.

'''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.
* Plugins should '''not''' force certain skin viewtypes on their own. They should set the correct media content from which the correct skin view type is automatically provided.
''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.

=== 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]]

Jenkins

2016-10-02T19:06:50Z

Martijn: /* Testing Pull Requests */

{{mininav|[[Team Kodi]]{{l2|[[Development]]}}|[[:Category:Team Kodi specific notes]]<br /> }}

<section begin="intro" />This page describes the "Jenkins" builder used by [[Team Kodi]] to build the variety of releases of Kodi.<section end="intro" />

== Jenkins ==

[[File:Jenkins_Start.JPG|left|300px| ]]
Jenkins is the successor of [[Buildbot]] which was harder to maintain and Jenkins also offers a wide variety of plugin that can be used to benefit further development and testing.

When going to http://jenkins.kodi.tv you are shown the current frontpage like shown below and you start at the ''dashboard'' giving you several build statistics and overview of current used builders.

You also see tabs for each platform that contain specific builders for each one of those.
The ''helpers'' contains like the name says helpers that can aid in doing quick builds like ''build all platforms'' or uploading of Kodi releases to our mirrors.
{{-}}

== Building ==

Building using Jenkins is only possible if given access from Team Kodi administrators and is restricted to Team Kodi members.

=== Automated builds ===

At the moment we use the job '''BuildMulti-All''' which is triggered by a timer to create the nightly builds each day. These timed builds are considered '''nightly builds''' and are uploaded to http://mirrors.kodi.tv/nightlies/
It starts the list of separate jobs listed below and by default will build the '''master''' branch from https://github.com/xbmc/xbmc
* Android-ARM
* Android-ARM64-v8a
* Android-X86
* iOS
* LINUX-64
* LINUX-RBPI
* OSX-64
* WIN-32

During Kodi RC and Final stage these builds might be switched to build the release branch. The purpose for this is to have continues testing until final release on the release branch of Kodi.

== Starting manual build ==

To start a manual build to build a certain release or just for testing/compiling purpose you have two choices.

=== Specific platform ===

{| class="wikitable" border="1"
| [[File:Jenkins_platforms.jpg|left|300px| ]] || To build a specific platform you must click on the platform of choice you want.
|-
| [[File:Jenkins_singlebuild1.jpg|left|300px| ]] || After that you are presented with the following screen (some option may not be visible to you due to restrictions).
This gives an overview of the available option and the build history of the platform.

To start a build click on '''Build Now'' where you can provide the necessary information on what you want to build.
|-
| [[File:Jenkins_singlebuild2.jpg|left|300px| ]] || Here you can choose what type of release you want to build, branch/tag or commit (REVISION) and the github account the branch is located in (GITHUB_REPO). If you want to upload the finished build to the server http://mirrors.kodi.tv/test-builds/ check the box to upload it.

Do note if you just want to do a compile run, please disable uploading the results as this will save in total time needed and won't upload unnecessary builds to our mirrors.
|}

Once you started building you can follow it's progress with the progress bars or click on the console to view the compiling progress.

=== Build all platforms ===

[[File:Jenkins_buildall1.jpg|left|300px| ]]
By clicking on the '''XBMC-BuildMulti-All''' job in the ''helper'' tab you get several options on the left side just like on a single platform build. Click on '''Start a new build'''.
This process is the same as the single builds for each platforms with the only change this will trigger each individual builder that is currently linked to this build job.
{{-}}

==Jenkins & Github Integration==
===Testing Pull Requests===

Before merging a pull request a Jenkins build must be triggered to ensure all platforms that are enabled continue to compile. Which are usually the same as the automated builds. After the pull request has been successfully built by Jenkins then the pull request will show that it is "safe to merge".
<br />

The following trigger phrases can be commented to pull requests by team members:
<br />
* '''jenkins build this please''' - jenkins builds the PR and sets the PR status after that
* '''jenkins build this with addons please''' - jenkins builds the PR and add-ons and sets the PR status after that
* '''jenkins build and merge''' - jenkins builds the PR and if successfull merges it to master
* '''jenkins build addons please''' - jenkins builds the binary addons from a PR and sets the PR status after that
* '''jenkins build kore''' - jenkins builds the official kodi remote "Kore" and sets the PR status after that
* '''jenkins build kore and merge''' - jenkins builds the official kodi remote "Kore" and if successfull merges it to master

'''Note -''' This will only work for Team Kodi members who have github commit rights, or alternative Team Kodi members who don't have commit rights but have been added to the special "jenkins-access" team on github (the list of these members is at '''[https://github.com/orgs/xbmc/teams/jenkins-access Jenkins-Access]''')

===Configure Jenkins & Github Integration===
Described below are the Steps required to make sure you are authorised to trigger Jenkins build on Github.
{{collapse top|Click "Expand" to see the steps required to configure Jenkins & Github integration}}

<gallery widths=500px heights=400px>
File:jenkinsgithub1.jpg|'''Step 1:''' From XBMC Foundation page https://github.com/xbmc select "People"
File:jenkinsgithub2.jpg|'''Step 2:''' Find your username then check "Organisation visibility" is set to "Public"
File:jenkinsgithub3.jpg|'''Step 3:''' Go to http://jenkins.kodi.tv and log in
File:jenkinsgithub4.jpg|'''Step 4:''' You should be presented with the Authorize application screen, select "Authorize application"
File:jenkinsgithub5.jpg|'''Step 5:''' Go to your Github "Personal settings" and "Applications" and you should see an entry for "jenkins.kodi.tv"
</gallery>
{{collapse bottom}}
{{-}}

== See also ==
* [[Development]]
* [[Git Usage]]
* [[HOW-TO:Submit a patch]]

[[Category:Development]]
[[Category:Team Kodi specific notes]]

Jenkins

2016-10-02T19:04:59Z

Martijn: /* Specific platform */

{{mininav|[[Team Kodi]]{{l2|[[Development]]}}|[[:Category:Team Kodi specific notes]]<br /> }}

<section begin="intro" />This page describes the "Jenkins" builder used by [[Team Kodi]] to build the variety of releases of Kodi.<section end="intro" />

== Jenkins ==

[[File:Jenkins_Start.JPG|left|300px| ]]
Jenkins is the successor of [[Buildbot]] which was harder to maintain and Jenkins also offers a wide variety of plugin that can be used to benefit further development and testing.

When going to http://jenkins.kodi.tv you are shown the current frontpage like shown below and you start at the ''dashboard'' giving you several build statistics and overview of current used builders.

You also see tabs for each platform that contain specific builders for each one of those.
The ''helpers'' contains like the name says helpers that can aid in doing quick builds like ''build all platforms'' or uploading of Kodi releases to our mirrors.
{{-}}

== Building ==

Building using Jenkins is only possible if given access from Team Kodi administrators and is restricted to Team Kodi members.

=== Automated builds ===

At the moment we use the job '''BuildMulti-All''' which is triggered by a timer to create the nightly builds each day. These timed builds are considered '''nightly builds''' and are uploaded to http://mirrors.kodi.tv/nightlies/
It starts the list of separate jobs listed below and by default will build the '''master''' branch from https://github.com/xbmc/xbmc
* Android-ARM
* Android-ARM64-v8a
* Android-X86
* iOS
* LINUX-64
* LINUX-RBPI
* OSX-64
* WIN-32

During Kodi RC and Final stage these builds might be switched to build the release branch. The purpose for this is to have continues testing until final release on the release branch of Kodi.

== Starting manual build ==

To start a manual build to build a certain release or just for testing/compiling purpose you have two choices.

=== Specific platform ===

{| class="wikitable" border="1"
| [[File:Jenkins_platforms.jpg|left|300px| ]] || To build a specific platform you must click on the platform of choice you want.
|-
| [[File:Jenkins_singlebuild1.jpg|left|300px| ]] || After that you are presented with the following screen (some option may not be visible to you due to restrictions).
This gives an overview of the available option and the build history of the platform.

To start a build click on '''Build Now'' where you can provide the necessary information on what you want to build.
|-
| [[File:Jenkins_singlebuild2.jpg|left|300px| ]] || Here you can choose what type of release you want to build, branch/tag or commit (REVISION) and the github account the branch is located in (GITHUB_REPO). If you want to upload the finished build to the server http://mirrors.kodi.tv/test-builds/ check the box to upload it.

Do note if you just want to do a compile run, please disable uploading the results as this will save in total time needed and won't upload unnecessary builds to our mirrors.
|}

Once you started building you can follow it's progress with the progress bars or click on the console to view the compiling progress.

=== Build all platforms ===

[[File:Jenkins_buildall1.jpg|left|300px| ]]
By clicking on the '''XBMC-BuildMulti-All''' job in the ''helper'' tab you get several options on the left side just like on a single platform build. Click on '''Start a new build'''.
This process is the same as the single builds for each platforms with the only change this will trigger each individual builder that is currently linked to this build job.
{{-}}

==Jenkins & Github Integration==
===Testing Pull Requests===

Before merging a pull request a Jenkins build must be triggered to ensure all platforms continue to compile, after the pull request has been successfully built by Jenkins then the pull request will show that it is "safe to merge".
<br />

The following trigger phrases can be commented to pull requests by team members:
<br />
* '''jenkins build this please''' - jenkins builds the PR and sets the PR status after that
* '''jenkins build this with addons please''' - jenkins builds the PR and add-ons and sets the PR status after that
* '''jenkins build and merge''' - jenkins builds the PR and if successfull merges it to master
* '''jenkins build addons please''' - jenkins builds the binary addons from a PR and sets the PR status after that
* '''jenkins build kore''' - jenkins builds the official kodi remote "Kore" and sets the PR status after that
* '''jenkins build kore and merge''' - jenkins builds the official kodi remote "Kore" and if successfull merges it to master

'''Note -''' This will only work for Team Kodi members who have github commit rights, or alternative Team Kodi members who don't have commit rights but have been added to the special "jenkins-access" team on github (the list of these members is at '''[https://github.com/orgs/xbmc/teams/jenkins-access Jenkins-Access]''')

===Configure Jenkins & Github Integration===
Described below are the Steps required to make sure you are authorised to trigger Jenkins build on Github.
{{collapse top|Click "Expand" to see the steps required to configure Jenkins & Github integration}}

<gallery widths=500px heights=400px>
File:jenkinsgithub1.jpg|'''Step 1:''' From XBMC Foundation page https://github.com/xbmc select "People"
File:jenkinsgithub2.jpg|'''Step 2:''' Find your username then check "Organisation visibility" is set to "Public"
File:jenkinsgithub3.jpg|'''Step 3:''' Go to http://jenkins.kodi.tv and log in
File:jenkinsgithub4.jpg|'''Step 4:''' You should be presented with the Authorize application screen, select "Authorize application"
File:jenkinsgithub5.jpg|'''Step 5:''' Go to your Github "Personal settings" and "Applications" and you should see an entry for "jenkins.kodi.tv"
</gallery>
{{collapse bottom}}
{{-}}

== See also ==
* [[Development]]
* [[Git Usage]]
* [[HOW-TO:Submit a patch]]

[[Category:Development]]
[[Category:Team Kodi specific notes]]

Jenkins

2016-10-02T19:01:20Z

Martijn: /* Building */

{{mininav|[[Team Kodi]]{{l2|[[Development]]}}|[[:Category:Team Kodi specific notes]]<br /> }}

<section begin="intro" />This page describes the "Jenkins" builder used by [[Team Kodi]] to build the variety of releases of Kodi.<section end="intro" />

== Jenkins ==

[[File:Jenkins_Start.JPG|left|300px| ]]
Jenkins is the successor of [[Buildbot]] which was harder to maintain and Jenkins also offers a wide variety of plugin that can be used to benefit further development and testing.

When going to http://jenkins.kodi.tv you are shown the current frontpage like shown below and you start at the ''dashboard'' giving you several build statistics and overview of current used builders.

You also see tabs for each platform that contain specific builders for each one of those.
The ''helpers'' contains like the name says helpers that can aid in doing quick builds like ''build all platforms'' or uploading of Kodi releases to our mirrors.
{{-}}

== Building ==

Building using Jenkins is only possible if given access from Team Kodi administrators and is restricted to Team Kodi members.

=== Automated builds ===

At the moment we use the job '''BuildMulti-All''' which is triggered by a timer to create the nightly builds each day. These timed builds are considered '''nightly builds''' and are uploaded to http://mirrors.kodi.tv/nightlies/
It starts the list of separate jobs listed below and by default will build the '''master''' branch from https://github.com/xbmc/xbmc
* Android-ARM
* Android-ARM64-v8a
* Android-X86
* iOS
* LINUX-64
* LINUX-RBPI
* OSX-64
* WIN-32

During Kodi RC and Final stage these builds might be switched to build the release branch. The purpose for this is to have continues testing until final release on the release branch of Kodi.

== Starting manual build ==

To start a manual build to build a certain release or just for testing/compiling purpose you have two choices.

=== Specific platform ===

{| class="wikitable" border="1"
| [[File:Jenkins_platforms.jpg|left|300px| ]] || To build a specific platform you must click on the platform of choice you want.
|-
| [[File:Jenkins_singlebuild1.jpg|left|300px| ]] || After that you are presented with the following screen (some option may not be visible to you due to restrictions).
This gives an overview of the available option and the build history of the platform.

To start a build click on '''Build Now'' where you can provide the necessary information on what you want to build.
|-
| [[File:Jenkins_singlebuild2.jpg|left|300px| ]] || Here you can choose what type of release you want to build, branch/tag or commit, if you want to upload the finished build to the server http://mirrors.kodi.tv/test-builds/ and what git repository you want to build from (i.e. your own one).

Do note if you just want to do a compile run, please disable uploading the results as this will save in total time needed and won't upload unnecessary builds to our mirrors.
|}

Once you started building you can follow it's progress with the progress bars or click on the console to view the compiling progress.

=== Build all platforms ===

[[File:Jenkins_buildall1.jpg|left|300px| ]]
By clicking on the '''XBMC-BuildMulti-All''' job in the ''helper'' tab you get several options on the left side just like on a single platform build. Click on '''Start a new build'''.
This process is the same as the single builds for each platforms with the only change this will trigger each individual builder that is currently linked to this build job.
{{-}}

==Jenkins & Github Integration==
===Testing Pull Requests===

Before merging a pull request a Jenkins build must be triggered to ensure all platforms continue to compile, after the pull request has been successfully built by Jenkins then the pull request will show that it is "safe to merge".
<br />

The following trigger phrases can be commented to pull requests by team members:
<br />
* '''jenkins build this please''' - jenkins builds the PR and sets the PR status after that
* '''jenkins build this with addons please''' - jenkins builds the PR and add-ons and sets the PR status after that
* '''jenkins build and merge''' - jenkins builds the PR and if successfull merges it to master
* '''jenkins build addons please''' - jenkins builds the binary addons from a PR and sets the PR status after that
* '''jenkins build kore''' - jenkins builds the official kodi remote "Kore" and sets the PR status after that
* '''jenkins build kore and merge''' - jenkins builds the official kodi remote "Kore" and if successfull merges it to master

'''Note -''' This will only work for Team Kodi members who have github commit rights, or alternative Team Kodi members who don't have commit rights but have been added to the special "jenkins-access" team on github (the list of these members is at '''[https://github.com/orgs/xbmc/teams/jenkins-access Jenkins-Access]''')

===Configure Jenkins & Github Integration===
Described below are the Steps required to make sure you are authorised to trigger Jenkins build on Github.
{{collapse top|Click "Expand" to see the steps required to configure Jenkins & Github integration}}

<gallery widths=500px heights=400px>
File:jenkinsgithub1.jpg|'''Step 1:''' From XBMC Foundation page https://github.com/xbmc select "People"
File:jenkinsgithub2.jpg|'''Step 2:''' Find your username then check "Organisation visibility" is set to "Public"
File:jenkinsgithub3.jpg|'''Step 3:''' Go to http://jenkins.kodi.tv and log in
File:jenkinsgithub4.jpg|'''Step 4:''' You should be presented with the Authorize application screen, select "Authorize application"
File:jenkinsgithub5.jpg|'''Step 5:''' Go to your Github "Personal settings" and "Applications" and you should see an entry for "jenkins.kodi.tv"
</gallery>
{{collapse bottom}}
{{-}}

== See also ==
* [[Development]]
* [[Git Usage]]
* [[HOW-TO:Submit a patch]]

[[Category:Development]]
[[Category:Team Kodi specific notes]]

Jenkins

2016-10-02T18:51:44Z

Martijn: /* Jenkins */

{{mininav|[[Team Kodi]]{{l2|[[Development]]}}|[[:Category:Team Kodi specific notes]]<br /> }}

<section begin="intro" />This page describes the "Jenkins" builder used by [[Team Kodi]] to build the variety of releases of Kodi.<section end="intro" />

== Jenkins ==

[[File:Jenkins_Start.JPG|left|300px| ]]
Jenkins is the successor of [[Buildbot]] which was harder to maintain and Jenkins also offers a wide variety of plugin that can be used to benefit further development and testing.

When going to http://jenkins.kodi.tv you are shown the current frontpage like shown below and you start at the ''dashboard'' giving you several build statistics and overview of current used builders.

You also see tabs for each platform that contain specific builders for each one of those.
The ''helpers'' contains like the name says helpers that can aid in doing quick builds like ''build all platforms'' or uploading of Kodi releases to our mirrors.
{{-}}

== Building ==

Building using Jenkins is only possible if given access from Team Kodi. This is normally restricted to Team Kodi members.

=== Automated builds ===

Automated build are started at a specific time which can be configured at for each job.
At the moment we use the job '''XBMC-BuildAll''' which is triggered by a timer.
It starts the list of separate jobs listed below and by default will build the '''master''' branch from https://github.com/xbmc/xbmc
* XBMC-Android-ARM
* XBMC-IOS-ATV
* XBMC-OSX-32
* XBMC-OSX-64
* XBMC-WIN-32

Timed builds are considered '''nightly builds''' and are uploaded to http://mirrors.kodi.tv/nightlies/
The build time is set using cron and using the ''XBMC-BuildAll'' configure page.

== Starting manual build ==

To start a manual build to build a certain release or just for testing/compiling purpose you have two choices.

=== Specific platform ===

{| class="wikitable" border="1"
| [[File:Jenkins_platforms.jpg|left|300px| ]] || To build a specific platform you must click on the platform of choice you want.
|-
| [[File:Jenkins_singlebuild1.jpg|left|300px| ]] || After that you are presented with the following screen (some option may not be visible to you due to restrictions).
This gives an overview of the available option and the build history of the platform.

To start a build click on '''Build Now'' where you can provide the necessary information on what you want to build.
|-
| [[File:Jenkins_singlebuild2.jpg|left|300px| ]] || Here you can choose what type of release you want to build, branch/tag or commit, if you want to upload the finished build to the server http://mirrors.kodi.tv/test-builds/ and what git repository you want to build from (i.e. your own one).

Do note if you just want to do a compile run, please disable uploading the results as this will save in total time needed and won't upload unnecessary builds to our mirrors.
|}

Once you started building you can follow it's progress with the progress bars or click on the console to view the compiling progress.

=== Build all platforms ===

[[File:Jenkins_buildall1.jpg|left|300px| ]]
By clicking on the '''XBMC-BuildMulti-All''' job in the ''helper'' tab you get several options on the left side just like on a single platform build. Click on '''Start a new build'''.
This process is the same as the single builds for each platforms with the only change this will trigger each individual builder that is currently linked to this build job.
{{-}}

==Jenkins & Github Integration==
===Testing Pull Requests===

Before merging a pull request a Jenkins build must be triggered to ensure all platforms continue to compile, after the pull request has been successfully built by Jenkins then the pull request will show that it is "safe to merge".
<br />

The following trigger phrases can be commented to pull requests by team members:
<br />
* '''jenkins build this please''' - jenkins builds the PR and sets the PR status after that
* '''jenkins build this with addons please''' - jenkins builds the PR and add-ons and sets the PR status after that
* '''jenkins build and merge''' - jenkins builds the PR and if successfull merges it to master
* '''jenkins build addons please''' - jenkins builds the binary addons from a PR and sets the PR status after that
* '''jenkins build kore''' - jenkins builds the official kodi remote "Kore" and sets the PR status after that
* '''jenkins build kore and merge''' - jenkins builds the official kodi remote "Kore" and if successfull merges it to master

'''Note -''' This will only work for Team Kodi members who have github commit rights, or alternative Team Kodi members who don't have commit rights but have been added to the special "jenkins-access" team on github (the list of these members is at '''[https://github.com/orgs/xbmc/teams/jenkins-access Jenkins-Access]''')

===Configure Jenkins & Github Integration===
Described below are the Steps required to make sure you are authorised to trigger Jenkins build on Github.
{{collapse top|Click "Expand" to see the steps required to configure Jenkins & Github integration}}

<gallery widths=500px heights=400px>
File:jenkinsgithub1.jpg|'''Step 1:''' From XBMC Foundation page https://github.com/xbmc select "People"
File:jenkinsgithub2.jpg|'''Step 2:''' Find your username then check "Organisation visibility" is set to "Public"
File:jenkinsgithub3.jpg|'''Step 3:''' Go to http://jenkins.kodi.tv and log in
File:jenkinsgithub4.jpg|'''Step 4:''' You should be presented with the Authorize application screen, select "Authorize application"
File:jenkinsgithub5.jpg|'''Step 5:''' Go to your Github "Personal settings" and "Applications" and you should see an entry for "jenkins.kodi.tv"
</gallery>
{{collapse bottom}}
{{-}}

== See also ==
* [[Development]]
* [[Git Usage]]
* [[HOW-TO:Submit a patch]]

[[Category:Development]]
[[Category:Team Kodi specific notes]]

File:Jenkins Start.JPG

2016-10-02T18:50:44Z

Martijn:

Add-on development

2016-10-01T10:58:54Z

Martijn: Do not link to the pydocs server directly

{{mininav|[[Development]]}}
[[File:Wiki logo.png|150px|link=|left]]
<section begin="intro" />This area contains information, tutorials, and links for creating add-ons (and plug-ins) for Kodi.<section end="intro" />

{{-}}
----
{{huge|'''{{color|black|General}}'''}}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=Nuvola apps kthememgr.png|link=About Add-ons}}
| width="33%" align="center" | {{Main page icon|image=Applications-development.png|link=Add-on structure|title=Add-on Structure}}
| width="33%" align="center" | {{Main page icon|image=Tool-box-icon.png|link=Development Tools}}
|}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=Administration.png|link=Add-on settings}}
| width="33%" align="center" | {{Main page icon|image=60.jpg|link=Special protocol}}
| width="33%" align="center" | {{Main page icon|image=Translate icon.jpg|link=Translation System}}
|}
----
{{huge|'''{{color|black|Add-on Types}}'''}}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=Nuvola apps kthememgr.png|link=Plugin sources}}
| width="33%" align="center" | {{Main page icon|image=Applications-development.png|link=Script sources|title=Scripts}}
| width="33%" align="center" | {{Main page icon|image=Administration.png|link=Script Subtitles}}
|}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=Gnome-system-run.png|link=Service addons}}
| width="33%" align="center" | {{Main page icon|image=Misc-Misc-Box-icon.png|link=HOW-TO:Create a repository for add-ons|title=Repository add-ons}}
| width="33%" align="center" | {{Main page icon|image=Web-icon.png|link=HOW-TO:Write media scrapers|title=Scraper add-ons}}
|}
----
{{huge|'''{{color|black|Tutorials}}'''}}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=Translation - Noun project 987.png|link=HOW-TO:HelloWorld_addon|title=Hello World Tutorial}}
| width="33%" align="center" | {{Main page icon|image=Addons-icon.png|link=Audio/video add-on tutorial|title=General Add-on Tutorial}}
| width="33%" align="center" | {{Main page icon|image=Video.png|link=3rd Party Tutorials}}
|}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=music-icon.png|link=HOW-TO:Audio_addon|title=Audio Tutorial}}
| width="33%" align="center" | {{Main page icon|image=video-icon.png|link=HOW-TO:Video_addon|title=Video Tutorial}}
| width="33%" align="center" | {{Main page icon|image=Visualisation-icon.jpg|link=HOW-TO:Visualisation_addon|title=Visualisation Tutorial}}
|}
----
{{huge|'''{{color|black|Advanced}}'''}}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=Book icon 1.png|link=Python Libraries}}
| width="33%" align="center" | {{Main page icon|image=Network2.png|link=Add-on Repositories}}
| width="33%" align="center" | {{Main page icon|image=Gnome-system-run.png|link=Add-on settings|title=Add-on Settings}}
|}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=bug.png‎‎|link=HOW-TO:Debug_Python_Scripts_with_Eclipse|title=Debugging Python}}
| width="33%" align="center" | {{Main page icon|image=Python.png‎|link=Python Development}}
| width="33%" align="center" | {{Main page icon|image=Blue-Dossier-128.png|link=http://kodi.wiki/view/PyDocs PyDocs}}
|}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=501159.png‎‎|link=JSON-RPC API}}
| width="33%" align="center" | {{Main page icon|image=Helix2.png‎|link=Helix API changes}}
| width="33%" align="center" | {{Main page icon|image=Apps-Brackets-B-icon.png‎|link=List of built-in functions}}
|}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=Eclipse_ide_icon_by_necromod-d5lt9zc.png‎|link=HOW-TO:Debug_Python_Scripts_with_Eclipse|title=Debugging with Eclipse}}
| width="33%" align="center" | {{Main page icon|image=winpdb.png‎|link=HOW-TO:Debug python scripts with WinPDB|title=Debugging with WinPDB}}
| width="33%" align="center" | {{Main page icon|image=Unicode icon.jpg|link=Add-on unicode paths}}
|}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=shopping-list-generator-icon.png‎|link=InfoLabels|title=List of info labels}}
| width="33%" align="center" | {{Main page icon|image=Windowsicon.png‎‎|link=Window IDs|title=List of window IDs}}
| width="33%" align="center" | {{Main page icon|image=Boolean_operation_icon.jpg‎|link=List of boolean conditions}}
|}
----
{{huge|'''{{color|black|Publishing}}'''}}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=Upload-128.png|link=Submitting Add-ons}}
| width="33%" align="center" | {{Main page icon|image=Thumbs up font awesome.png‎|link=Add-on Rules}}
|}
----
{{huge|'''{{color|black|Repositories}}'''}}
{| width="100%"
|- valign="top"
| width="33%" align="center" | {{Main page icon|image=Thumbnail-symbol-transparent.png|link=Official_add-on_repository|title=Official Add-on Repository}}
| width="33%" align="center" | {{Main page icon|image=Zappy.png|link=Add-on Website}}
| width="33%" align="center" | {{Main page icon|image=Box_icon.png‎|link=Unofficial add-on repositories|title=Third-party Add-on Repositories}}
|}

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

Add-on rules

2016-09-24T10:11:51Z

Martijn: /* General requirements */ allow 512x512 icons

{{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) or (512x512)
* [[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]]

Archive:Team Kodi/Members

2016-09-23T21:40:42Z

Martijn: /* Project Managers */

{{mininav|[[Team Kodi]]}}
{{notice|'''PLEASE DON'T E-MAIL OR PM ANYONE DIRECTLY ABOUT SUPPORT! INSTEAD USE THE COMMUNITY FORUM OR IRC-CHANNELS!'''}}

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

'''''This list is likely incomplete, so give us a nudge if we forgot you'''''
{{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).}}
{{TOCright}}
= Active members =

== XBMC Foundation Voting Board Members and Non-Voting Officers ==
{{Main|XBMC Foundation}}
{{#lst:XBMC Foundation|intro}}
{{#lst:XBMC Foundation|Foundation members}}

== Project Managers ==
* [[User:Pike|Pike]] - The Bossman
* [[User:Natethomas|Natethomas]] - Community Manager
* [[User:Martijn|Martijn]] - Project/Release Manager

== Developers (General) ==
* abelier - video decoding
* [[User:alanwww1|alanwww1]] - Translations, Intel related stuff
* [[User:Alcoheca|Alcoheca]]
* [[User:Alwinus|Alwinus]] - C++ add-on systems
* [[User:amet|amet]]
* [[User:Anssi|Anssi]]
* [[User:Arnova|Arnova]] - Curl/webdav filesystem(s), general bug fixes
* [[User:bobo1on1|bobo1on1]] - Video Playback, General Bugfixes
* [[User:Chadoe|Chadoe]] - general bug fixes
* [[User:opdenkamp|opdenkamp]] - PVR, EPG
* [[User:dteirney|dteirney]] - MythTV Integration
* [[User:elupus|elupus]] - Kodi video player (DVDPlayer) god
* [[User:firnsy|firnsy]] - Database
* [[User:Fneufneu|Fneufneu]] - BSD Developer
* [[User:freezy|freezy]] - Android Remote Developer
* [[User:garbear|garbear]]
* [[User:gnif|gnif]] - Audio, Audio Engine
* [[User:jfcarroll|jfcarroll]] - swig integration, binary addon developer
* [[User:Jmarshall|Jmarshall]] - Jedi-Master
* JoeTheFox - iPhone Remote Developer
* [[User:Malard|Malard]] - Web
* [[User:Memphiz|Memphiz]] - vfs, zeroconf, AirPlay and general stuff
* [[User:Montellese|Montellese]] - JSONRPC
* night199uk - Music library
* [[User:olympia|olympia]] - scraper developer/repo maintainer
* [[User:phi2039|phi2039]] - Audio, Assembly, and anything that sounds like it might be challenging...
* [[User:pieh|pieh]] - General code tinkering
* [[User:taxigps|taxigps]]
* [[User:Topfs2|Topfs2]] - JSONRPC, ARM, power, storage, dbus
* [[User:the_alien|the_alien]] - Android Remote Developer
* [[User:VDRfan|VDRfan]] - General
* [[User:Herrnst|Herrnst]] - LCD display coding
* [[User:Voyager|Voyager]] - hunting bugs in library, dvdplayer etc.
* [[User:ulion|ulion]]

== Developers (Linux) ==
* [[User:AlTheKiller|AlTheKiller]]
* [[User:Amejia|Amejia]] - Debian, etc.
* [[User:Anssi|Anssi]]
* [[User:Arnova|Arnova]]
* [[User:bobo1on1|bobo1on1]]
* [[User:opdenkamp|opdenkamp]]
* [[User:Erhnam|Erhnam]] - XBMCFreak creater, Live Distro developer
* [[User:firnsy|firnsy]]
* [[User:l.capriotti|l.capriotti]] - LiveUSB Distro
* [[User:malloc|malloc]]
* [[User:monkeyman 67156|monkeyman 67156]]
* [[User:Phaeodaria|Phaeodaria]]
* [[User:sraue|sraue]] - OpenELEC.tv Developer
* [[User:Topfs2|Topfs2]]
* [[User:VDRfan|VDRfan]]
* [[User:FernetMenta|FernetMenta]] linux, video, windowing, pvr etc developer
* [[User:wsnipex|wsnipex]] Linux PPA
* [[User:fritsch|fritsch]] Linux, ActiveAE, Pulseaudio, VAAPI, User Support, OpenELEC

== Developers (Mac and iOS) ==
* [[User:Beenje|Beenje]] - PowerPC (PPC) specialist
* [[User:davilla|davilla]]
* [[User:Jmarshall|Jmarshall]]
* [[User:Memphiz|Memphiz]] - dark side padawan
* [[User:ulion|ulion]]

== Developers (Windows) ==
* [[User:a11599|a11599]] - primarily windows video and dxva
* [[User:blinkseb|blinkseb]]
* [[User:bobo1on1|bobo1on1]]
* [[User:Chadoe|Chadoe]]
* [[User:CrystalP|CrystalP]]
* [[User:jhsrennie|jhsrennie]]
* [[User:Jmarshall|Jmarshall]]
* [[User:tiben20|tiben20]] - butcher by day, coder by night
* [[User:WiSo|WiSo (aka wsoltys)]]
* [[User:DDDamian|DDDamian]]
* [[User:DanielaE|DanielaE]]
* [[User:Voyager|Voyager]] - general Windows, hunting bugs in library, dvdplayer etc.
* [[User:Koying|Koying]] Windows, Android, mysql

== Developers (ARM) ==
* [[User:McGeagh|McGeagh]]
* [[User:Phaeodaria|Phaeodaria]]
* [[User:Topfs2|Topfs2]]

== Skinners / Graphic-artists ==
* [[User:BigNoid|BigNoid]] - skins
* [[User:da-anda|da-anda]] - graphics
* [[User:freezy|freezy]] - Lead dev of the official XBMC Remote for Android
* [[User:Hitcher|Hitcher]] - skins
* [[User:phil65|phil65]] - skins
* [[User:Piers|Piers]] - skins
* [[User:ronie|ronie]] - skins

== Addon Developers ==
* [[User:Clumsy|Clumsy]]
* [[User:opdenkamp|opdenkamp]] - PVR, EPG
* [[User:Jmarshall|Jmarshall]] - on an as-needed basis
* [[User:Martijn|Martijn]] - python addons
* [[User:ronie|ronie]] - python addons

== Q/A Testers ==
* [[User:keith|keith]] - QA for iOS and OSX projects
* [[User:kricker|kricker]]
* [[User:alanwww1|alanwww1]] - QA for Intel HW, VAAPI
* [[User:Gabbott|Gabbott]]
* [[User:Milhouse|Milhouse]]

== Website services ==
* [[User:Clumsy|Clumsy]] - Forum Moderator
* da-anda - Forum administration
* [[User:DonJ|DonJ]] - Server and Mirror Contact
* [[User:joebrady|joebrady]] - Forum Moderator
* [[User:Prae5|Prae5]] - Forum Moderator
* [[User:Sho|Sho]] - WIKI Structure Guru
* [[User:Zag|Zag]] - Add-on Frontend, Website, General Community Stuff
* [[User:kibje|Kib]] - Server Administrator

= Semi-active =
* [[User:Gamester17|Gamester17]] - formally an active forum moderator, but he still contributes to the wiki.

= Inactive members =

== Project Founders (All Retired) ==
* [[User:Frodo|Frodo]] - now [http://www.team-mediaportal.com MediaPortal] head programmer/founder
* [[User:RUNTiME|RUNTiME]] - now [http://www.runtime360.com runtime360.com] & [http://www.runtime360.com/projects/transcode-360/ Transcode 360]
* [[User:d7o3g4q|d7o3g4q (a.k.a. Duo Egaq)]] M.I.A. (Missing In Action)

== Developers (Currently Inactive or Retired) ==
* [[User:AlTheKiller|AlTheKiller]]
* [[User:davilla|davilla]]
* [[User:MaestroDD|MaestroDD]] - Mac OS X, and Apple TV
* [[User:wattazoum|wattazoum]] - Kodi for Linux packaging specialist
* [[User:AreaScout|AreaScout]]
* [[User:oldnemesis|oldnemesis]]
* [[User:motd2k|motd2k]]
* [[User:Rudd|Rudd]]
* [[User:Kraqh3d|Kraqh3d]]
* [[User:C-Quel|C-Quel]]
* [[User:Agathorn|Agathorn]]
* [[User:Tut-ankh-amon|tut-ankh-amon]]
* [[User:nad|nad]] - [[WebServerHTTP-API|Kodi HTTP API Mastermind]]
* [[User:MrC|MrC]] - Kodi Visualisation/Screensaver Mastermind
* [[User:c0diq|c0diq]] - UPnP (Universial Plug And Play) Mastermind
* [[User:Yuvalt|Yuvalt]] - Kodi Linux port specialist
* [[User:Vulkanr|Vulkanr]] - Kodi Linux and Mac port specialist
* [[User:D4rk|D4rk]] - Kodi Linux and Mac port specialist
* [[User:Bobbin007|Bobbin007]]
* [[User:Tslayer|Tslayer]]
* [[User:GeminiServer|GeminiServer]] - Low-level Hardware Guru
* [[User:Darkie|Darkie]]
* [[User:Forza|Forza]] - M.I.A. (Missing In Action)
* [[User:Butcher|Butcher]]
* [[User:Ysbox|Ysbox]]
* [[User:Guybrush|Guybrush]] - M.I.A. (Missing In Action)
* [[User:Kreet|Kreet]] - M.I.A. (Missing In Action)
* [[User:monkeyhappy|monkeyhappy]] - M.I.A. (Missing In Action)
* [[User:elan|elan (a.k.a. leafmuncher)]] - Kodi for Mac port specialist
* [[User:LiquidIce629|LiquidIce629]] - [[The Web Interface|Kodi Web GUI control-interface]] ([http://www.cliqklabs.com/xbmcwebgui/ Website])
* [[User:Spiff|Spiff]]
* [[User:theuni|theuni]] - Business Relation Manager

== Skinners / Graphic-artists (Retired) ==
* [[User:CHI3f|CHI3f]] - XML Guru and all round Good Guy
* [[User:Chokemaniac|ChokeManiac]] - Project Mayhem
* [[User:Jezz_X|Jezz_X]] - Team skinner & Project Manager of the [http://sourceforge.net/projects/xboxmediacenter Kodi Skinning Project]
* [[User:SmokeHead|SmokeHead]] - Photoshop Guru (Missing In Action)
* [[User:tree_jammer|tree_jammer]] - graphics

== Python Scripters (Retired/Inactive) ==
* [[User:Voinage|Voinage]] - Python Plugin coder
* [[User:rwparris2|rwparris2]] - Python Plugin coder
* [[User:Nuka1195|Nuka1195]] - Python Script coder

== Web Services (Retired/Inactive) ==
* [[User:Granqvist|Granqvist]] - Web Developer
* [[User:blittan|blittan]] - Web and Python Developer

== Testers (Retired/Inactive) ==
* [[User:DDay|DDay]] - [http://forums.xbox-scene.com/index.php?showforum=180 Xbox-Scene.com Forum Mod God]
* [[User:TeknoJuce|TeknoJuce]] CrAzY Canuck
* [[User:Modhack|Modhack]] - French Guru [http://manuel.xboxmediacenter.fr .fr manuel]
* [[User:Donno|Donno]] - 1337 d00d
* [[User:SandmanCL|SandmanCL]] - Quality Assurance
* [[User:ShortySco|ShortySco]] - Quality Assurance
* [[User:Scape|sCAPe]] - Beta-Tester

== #Kodi (FreeNode) IRC Support ==
* [[User:Bizzeh|Bizzeh]] - Mr. Hater ("I want to be in all sections") ([http://www.bizzeh.com Blog])
* [[User:Cocoliso|Cocoliso]] - Spanish
* [[User:DOS4GW|DOS4GW]] - Multi-lingual
* [[User:Jedi79|Jedi79]]
* [[User:MattAAron|MattAAron]]
* [[User:No1CaNTeL|No1CaNTeL]]
* [[User:xLoial|xLoial]] - Seasoned newbie

== Forum and Online Manual (WIKI) Moderators (Retired/Inactive) ==
* [[User:Dankula|Dankula]] - WIKI Editor
* [[User:Loto_Bak|Loto_Bak]] - Al'round support man
* [[User:nimbles|nimbles]]
* [[User:No_Good|No Good]]

= Other =
* [[User:Ned Scott|Ned Scott]] - No longer formerly apart of Team Kodi, but still maintains the official Kodi wiki.

[[Category:Team Kodi]]
[[Category:Team Kodi specific notes]]

Supported hardware

2016-08-24T16:08:31Z

Martijn: /* Windows */ Previous text was not correct

{{mininav|[[General topics]]{{l2|[[Hardware]]}}|[[Installing]]}}
{{see also|Devices and hardware}}
{{forum link2|1=Want to discuss or ask about what hardware is good for Kodi? Check out the [http://forum.kodi.tv/forumdisplay.php?fid=112 Hardware for Kodi subforum]}}
<section begin="intro" />Kodi is officially supported on a number of operating systems and hardware devices that are designed to be connected directly to a TV. Kodi runs well on what are relatively "underpowered" systems, thanks to hardware video decoding being common on nearly all supported platforms. These requirements don't include what might be required for some "advanced" features, such as PVR, which might require additional hardware. <section end="intro" />

= Supported hardware by OS =
== Android ==
{{see also|Android|Android hardware}}
<section begin="Android" />{{Warning|It is highly recommended for users to not make any purchases in anticipation of running Kodi on Android without first researching the device you want to buy. Before you do buy, make sure multiple people have verified that it works! <big><u>'''''If in doubt, do not buy that hardware!'''''</u></big>}}
* Kodi v16 requires Android 4.2 (Android 5.0 or later is recommended).
* {{future note|17|Kodi v17 will require Android 5.0 or higher}}.
* x86 (Intel) or NEON compatible ARM processor, (for example: Nvidia Tegra 3 and newer are fully supported by Kodi, while Tegra 2 and older are not).
* The main aim for the Android port of Kodi is to foremost target media-players/set-top-boxes/sticks that connect to a large screen television and uses a standard remote control as its main interface device, (that is the same market as for HTPC).<section end="Android" />

== iOS ==
{{see also|iOS}}
<section begin="iOS" />
=== ATV2 ===
<section begin="ATV2" />
* As of v15.0, Kodi no longer supports the Apple TV 2.<section end="ATV2" />

=== iDevices ===
<section begin=iDevices />*To '''[[HOW-TO:Install Kodi for iOS|install Kodi for iOS]]''' you must have one of the following:
** a jailbroken [[w:iDevice|iDevice]] running iOS 5.1.1 or higher
** a normal iDevice running iOS 5.1.1 or higher and a Mac running Xcode 7 and higher
* For hardware: iPad (1,2,3,4), iPad Air (1,2), iPad Mini (1,2,3), iPhone (4, 4s, 5, 5c, 5s, 6, 6+, 6s, 6s+), iPod touch (4, 5, 6).<section end=iDevices />
<section end="iOS" />

== Linux ==
{{See also|Linux}}
=== Desktop ===
<section begin="Linux" />
{{Note|Although Ubuntu 12.04 LTS is still being maintained by Canonical, Team Kodi no longer provides binaries for it. Kodi v15 for Ubuntu requires at least Ubuntu 14.04/15.04.}}
{| class="prettytable" style="background-color:#FFFFFF;"
! CPU
| x86 or x86-64 processor such as: Intel Pentium 4/ Pentium M, AMD Athlon 64 / Opteron, or newer CPU (that support [[w:Streaming SIMD Extensions|SSE2]], which all CPUs made within the last 10-years does).
* If your GPU/VPU does not support hardware video decoding then you will require a fast modern processor is required to decode some 1080p videos encoded in H.264, VC-1/WMV9, HEVC/H.265 VP9, etc
* There is ''very'' limited Power PC (PPC) support: [[forum:173287|[Linux] How to install on Linux-ppc]]
|-
! RAM
|
* '''Recommended:''' 1GB or more in a HTPC media player appliance-like computer dedicated for Kodi, and 2GB or more in a computer for multipurpose use.
|-
! Graphics
|
Kodi will run on most graphics cards made within the last 10-years or so, though for good hardware video decoding support a little newer graphics cards can be required. This includes most cards from AMD/ATI, Intel, or NVIDIA which support OpenGL 2.0 or later.
{| class="datatable" width="100%"
! !! ATI !! Intel !! Nvidia
|-
| '''Minimum without HW decoding:''' || [[w:Radeon|ATI Radeon RV710/M92 (HD 4300/4500)]] [[w:Unified Video Decoder#UVD enabled GPUs|Note: These are uvd2.2 cards]] || [[w:Intel GMA|Intel GMA 950 (945G)]] || [[w:GeForce|Nvidia GeForce 6-Series]]
|-
| '''Minimum for HW decoding of 8-bit H.264 and VC-1:''' || [[w:Radeon|AMD/ATI Radeon HD 5000 Series]] or newer || [[w:Intel GMA|Intel GMA X4500HD (G45)]] or newer || [[w:GeForce|Nvidia GeForce 8-Series]] or newer
|-
| '''Minimum for HW decoding of 10-bit HEVC (H.265) and VP9:''' || TBA: [[w:Radeon|AMD Radeon R9 300 Series (R9 380)]] or newer || TBA: [[w:Intel HD and Iris Graphics#Skylake|Intel HD 510 (Skylake)]] or newer || [[w:GeForce|Nvidia GeForce 900 series (GM20x)]] or newer
|}
|-
! Video decoding
| For hardware video decoding, which may be necessary on low-performance CPUs to playback 1080p content, make sure your GPU or VPU supports either VAAPI, VDPAU, or OpenMAX.
|-
! Drive space
| The Kodi application generally only takes up between 100 to 200 MB of space, depending on how the binary is compiled. Technically speaking, if your hardware supports netbooting, you do not even require a internal storage for either the operating-system or for Kodi.
* '''Minimum:''' 4 to 8GB
* '''Recommended:''' 16GB or more
: Depending on how big your video library is. Most of the space required for Kodi comes from the images/artwork cache, which can be adjusted: [[HOW-TO:Reduce disk space usage]].
|}<section end="Linux" />

=== Embedded systems (ARM/MIPS-based hardware) ===
Other than OpenGL ES 2.0 graphics support being a must it is very hard to generalize Kodi hardware requirements for Linux-based operating-system distributions on ARM or MIPS based embedded systems. This is partially due to most of the work in this area still being early/on-going in development. For most ARM and MIPS-based devices, hardware video decoding support will also be needed for most high-definition videos, (and possibly even some standard-definition videos). Some newer and faster high-end ARM/MIPS chipset can decode some high-definition video using software video decoding, but those encoded with the latest video codecs.

'''Here are a few popular embedded hardware devices that are known to work with Kodi and Linux:'''

* '''[[Raspberry Pi]]''' (and Raspberry Pi 2) - Hardware video decoding support for H.264, MPEG-2, and VC-1. GUI is responsive on most light skins. Official supported by many third-party JeOS (Just enough Operating System) Linux distributions made for Kodi such as [[OpenELEC]], [[GeeXboX]], [[Xbian]], and [[OSMC]]
* '''[[Cubox-i]]''' - Official supported by [[OpenELEC]], [[GeeXboX]], [[Xbian]], and [[OSMC]]
* '''Pandaboard''' - [[GeeXboX]] is a good OS/Kodi distro for this platform. Limited support, as it is generally not a development target by Team Kodi. {{editor note|need feedback on performance. A little snippet, like the one above for the R-Pi, will do}}
* '''[[APF6Dev]]''' - [[Buildroot]] is a good OS/Kodi distro for this platform. Based on i.MX6 chip, this platform has good Kodi support since 14.x and GUI is very responsive on most skins.
* '''Various "Android" boxes''' - can run reinstalled with a Linux firmware and boot directly into Kodi. Hardware video decoding for most video codecs, GUI is very responsive on most skins. Running Linux and Kodi on these "Android boxes" will likely result in better performance and enhanced playback capabilities than running Kodi under Android.

=== JeOS implementations for Kodi ===
{{main|JeOS implementations for Kodi}}
{{#lst:JeOS implementations for Kodi|JeOS for Kodi}}

== Mac OS X ==
{{see also|Mac OS X}}
<section begin="Mac OS X" />*Kodi v15/16 requires Mac OS X 10.7 ( Lion) or later.
*{{future note|17|Kodi v17 will require Mac OS X 10.8 or later.}}
*All hardware requirements are the same as those for OS X 10.7. If your computer can run OS 10.7 or later then your hardware should work just fine with Kodi.<section end="Mac OS X" />

== Windows ==
{{See also|Windows}}
{{Note|Due to changes in code it may be possible that older hardware/videocards are no longer supported. If starting of Kodi fails then try upgrading to last available drivers (or beta drivers).}}
<section begin="Windows" />* OS minimum to run Kodi: Windows Vista.
* OS recommended: Windows 7 or higher, which is required for [[w:hardware video decoding|hardware video decoding]]
:: ''Windows Home Server and Windows Server are not supported but have been reported to work with some tweaks.''
* [[w:X86|x86-based computer]]
* GPU that supports at least level [[w:DirectX|DirectX version 9.0c]] and has drivers that have correctly implemented DX11 API support. This does '''NOT''' mean you need DX11!

{{Updated|16}}

[[Category:Manual]]
[[Category:Hardware|*]]
[[Category:Installation]]
[[Category:General topics]]

HOW-TO:Install Kodi on Fire TV

2016-07-21T18:57:46Z

Martijn:

{{mininav| [[Amazon Fire TV]] }}
<section begin="intro" />This page describes some of the methods to install Kodi onto an Amazon Fire TV (box) or Fire TV Stick. The Fire TV uses Kodi for [[android]] and does not require root. All Fire TV products allow sideloading, so no hacking or modification is required to install Kodi.<section end="intro" />

== Enable Debugging on the Fire TV ==
In order to install apps from outside the Amazon app store, we need to enable these options:

:# From the Fire TV Home screen, select '''Settings'''
:# Go to '''System''' -> '''Developer Options'''
:# Enable both the '''ADB Debugging''' and the '''Apps from Unknown Sources''' options.
:# Go to '''System''' -> '''About''' -> '''Network''', and take note of the Fire TV's IP address

== adbLink (Win/Mac/Linux) ==
{| class="infobox"
| {{youtube|-hQ3e9gdsmE}}
|}
adbLink is a companion program for FireTV and Android Kodi & forks. It allows you to sideload Kodi (and other apps) without the bother of downloading the Android SDK and other tools. Additionally, it allows you to copy files to and from Kodi, backup Kodi, root the FireTV, mount USB drives and more.

'''Download website link: http://jocala.com'''

Tutorials for using adbLink to install Kodi:

* http://www.tweaking4all.com/home-theatre/xbmc/kodi-on-amazon-fire-tv/

{{-}}

== ADB command line ==
These are steps to manually install Kodi using the ADB command line tool, as an alternative to using an app like adbLink.

'''General Steps'''

:# Install the Android SDK for your platform: https://developer.android.com/sdk/index.html
:# Follow these instructions to connect ADB to your Amazon Fire TV: https://developer.amazon.com/sdk/asb/connect-adb.html
:# Follow these instructions to install the Kodi app onto the Fire TV (using the ADB tool): https://developer.amazon.com/sdk/asb/app-install.html

=== Setup ADB on Your Host ===
'''Note:''' Your host must be connected to the same network as your Fire TV.

{{ADB setup}}

=== Download Kodi ===
* Current stable version: '''{{current version}}'''
* Download link: '''{{download link|Android}}'''

=== Install Kodi to the Fire TV ===
'''Note:''' If your APK file name contains spaces, make sure you put quotes around it in the adb commands. On OS X and Linux, you may need to prepend <code>./</code> to the adb commands.
:# On your host (PC or other Android device), download your desired Kodi APK
:# Open a Command Prompt (Windows), Terminal (OS X/Linux), or Terminal Emulator app (Android)
:# Navigate (CD) to the directory with your Kodi APK (In Terminal Emulator on Android you only need to run the adb commands)
:# Run the following commands
:#:<code>>adb kill-server</code>
:#:<code>>adb start-server</code>
:#:<code>>adb connect <ip-address-of-fire-tv></code>
:# ADB is connected when it reports the message "connected to <ip-address-of-fire-tv>:<port>"
:# Run one of the following commands
:#:<code>>adb install <apk-file-name></code>
:#:(or if you are upgrading from a previous Kodi install, use this instead)
:#:<code>>adb install -r <apk-file-name></code>
:# Installation is complete when it reports the message "success"

('''Note:''' For Android you need to type in the full path. e.g. >adb install /sdcard/Download/apk-file-name.apk)

=== Launch Kodi on the Fire TV ===
:# From the Fire TV Home screen, select '''Settings'''
:# Select '''Applications'''
:# Find and select your Kodi installation (it may be named "Kodi" or "SPMC")
:# Select '''Launch Application'''
'
''Note:''' Users have reported that you can [http://forum.kodi.tv/showthread.php?tid=191109&pid=1677974#pid1677974 autostart Kodi] after boot using an Android automation apps such as Tasker, AutomateIt, or Llama. Alternately, you can use [http://diegomejia.globat.com/android/AutoPilot.apk Autopilot] to autoboot to Kodi.

'''Launching Kodi from Fire TV Homescreen:''' You can also have Llama (and probably others) [http://forum.kodi.tv/showthread.php?tid=191109&pid=1721346#pid1721346 launch Kodi] when a native Fire TV app like '''Flixter''' is launched from the Fire TV homescreen. Some apps [http://forum.kodi.tv/showthread.php?tid=191109&pid=1721962#pid1721962 work better] than others.

=== Upgrading Kodi ===
Kodi can be upgraded through ADB without losing your settings. To do this, you must use a newer version of the package already installed on the machine.
:# Download the package to your machine
:# Make sure ADB is connected to the Fire TV
:# Run <code>adb install -r <apk-file-name></code>
:# Installation is complete when it reports the message "Success"

Kodi will still go through the "first run" screen the first time it is launched but your settings will remain intact.

=== Downgrading Kodi ===
If you wish to downgrade your version of Kodi (because you installed a test version that didn't work properly, for example) and keep your settings, the following commands will allow you to do so.

: <code>adb uninstall -k org.xbmc.kodi
: adb install <apk-file-name></code>

If you are downgrading using an Android device, you will need to use the "shell" command.

<code>adb shell pm uninstall -k org.xbmc.kodi</code>

== ES File Explorer ==
In order to install apps from outside the Amazon app store, we need to enable these options:

:# From the Fire TV Home screen, select '''Settings'''
:# Go to '''System''' -> '''Developer Options'''
:# Enable both the '''ADB Debugging''' and the '''Apps from Unknown Sources''' options.
:# Go to Amazon app store and download and install ES File Explorer
:# Open ES File Explorer and go to MySearch
:# Type in the address http://mirrors.kodi.tv and hot ok/search
:# Go to the address matching what you just typed in and open it
:# Once you ended up on the website where you see releases/nightlies/snapshots/addons go the bottom right and click on More..
:# Chose Add Bookmark and give it a name. We create a bookmark to easy navigate back to this website
:# Now go to releases -> android -> arm -> and choose the Kodi version you want to install
:# Click on download and once it's finished you can install the official Kodi version.
:# Done

{| class="infobox"
| {{youtube|g4OmFPh0Ps8}}
|}

'''Shown video shows how to do this on Android TV however the process is similar except the enabling of installing unknown apps.'''

{{Updated|17}}

[[Category:How-to]]
[[Category:Fire TV]]
[[Category:Android]]
[[Category:Installation]]

Official:List of Foundation Trademarks

2016-06-27T21:07:35Z

Martijn:

{{mininav|[[XBMC Foundation]]|[[Official:Trademark Policy index|Trademarks]]}}

== List of XBMC Foundation Trademarks ==
As other trademarks are created or registered, this list will be updated. As used in this policy, "trademarks" means not just the XBMC Foundation's logos, but also the names of its various products and projects, also called word marks, (collectively "XBMC Foundation Marks").

=== Wordmarks ===
* Kodi ®
** USPTO (United States of America) registration number [[http://tsdr.uspto.gov/#caseNumber=86284077&caseType=SERIAL_NO&searchType=statusSearch 4852083]]
** BOIP (Benelux) registration [[https://register.boip.int/bmbonline/details/trademark/show.do?markNumberType=REG&markNumber=967662&markID=3392923 link]]
* Kore ™
* XBMC ™
* XBMCbuntu ™
* [[Zappy]] ™
* KodiBuntu ™

=== Logos ===
<gallery>
Side-by-side-dark-transparent.png | Kodi logo with text ™
Thumbnail-symbol-whitebg.png | Kodi logo by itself ™
Kore Artwork Concept 2.png | Kore logo ™
KodiBuntu.png | Kodibuntu logo ™
XBMC logo-solid shadow.png | Classic XBMC logo ™
XBMC new logo.png | XBMC logo ™
Zappy.png | Zappy ™
</gallery>

[[Category:Trademark Policy]]

Submitting Add-ons

2016-06-18T14:36:59Z

Martijn: /* The mailing list */

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

=== Submitting a Compliant Add-on to the Kodi.tv Repo ===

After you have read the [[Add-on rules|repository guidelines]] and made sure your addon is compliant with them, you may begin the submission process using the following steps.

=== Allowed submissions ===

We have restricted the allowed submissions of add-ons to past Kodi versions.
Several reasons:
* Kodi code improvements
* Reduce support load for add-on developers
* Reduce workload for repository maintainers

Below is a table of on which submissions are allowed to official Kodi repository.

{| class="prettytable" border="1"
|+ Allowed add-on submissions
! codename !! version !! update !! new
|-
| Dharma || 10.x || no || no
|-
| Eden || 11.x || no || no
|-
| Frodo || 12.x || no || no
|-
| Gotham || 13.x || yes || no
|-
| Helix || 14.x || yes || no
|-
| Isengard || 15.x || yes || no
|-
| Jarvis || 16.x || yes || yes
|-
| Krypton || 17.x || yes || yes
|}

Additional feature is that we now use combined repositories. So if your add-on is Gotham/Helix compatible, you only need to send it to Gotham repository.
If it's only Helix compatible you need to send it to Helix repository.
This of course requires that the minimal Kodi dependencies are set accordingly.

{| class="prettytable" border="1"
|+ Which repos are used
! codename !! version !! repo
|-
| Dharma || 10.x || Dharma
|-
| Eden || 11.x || Eden
|-
| Frodo || 12.x || Frodo
|-
| Gotham || 13.x || Gotham
|-
| Helix || 14.x || Gotham || Helix
|-
| Isengard || 15.x || Gotham || Helix || Isengard
|-
| Jarvis || 16.x || Gotham || Helix || Isengard || Jarvis
|-
| Krypton || 17.x || Gotham || Helix || Isengard || Jarvis || Krypton
|}

{{see also|Addon.xml#Dependency_versions}}

=== Github ===

Add-on updates may be submitted directly to the [[Official add-on repository]] on Github as pull requests. We encourage add-on developers to use this method as the process is easier for both parties involved. Of course this requires some initial git knowledge and we strongly suggest to read up on this subject before using this method. To reduce size we have split up the git repositories in several locations. Please visit [[Official add-on repository]] to see where they are. Each contains a small readme with a short description of it's contents as well as a link to a short explanation on how to submit using git command line. There are also git tools available that have a graphic interface and the steps above should be done in a similar way. Please consult the manual of those programs.

In addition to the [[Add-on rules|repository guidelines]] the following rules apply when submitting PRs on Github:

* PR should contain one commit only.
* Commit message should have the format "[addonid] version". Example: "[my.cool.addon] 1.0.1"

As with mailing list, only PRs from add-on author will be accepted. Patches should be submitted upstream. For an easy way to create PR from your own git repository, see [[HOW-TO: create add-on PRs using Git Subtree Merging]].

=== The mailing list ===

''' MAILINGLIST IS ONLY USED FOR SKIN SUBMISSIONS. ALL OTHER ADD-ONS SHOULD USE GITHUB '''

Alternatively you can of course continue to submit your add-ons through the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List].
This is done for several reasons.

After you have subscribed to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] you will be send a conformation e-mail. Be sure to accept this before you can submit to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Mailing List].

All pull requests should be sent to this list so that repository maintainers will be notified that you want to add of update your add-on. They will do a sanity check if all seems ok and you are following the Kodi guidelines for add-ons. If any issues or questions arise they will contact you through the e-mail you registered with.
Once all checks out fine your add-on is added to repository and you will receive a confirmation e-mail that it is added.

{{tip|To un-subscribe from the mailinglist follow the same link as [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] and there's the option to unsubscribe at the bottom}}

==== How to submit your add-on and subsequent updates ====

In order to submit your addon, you must send a request that we add or update your add-on to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] (We call this a "pull request."). Each request will require a version bump in the [[addon.xml]]. We ask that you also keep a [[Add-on structure#changelog.txt|changelog.txt]] up to date so that users may easily see what has changed.

Note that .xbt files will be generated automatically for skins so you do not include this in your pull request.

There are several ways to request that we add or update your add-on. Please preface threads using the following conventions:

{| class="prettytable" border="1"
! Type !! Description
|-
| [Git Pull]|| Submit a request that we pull from your repo. This should include a url, branch/tag/revision, and the addon to pull. HEAD is NOT a revision.
|-
| [SVN Pull]|| Same as [Git Pull]
|-
| [Zip Pull]|| By far the least used but still a valid way. Submit a link where the add-on zip can be downloaded from.
For example you can just give us the link to .zip in your dropbox account. We do not want to download it from a public download site that holds questionable content or is filled with ads.
|-
| [Patch]|| Sometimes you may wish to submit a patch to the author for review.
Under most circumstances we will not merge this directly, it should go to the upstream maintainer first.
|}

After you have send it to the mailing list please keep an eye out for any reply from our repository maintainers if there are any remarks or changes needed or a simple confirmation it has been added. Do note it might take some time to process the request.

After it has been added or updated it will be available from the Kodi repository in Kodi itself, on http://addons.kodi.tv/ and on the wiki page http://kodi.wiki/index.php?title=Category:All_add-ons.

{{Note|Please locate you add-on in the root of the git repository. This to make sure we can easily pull the add-on into our repository.
Example: https://github.com/XBMC-Addons/service.xbmc.versioncheck}}

==== Example e-mail ====

Subject:
[Git Pull] my.cool.plugin
Body:
*addon - my.cool.plugin
*version - 1.1.0
*url - git://some.where.git
*revision - a241345a
*branch - master
*xbmc version - helix

{{Note|If you want to request multiple add-ons to be added you can just do this in one e-mail as long as you provide the "Body" part each time for every add-on and every Kodi version you want it to be included to. In this case the subject field doesn't need to contain the add-on name. Do provide the "[Git Pull]" part at least.}}

{{tip|At this moment Frodo/Gotham/Helix combine all repos into one single repo list in Kodi. You only need to do a request for the minimum repo your add-on supports.}}

[[Category:Add-on development]]

Add-on rules

2016-05-02T13:15:22Z

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

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

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

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

Official:Code guidelines and formatting conventions

2016-04-30T08:27:33Z

Martijn:

{{mininav|[[Development]]}}
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. For historic reason the current code doesn't always follow these guidelines however any new code should certainly follow them.

These coding guidelines and formatting conventions are part of our Doxygen documentation which can be generated from code. For easy viewing we also made these guidelines available online https://codedocs.xyz/xbmc/xbmc/code_guidelines.html

[[Category:Development]]

Submitting Add-ons

2016-03-19T12:20:23Z

Martijn:

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

=== Submitting a Compliant Add-on to the Kodi.tv Repo ===

After you have read the [[Add-on rules|repository guidelines]] and made sure your addon is compliant with them, you may begin the submission process using the following steps.

=== Allowed submissions ===

We have restricted the allowed submissions of add-ons to past Kodi versions.
Several reasons:
* Kodi code improvements
* Reduce support load for add-on developers
* Reduce workload for repository maintainers

Below is a table of on which submissions are allowed to official Kodi repository.

{| class="prettytable" border="1"
|+ Allowed add-on submissions
! codename !! version !! update !! new
|-
| Dharma || 10.x || no || no
|-
| Eden || 11.x || no || no
|-
| Frodo || 12.x || no || no
|-
| Gotham || 13.x || yes || no
|-
| Helix || 14.x || yes || no
|-
| Isengard || 15.x || yes || yes
|-
| Jarvis || 16.x || yes || yes
|-
| Krypton || 17.x || yes || yes
|}

Additional feature is that we now use combined repositories. So if your add-on is Gotham/Helix compatible, you only need to send it to Gotham repository.
If it's only Helix compatible you need to send it to Helix repository.
This of course requires that the minimal Kodi dependencies are set accordingly.

{| class="prettytable" border="1"
|+ Which repos are used
! codename !! version !! repo
|-
| Dharma || 10.x || Dharma
|-
| Eden || 11.x || Eden
|-
| Frodo || 12.x || Frodo
|-
| Gotham || 13.x || Gotham
|-
| Helix || 14.x || Gotham || Helix
|-
| Isengard || 15.x || Gotham || Helix || Isengard
|-
| Jarvis || 16.x || Gotham || Helix || Isengard || Jarvis
|-
| Krypton || 17.x || Gotham || Helix || Isengard || Jarvis || Krypton
|}

{{see also|Addon.xml#Dependency_versions}}

=== Github ===

Add-on updates may be submitted directly to the [[Official add-on repository]] on Github as pull requests. We encourage add-on developers to use this method as the process is easier for both parties involved. Of course this requires some initial git knowledge and we strongly suggest to read up on this subject before using this method. To reduce size we have split up the git repositories in several locations. Please visit [[Official add-on repository]] to see where they are. Each contains a small readme with a short description of it's contents as well as a link to a short explanation on how to submit using git command line. There are also git tools available that have a graphic interface and the steps above should be done in a similar way. Please consult the manual of those programs.

In addition to the [[Add-on rules|repository guidelines]] the following rules apply when submitting PRs on Github:

* PR should contain one commit only.
* Commit message should have the format "[addonid] version". Example: "[my.cool.addon] 1.0.1"

As with mailing list, only PRs from add-on author will be accepted. Patches should be submitted upstream. For an easy way to create PR from your own git repository, see [[HOW-TO: create add-on PRs using Git Subtree Merging]].

=== The mailing list ===

Alternatively you can of course continue to submit your add-ons through the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List].
This is done for several reasons.

After you have subscribed to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] you will be send a conformation e-mail. Be sure to accept this before you can submit to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Mailing List].

All pull requests should be sent to this list so that repository maintainers will be notified that you want to add of update your add-on. They will do a sanity check if all seems ok and you are following the Kodi guidelines for add-ons. If any issues or questions arise they will contact you through the e-mail you registered with.
Once all checks out fine your add-on is added to repository and you will receive a confirmation e-mail that it is added.

{{tip|To un-subscribe from the mailinglist follow the same link as [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] and there's the option to unsubscribe at the bottom}}

==== How to submit your add-on and subsequent updates ====

In order to submit your addon, you must send a request that we add or update your add-on to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] (We call this a "pull request."). Each request will require a version bump in the [[addon.xml]]. We ask that you also keep a [[Add-on structure#changelog.txt|changelog.txt]] up to date so that users may easily see what has changed.

Note that .xbt files will be generated automatically for skins so you do not include this in your pull request.

There are several ways to request that we add or update your add-on. Please preface threads using the following conventions:

{| class="prettytable" border="1"
! Type !! Description
|-
| [Git Pull]|| Submit a request that we pull from your repo. This should include a url, branch/tag/revision, and the addon to pull. HEAD is NOT a revision.
|-
| [SVN Pull]|| Same as [Git Pull]
|-
| [Zip Pull]|| By far the least used but still a valid way. Submit a link where the add-on zip can be downloaded from.
For example you can just give us the link to .zip in your dropbox account. We do not want to download it from a public download site that holds questionable content or is filled with ads.
|-
| [Patch]|| Sometimes you may wish to submit a patch to the author for review.
Under most circumstances we will not merge this directly, it should go to the upstream maintainer first.
|}

After you have send it to the mailing list please keep an eye out for any reply from our repository maintainers if there are any remarks or changes needed or a simple confirmation it has been added. Do note it might take some time to process the request.

After it has been added or updated it will be available from the Kodi repository in Kodi itself, on http://addons.kodi.tv/ and on the wiki page http://kodi.wiki/index.php?title=Category:All_add-ons.

{{Note|Please locate you add-on in the root of the git repository. This to make sure we can easily pull the add-on into our repository.
Example: https://github.com/XBMC-Addons/service.xbmc.versioncheck}}

==== Example e-mail ====

Subject:
[Git Pull] my.cool.plugin
Body:
*addon - my.cool.plugin
*version - 1.1.0
*url - git://some.where.git
*revision - a241345a
*branch - master
*xbmc version - helix

{{Note|If you want to request multiple add-ons to be added you can just do this in one e-mail as long as you provide the "Body" part each time for every add-on and every Kodi version you want it to be included to. In this case the subject field doesn't need to contain the add-on name. Do provide the "[Git Pull]" part at least.}}

{{tip|At this moment Frodo/Gotham/Helix combine all repos into one single repo list in Kodi. You only need to do a request for the minimum repo your add-on supports.}}

[[Category:Add-on development]]

Official add-on repository

2016-03-19T11:24:15Z

Martijn: /* kodi.tv / Kodi Add-ons */

{{mininav|[[Development]]|[[Add-on development]]}}
<br />
Kodi includes an interface to browse remote [http://en.wikipedia.org/wiki/Software_repository repositories] from where add-ons can be retrieved. The model is similar to the way many current [http://en.wikipedia.org/wiki/Linux Linux] [http://en.wikipedia.org/wiki/Linux_distribution distributions] work, whereby there is a main repository that is the default, and additional ones may be added by the user. Kodi has two official repositories that are included by default (''kodi.tv Add-ons'' and ''kodi.tv PVR Add-ons'') and are maintained by the [[Team Kodi|Kodi team]] (''Team Kodi''). This page outlines how to submit your add-on to the official repositories and keep it up to date.<br />

== List of add-ons ==
See:

* http://addons.kodi.tv
* [[:Category:All add-ons]]

== The repositories ==

=== kodi.tv / Kodi Add-ons ===

Browsing add-ons can be done from within Kodi through the built-in [[add-ons]] browser. From here you can install any add-on that is listed in the kodi.tv official repository.
For the time being each version of Kodi will have its own repo which contain only add-ons that are compatible with that specific version of Kodi. Manually installing add-ons is possible but remember to check if these are compatible for your Kodi version.

Kodi uses [http://en.wikipedia.org/wiki/Git_(software) Git] to manage the official repository. See below for the list of git repositories that comprise it.

Read only pull:
git clone https://github.com/xbmc/repo-scripts
git clone https://github.com/xbmc/repo-scrapers
git clone https://github.com/xbmc/repo-scripts
git clone https://github.com/xbmc/repo-skins
git clone https://github.com/xbmc/repo-webinterfaces

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

=== kodi.tv / Kodi PVR Add-ons ===

For more info on PVR see here: [[PVR]]

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

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

== See also ==
* [[Add-ons]]
* [[:Category:All add-ons]]
* [[3rd party add-on repositories]]
'''Development:'''
* [[Add-on development]]
* [[Python development]]
* [[Skinning]]
* [[Add-on repositories]]

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

Video management

2016-02-20T19:04:57Z

Martijn: /* Video guides */

{{Video setup quick links}}
{{mininav|[[Video library]]}}
<section begin="intro" />To use your video files with "metadata" like summaries, cast info, DVD covers, thumbnails, and more, you need to '''[[Adding videos to the library|add those video files]]''' to the [[video library]].<section end="intro" />

See '''[[Adding videos to the library]]''' for just the basic topics on adding videos.

== Preparing files ==
To use your video files with "metadata" like summaries, cast info, DVD covers, thumbnails, and more, you need to add those video files to the video library.

<section begin="intro" />There are a couple of important parts to getting things imported into your {{Kodi}} library. First, the metadata for the video file should exist someplace (the metadata are things like the title of the show, the plot description, the season and episode number if the video file happens to be an episode of a TV series, the actors, the director, cover art and episode art, etc.) The second part is naming the video files so the file gets matched up with the metadata available online.
<section end="intro" />

<section begin="prep" />
{{Kodi}} uses plugins called scrapers to pull information from a video file and coordinate it with a source of metadata available someplace on the internet. For a TV show the scraper basically looks for the show name, season number, and episode number. The default scrapers look at TheTVDB.com (for TV shows) and TheMovieDB.org (for Movies).

If some video file is not scraping properly, the first step is to go to the website of the scraper you are using on that source and see if the video is already listed there. If you can't find an entry on one of those two sites for the video you're interested in, you can hunt for different scrapers which search other websites for metadata (and go through the same process of making sure your show is listed there, then naming the video files to match). Alternatively, you can create new entries on those sites with some basic information about your show, and then let the scrapers do their work. This is nice, because it means that other people will benefit from your work, and may contribute additional information about the show over time.
Adding info to a site like TheTVDB.org is easy, but make sure you read the site rules before you start adding.

If none of that works, you can create .nfo files for each video by hand so that {{Kodi}} will bypass the normal looking online for information about your show. This is the least attractive option, though. It's a lot of work, and it doesn't benefit anyone else the way creating entries on the metadata sites does.<section end="prep" />

=== Naming files ===
{{main|Naming video files}}
{{#lst:Naming video files|intro}}

* [[Naming video files/Movies]]
* [[Naming video files/TV shows]]
* [[Naming video files/Music videos]]

=== NFO files ===
{{Main|NFO files}}
{{#lst:NFO files|intro}}

== Media sources ==
{{Main|Media sources}}
{{#lst:Media sources|intro}}

=== Adding video sources ===
{{main|Adding video sources}}
{{#lst:Adding video sources|intro}}

== Media stubs ==
{{Main|Media stubs}}
{{#lst:Media stubs|intro}}
{{-}}

== Internet streams ==
{{Main|Internet streams}}
{{#lst:Internet streams|intro}}

== Setting content and scanning ==
{{main|Set content and scan}}
{{#lst:Set content and scan|intro}}

=== Incorrect and missing videos ===
{{Main|Incorrect and missing videos}}
{{#lst:Incorrect and missing videos|intro}}

=== Custom video entries ===
{{Main|Custom video entries}}
{{#lst:Custom video entries|intro}}

=== Updating or removing videos ===
{{Main|Updating or removing videos}}
{{#lst:Updating or removing videos|intro}}

== Grouping media ==

=== File stacking ===
{{Main|File stacking}}
{{#lst:File stacking|intro}}

=== Movie sets ===
{{Main|Movie sets}}
{{#lst:Movie sets|intro}}

=== Video library tags ===
{{Main|Video library tags}}
{{#lst:Video library tags|intro}}

=== How to separate the library (cartoons, documentaries, anime, etc) ===
{{Main|Custom home items}}
{{#lst:Custom home items|intro}}

=== Playlists ===
{{Main|Playlists}}
* {{big|'''[[Basic playlists]] -'''}} {{#lst:Basic playlists|intro}}

* {{big|'''[[Smart playlists]] -'''}} {{#lst:Smart playlists|intro}}

=== Linking movies to TV shows ===
{{#lst:Linking movies to TV shows|movie TV link}}
{{-}}

=== Video nodes ===
{{Main|Video nodes}}
{{#lst:Video nodes|intro}}
{{-}}

== Alternative guides ==
<section begin="Alternative guides" />
* [http://lifehacker.com/5900626/create-a-kickass-seamless-play+everything-media-center-the-complete-guide Lifehacker.com - Create a Kickass, Seamless, Play-Everything Media Center: The Complete Guide]
* [http://tbueter.com/?page_id=324 The Frodo Guide] by Henry Ford
* [http://kordkutters.com/setting-up-your-kodi-movies-and-tv-shows-library/ Beginner Tip: How to add videos to Kodi from a network share] by Nathan Betzen
* [http://www.makeuseof.com/pages/xbmc-full-html Makeuseof.com - How to set up your Kodi Media Center]
* [http://youresuchageek.blogspot.fr/2012/06/xbmc-install-and-config-howto-for-linux.html Kodi Install and Config] HOW-TO for Linux Its for xvba, however apart from drivers the rest is a '''MUST''' read for Linux novices.

=== Video guides ===

{{youtube|V6tk5F3biog}} {{youtube|n1amTX5K2oc}} {{youtube|aAn3rX_Km_Q}} {{youtube|ueqwMbdMVHU}}
<section end="Alternative guides" />

== See also ==
* [[Import-export library]]
* [[Parental controls|Locking video sources / Parental controls]]
* [[Video library settings]]
* [[First time user]]
* [[UPnP]]

{{Helix updated}}

[[Category:Video library]]
[[Category:Manual]]
[[Category:Index]]

Add-on manager

2016-02-20T19:01:08Z

Martijn: /* How to install add-ons from a repository */

{{mininav|[[Settings]]{{l2|[[Add-ons]]}} }}
<section begin="intro" />The ''Add-on manager's'' purpose is to manage the various add-ons to the Kodi application. It can be browsed like any other section and the various installed/uninstalled, enabled/disabled add-ons. In the Add-on manager you can also change the settings for auto update, notifications and foreign filter by bringing up the slide in submenu (press left {{keypress|left}} to show/hide). The Add-on manager is not where you go to run add-ons, but only to install and configure them.<section end="intro" />

Add-ons can also be installed and managed from certain points in the interface, such as under {{highlight|bordered=yes|Videos -> Video add-ons}}. There will be an option to "get add-ons" for those sections, and selecting an add-on and bringing up the context menu ({{keypress|C}} on a keyboard and {{button|menu}} on most remotes) you can select options such as uninstall, update, and settings.

== How to access the Add-on manager ==
From the ''home screen'' for the default Confluence skin, go to {{highlight|bordered=yes|System -> Add-ons}}.

<gallery widths=400px heights=225px>
File:add-ons-accessing-1.png|'''Step 1:''' Select ''System'' on the ''home screen''.
File:add-ons-accessing-2.png|'''Step 2:''' Select ''Add-ons''.
File:Add-ons-accessing-3.png|'''Step 3:''' The ''Add-on manager'', displaying four/five options (explained below).
</gallery>

== Add-on manager options ==

;My add-ons
:All installed add-ons, disabled or not, can be found in "My add-ons". This includes both a per-category listing as well as a single unified list of all installed add-ons.

;Available updates
:When an update to an add-on is available it will show up here. By default, add-ons are set to update automatically, so this should normally be empty unless you have changed your preferences to prevent automatic update installs.

;Install from repository
:allows you to install new add-ons from the installed repositories. ''Kodi.tv add-on repository'' is the official add-on repository that is already included in Kodi, but other add-on repository sources can also be installed. (see [[Unofficial repositories#How to install additional add-on repositories|How to install additional add-on repositories]] for more info)

;Install from ZIP file
:allows the installation of an add-on or repository from a ZIP file, either from the hard drive or LAN.

;Search
:allows you to search add-ons in the installed repositories and your installed add-ons.

;System
:Allows users to see which add-ons are running or used by another add-on. It contains the following sub-categories:
:*'''Dependancies -''' Various module/lib add-ons that are required for other add-ons to run. Previously, many of these add-ons were not listed in the GUI at all, which prevented the ability to use rollback or see change logs.
:*'''Orphaned dependancies -''' Module/lib add-ons that are safe to uninstall as they are no longer needed. For example, some module add-ons might be installed to support a new skin add-on, but are no longer needed if that skin add-on is later uninstalled.
:*'''Running -''' What add-ons are currently running all the time (such as services), which helps find add-ons that might be causing slow-downs. Please note that some add-ons are designed to run all the time, and most shouldn't cause any issue.

=== Lefthand sidebar menu ===
[[File:add-on manager sidebar menu.png|500px|right]]
----
{{center|'''View options'''}}
;View
: The view mode that items are displayed as. Similar to other areas of the interface, such as the video and audio libraries. Common view modes include lists, icons, and variations on those.

;Sort by
: This is normally used in other areas of Kodi for video and audio listings to sort things in different orders based on date and such. For the add-on manager the only option is to list by "Name".

;Sort
: Changes the alphabetical name sort order between "A to Z" and "Z to A".
----
{{center|'''Misc options'''}}
<section begin="update options" />
;Auto updates
: Choose how updates are handled. Options are as follows:
:* '''On -''' At least once a day, add-ons that are listed in a repo will automatically be updated if an update is available. If the '''"Notifications"''' option is also enabled, then the user will receive an on-screen notification about the available update and install.
:* '''Notify -''' The same as above, but the update itself will not automatically install. The user will get a notification of available updates, and an "Available updates" folder will appear in the add-on manager list, allowing the user to manually apply updates either for all add-ons or per-add-on.
:* '''Never -''' Kodi will not check for updates nor will it install any known pending updates. The user will also not get any notifications, because Kodi won't know about any pending updates.

;Notifications
: If '''"On"''' or '''"Notify"''' are selected for "Auto updates", then selecting this will also show a notification in the Kodi GUI if add-on updates are found.
<section end="update options" />
;Hide foreign
:This can be used to filter out all add-ons that are not listed (by their creators) as providing content in the language selected under {{highlight|bordered=yes|[[Settings/Appearance#International|Settings -> Appearance -> International -> Language]] }}. This option will only be available when viewing a list of add-ons to install from a repository.

;Hide incompatible
:This filters out any add-on marked as broken or unable to install (incompatible, missing a dependent add-on or that add-on is broken, etc). This option will only be available when viewing a list of add-ons to install from a repository.

;Check for updates
:Kodi automatically checks for add-on updates by looking up add-on repositories online at least once a day. If you want to check for updates more often or have manually disabled automatic update checks, you can use this option to check for updates at that very moment.

;Last updated
: Shows when Kodi last connected to the internet to check add-on repositories for updates.

{{-}}

== How to install add-ons from a repository ==
<section begin="HOW-TO install" />
For this example a skin is being installed, the same method is used for other add-ons.
;{{highlight| Select ''Install from repository'' -> Select the repository {{small|(if only one repository is installed, then you will automatically go into that repo)}} -> Select the add-on category -> Select the add-on -> Select ''Install''|bordered=yes}}
<gallery widths=500px heights=313px>
File:Installaddon1.png|'''Step 1:''' Select ''Install from repository''
File:Installaddon2.png|'''Step 2:''' Select the repository you want to install from. If you haven't added any additional repos and are only using the default Kodi.tv add-on repo, then you will automatically be placed in this folder.
File:Installaddon3a.png|'''Step 3''' Select the add-on category, in this case ''Look and feel'' (applies to Kodi Jarvis and up only).
File:Installaddon3b.png|'''Step 4:''' Select the add-on sub-category, in this case ''Skin''.
File:Installaddon4.png|'''Step 5:''' Select the add-on you want to install, in this case the skin ''Ace''.
File:Installaddon5.png|'''Step 6:''' A summary dialog will be brought up allowing you to see various properties of the add-on. Select ''Install'' to begin automatic downloading and installation.
File:Installaddon6.png|'''Step 7:''' In the case of skin installation you'll be asked if you want to change to the installed skin immediately.
</gallery>
When the add-on has finished downloading Kodi will enable it and depending on the add-on ask if you want to start using it. Add-ons will then appear in their appropriate section (e.g. skins in the appearance section of settings, movie scrapers in the options of scrapers when adding a new movie source)

{{youtube|y2z1moatN4E}}

<section end="HOW-TO install" />

== How to install from a ZIP file ==
<section begin="HOW-TO zip" />
In this example the ''hybrid'' repository is being installed, but the method is the same for add-ons. First download the ZIP file, then:

{{highlight|bordered=yes|Settings → Add-ons → Install from zip file -> Navigate to the ZIP file}}

<gallery widths=500px heights=313px>
File:installing-repo-1.png|'''Step 1:''' Select ''Install from zip file''.
File:installing-repo-2.png|'''Step 2:''' Navigate to the ZIP file and select it.
File:installing-repo-3.png|'''Step 3:''' In the bottom right, Kodi notifies when the add-on is installed and enabled.
File:installing-repo-4.png|'''Step 4:''' Select ''Install from repository''. The new repository is listed. In the case of add-ons they are added under ''All Add-ons'' in the appropriate category.
</gallery>
<section end="HOW-TO zip" />

== Repositories ==

Repositories are storage locations from where add-ons can be retrieved from. They allow the user to browse for more add-ons of all types, as well as allowing Kodi to check them for updates to add-ons, so they don't have to be manually installed. Kodi comes with one official add-on repositories installed by default, ''Kodi.tv add-on repository''. However others can be added.

To install a new repository you must first find the ZIP file to install the repository, a list of [[3rd party add-on repositories]] is semi-maintained on the wiki - other repositories may exist. Then follow the instructions at [[Add-ons#How to install from a ZIP file|How to install from a ZIP file]].

== Updating ==
[[File:Add-on_manager-update.png|500px|right|thumb|Slide in submenu, with Add-on manager settings. {{editor note|needs updated screenshot}}]]
[[File:Installing-repo-3.png|500px|right|thumb|A notification that an add-on has been installed and enabled.{{editor note|needs updated screenshot}}]]
To manually update add-ons or change update settings, from the ''home screen'' go to the add-on manager and bring up the lefthand sidebar menu.

By default ''Auto update'' is enabled and all installed add-ons will be automatically updated when new versions are available from the repositories.

If you want to enable/disable auto-updates, while in the add-on manager bring up the slide in submenu (press right {{keypress|right}} to show/hide) and enable/disable ''Auto update''. You can still select to be notified of updates being available, allowing you to choose to apply the updates or not on a per-add-on basis, or not check for updates at all.

If ''auto update'' is turned ''off'' you should see a folder in the add-on manager that says ''Available updates'', where you can go in and one-by-one and update add-ons.

Installing an ''add-on'' from a ZIP file can lead to it not having a repository associated with it. Automatic or manual (using ''Available Updates'' folder) update will then not be available. You can of course manually update the add-on by downloading a ZIP file with the new version. If you later install the associated repository the add-on will be able to get automatically or manually updated.

=== Update options ===
Full update options are seen in the '''[[#Lefthand sidebar menu|Lefthand sidebar menu]]''':

{{#lst:add-on manager|update options}}

=== Notifications ===
Update/install ''notifications'', which can be toggled on/off in the submenu, will show up in the right bottom corner and will notify you that:
* a new version of an add-on is available, if you have ''Auto update'' '''disabled'''.
* an add-on has been updated, if you have ''Auto update'' '''enabled'''.
* an add-on has been enabled (only when installing a new add-on or when doing rollbacks).
* an installation has failed.

{{note|Notification windows only show up for a few seconds and then disappear.}}
{{-}}

== Rollback ==
Rollback is a function to reinstall a previous version of an add-on. The reason to do this can be that you don't like the new version (e.g changed features) or that the new version introduced a bug.

Rollback is ''only'' available if you've had a previous version installed before getting the add-on manually or automatically updated. I.e. if you install a new add-on only the latest version will be installed, thus you can't rollback to any other version.

If you rollback from version B to A and version C is added to its repository the add-on will automatically get updated (if you have ''Auto update'' enabled) to version C and you'll have to rollback again to version A. To stop this from happening disable ''Auto update'' or uninstall the associated repository. The latter is not always practical or even possible, e.g. the official repositories.

To do a rollback, from the ''home screen'' go to the Add-on manager
;<big>{{highlight|bordered=yes|System -> Add-ons}}</big><br />
then
;<big>{{highlight|bordered=yes|Select ''Enabled Add-ons'' -> Select the category -> Select the add-on -> Select ''Rollback'' -> Select a previous version to reinstall }}</big>

<gallery widths=500px heights=313px>
File:Rollback1a.png|'''Step 1:''' Select ''Enabled Add-ons''.
File:Rollback1b.png|'''Step 2:''' Select the category.
File:rollback1.png|'''Step 3:''' Select the add-on.
File:rollback3.png|'''Step 4:''' Select ''Rollback''.
File:rollback4.png|'''Step 5:''' Select a previous version to reinstall.
</gallery>

== See also ==
* [[:Category:All add-ons]]
* [[3rd party add-on repositories]]
'''Development:'''
* [[Add-on development]]
* [[Python development]]
* [[Skinning]]
* [[Add-on repositories]]
* [[Official add-on repository]]

{{Isengard updated}}

[[Category:Add-ons]]
[[Category:Settings]]
[[Category:Manual]]

HOW-TO:Install Kodi for Windows

2016-02-20T18:57:49Z

Martijn:

{{mininav| [[Windows]] }}

{{Kodi migration note}}

== Installing of {{kodi}} for Windows ==

The installation of {{kodi}} for Windows is straightforward like most other Windows applications.

Download the latest version from [http://kodi.tv/download/ http://kodi.tv/download/]. After download open the .exe file after which you will get the installation dialog. Simply follow the shown installation screen after which the installation will begin. For most users the offered default settings are sufficient, if not, change them accordingly if you are sure you have to.

{{youtube|pfV9Z691n40}}

If you have [https://chocolatey.org/ Chocolatey] installed you can run <pre>cinst xbmc</pre> from an elevated command line or powershell instance.

After the installation you can immediately start using Kodi. To start Kodi, find it under the Windows '''Start''' button in a '''Program Group''' called '''Kodi'''. or simply use the desktop icon.

You can use the keyboard, mouse or remote control to navigate through the program. Add one or more sources in Videos, Music and/or Photos, see [[Media Sources]] and you are ready to play your media. For more information you can visit the main [[Main Page|wiki page]].

== Uninstalling of {{kodi}} for Windows ==
Go to "''Add or Remove Programs''" in the "''Control Panel''" under Windows then choose to remove "''{{kodi}}''". You can also find it under the Windows '''Start''' button in a '''Program Group''' called '''Kodi'''.

== Upgrading {{kodi}} for Windows ==
Unless your copy of {{kodi}} is more than two years old, simply installing a newer version of {{kodi}} over an older version should cause no problems. If you are upgrading your copy of {{kodi}}, it is ALWAYS recommended that you backup your data: [[Backup]].

{{youtube|V0eLSeuN0Gs}}

{{Helix updated}}

[[Category:Manual]]
[[Category:Installation|Windows]]
[[Category:Windows]]
[[Category:How-to]]

Official:Forum rules/Banned add-ons

2016-02-16T21:02:43Z

Martijn: /* Add-on blacklist */

{{mininav| [[Forum rules]] }}

This is an example list of repositories and add-ons that have been identified as violating the {{kodi}} '''[[forum rules]]'''. This means they have been banned from any official {{kodi}} forums, websites, IRC channels and any social media accounts that are under the control of [[Team Kodi]] or the [[XBMC Foundation]].

'''This list is only an example, and does not include all add-ons or services that violate the [[forum rules#Piracy Policy|forum rules]].'''

While Team Kodi does not regulate what users install or use, we ask that you do not come to any of the official {{kodi}} websites for support on these repos/add-ons. Failure to do so may result in a ban.

== How do I tell if something is allowed or not==
{{collapse top|click "Expand" to view the rules on piracy/bootleg video content -->}}
{{main|forum rules}}
{{#lst:Official:Forum rules|piracy policy}}
{{collapse bottom}}

The basic rule of thumb for what is not allowed, is that if the Add-on is offering something for free that you would normally expect to pay for by any other means, then it'll most likely be using pirate feeds.

If the Add-on simply allows access to web feeds from the rights holders then discussion of these is normally allowed, in this case there generally will be a website equivalent of the service, for example Youtube, BBC iPlayer, Netflix.

'''Note -''' If the Add-on is from our Official Add-on Repo then it has already been checked that it doesn't break our rules, therefore anything contained in the Official Repo is safe to discuss in any of our websites/channels.

== Repository blacklist ==
* Aftershock
* Fusion
* J1nx
* Kinkin
* Lambda
* Metal Kettle
* Mobie
* Mucky Duck
* MTLFREETV (Montreal Free TV)
* SuperRepo
* Total Installer
* TOTALXBMC
* TVADDONS
* Unity
* WikiXBMC
* Wookie
* XBMCHUB
* Xfinity (not to be confused with the TV service from Comcast Cable)
* Xunity / XunityTalk (Xunity Talk)

== Add-on blacklist ==
* 123Movies
* 1Channel
* 4K UHD
* Adryanlist
* Aftershock
* All Movies Stream
* Amigos
* Animeram
* Ares / Ares Wizard
* BaddAssMovies4U
* BBTS
* Beast
* Binky TV
* CartoonHD
* Cartoons8
* cCloud TV
* Cloudword
* Community Portal (The Community Portal)
* Daffys
* DexterTV
* Diesel
* DOCU-HUB
* Eliplex TV
* Entertainment Hub
* Exodus
* F.T.V.
* Film Dictator
* Free Streams
* HUB/TVADDONS/Xfinity Config Wizard
* HUB/TVADDONS/Xfinity 'fresh start'
* Genesis
* GoMovies
* GoTV
* Halow
* i4atv
* I Watch Online
* IceFilms
* Indian TV (OTT)
* IPTV Stalker (not to be confused with Stalker Middleware)
* IPTV Simple Client 2 (not to be confused with the original and official "IPTV Simple Client")
* iStream
* iVue TV
* iwannawatch
* J1nxPack (Jinx/J1nx Pack)
* Jango Music
* Jeckyll Hyde
* Kidsflix
* Kiss Anime
* Kodiland
* KodiUK TV Wizard
* LatestDude
* Marvin
* MashUp
* Mega Search
* MK Sports
* Modbro Video
* MoneySports
* Movie Hut
* Movie Night
* Movie25
* Movie4k
* MoviesHD
* Movies XK
* MovieStorm
* MuchMovies
* Mutts Nuts
* Navi-X
* Nemesis
* NLView
* OCW Reborn
* OneClickMoviez
* Online Movies Pro
* Operation Robocop
* Ororo TV (ororo.tv)
* Plexus
* Phoenix
* Popcorn Time
* Prime Links
* Primewire
* Project Cypher
* ProjectFreeTV (Project Free TV)
* RapidBit
* Renegades TV
* Rlseries
* RobinHood Project
* Royal We (The Royal We)
* SALTS (S.A.L.T.S. - Stream all the Sources)
* Soap Catchup
* Stallion
* SpinzTV
* SportsAccess
* Sport-A-Holic
* SportsDevil
* StreamStorm TV
* StreamThis.tv
* SuperStreams
* SuperTV
* TARDIS
* TeeVee
* The Beast
* T-Killa
* ToonMania
* TVOnline
* UK Turk Playlists
* UK TV Now
* Wookie Wizard
* Vdubt25
* VortechTV
* Xfinity Installer
* XMovies8
* Yify Movies
* Zem TV
* Zeta TV
* Zeus
...and most other config wizards / maintenance wizards / addon installers / community builds.

==So where do I get support?==

Every Add-on should contain the authors name, this found by opening the Context menu on the Add-on and selecting '''Add-on Information'''

[[File:add-on-context.JPG|400px]]

[[File:add-on-info.JPG|400px]]

Generally a search of the Add-on's name together with the author name will give the location of where the author is active.

For example a search term might be:

'''Kodi TheCollective Youtube'''

__NOINDEX__
[[Category:Forum]]

Addon.xml

2016-02-13T16:19:51Z

Martijn: /* Dependency versions */

{{mininav|[[Development]]|[[Add-on development]]}}
<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.

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

<syntaxhighlight lang="xml" enclose="div">
<?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.1.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></language>
<platform>all</platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

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

* The <code><addon></code> element must be present, and be the root node. It presents data about the add-on package as a whole.
* 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.
* Then there are one or more <code><extension></code> elements, each of which describes a part of Kodi that the add-on extends.
* Finally, there is a specific <code><extension></code> element that extends <code>"xbmc.addon.metadata"</code>. This describes the add-on to the user.

= Elements =

== <addon> ==

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:

<source lang="xml">
<addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2">
</source>

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

==== How versioning works ====

* <code>2.2.9</code> is newer than <code>2.2.1</code>
* <code>2.2.10</code> is newer than <code>2.2.1</code>
* <code>2.3.0</code> is newer than <code>2.2.9</code>
* <code>2.2.1</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1</code> is newer than <code>2.2.1~beta</code>
* <code>2.2.1~beta</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1~beta3</code> is newer than <code>2.2.1~beta2</code>
* <code>2.2.1~beta10</code> is newer than <code>2.2.1~beta1</code>

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

== <requires> ==

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.

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 <code><requires></code> block that imports two required modules:

<source lang="xml">
<requires>
<import addon="xbmc.python" version="2.14.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10"/>
</requires>
</source>

Here's another example, which will only install on OpenELEC:

<source lang="xml">
<requires>
<import addon="os.openelec.tv" version="2.0"/>
</requires>
</source>

== <import> ==

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

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.

=== addon attribute ===

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

=== version attribute ===

The <code>version</code> 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 <code>xbmc.*</code> add-on dependencies to control on which version of Kodi the add-on can be installed.

{| class="prettytable" border="1"
|+ Current versions
! Kodi version !! xbmc.python !! xbmc.gui !! xbmc.json !! xbmc.metadata !! xbmc.addon
|-
| Dharma 10.1 <font color="red">Deprecated</font>|| 1.0 || 2.11 || 2.0|| 1.0 || 0.1
|-
| Eden 11.0 <font color="red">Deprecated</font> || 2.0 || 3.0 || 4.0 || 1.0 || 11.0
|-
| Frodo 12.x <font color="red">Deprecated</font>|| 2.1.0 || 4.0.0 || 6.0.0 || 2.1.0 || 12.0.0
|-
| Gotham 13.x || 2.14.0 (ABI 2.1.0) || 5.0.1 || 6.6.0 (ABI 6.0.0) || 2.1.0 || 13.0.0 (ABI 12.0.0)
|-
| Helix 14.x || 2.19.0 (ABI 2.1.0) || 5.3.0 || 6.20.0 (ABI 6.0.0) || 2.1.0 || 14.0.0 (ABI 12.0.0)
|-
| 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 || 15.0.0 (ABI 12.0.0)
|-
| Jarvis 16.x || 2.24.0 (ABI 2.1.0) || 5.10.0 || 6.32.4 (ABI 6.0.0) || 2.1.0 || 16.0.0 (ABI 12.0.0)
|-
| Krypton 17.x || 2.25.0 (ABI 2.1.0) || 5.11.0 || 6.32.4 (ABI 6.0.0) || 2.1.0 || 17.0.0 (ABI 12.0.0)
|}

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

=== optional attribute ===

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.

== <extension> ==

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.

The various extension points that Kodi provides are given in the list below.
{| class="prettytable"
!Extension point
!Add-on Category
|-
|<code>[[Skinning|xbmc.gui.skin]]</code>
|Skin
|-
|<code>xbmc.webinterface</code>
|Web interface
|-
|<code>[[Add-on repositories|xbmc.addon.repository]]</code>
|''None''
|-
|<code>[[HOW-TO:_Automatically_start_addons_using_services|xbmc.service]]</code>
|Services
|-
|<code>xbmc.metadata.scraper.albums</code>
|Album information
|-
|<code>xbmc.metadata.scraper.artists</code>
|Artist information
|-
|<code>xbmc.metadata.scraper.movies</code>
|Movie information
|-
|<code>xbmc.metadata.scraper.musicvideos</code>
|Music video information
|-
|<code>xbmc.metadata.scraper.tvshows</code>
|TV information
|-
|<code>xbmc.metadata.scraper.library</code>
|''None''
|-
|<code>xbmc.ui.screensaver</code>
|Screensaver
|-
|<code>xbmc.player.musicviz</code>
|Visualization
|-
|<code>[[Plugin sources#What Kodi requires for your add-on|xbmc.python.pluginsource]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>[[Script sources#What Kodi requires for your add-on|xbmc.python.script]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>xbmc.python.weather</code>
|Weather
|-
|<code>xbmc.subtitle.module</code>
|Subtitle service module
|-
|<code>[[Script lyrics#What Kodi requires for your add-on|xbmc.python.lyrics]]</code>
|Lyrics
|-
|<code>[[Script library#What Kodi requires for your add-on|xbmc.python.library]]</code>
|''None''
|-
|<code>xbmc.python.module</code>
|These don't show up in the addon browser and are purely as support for other scripts.
|-
|<code>xbmc.addon.video</code>
|Video Add-ons (video)
|-
|<code>xbmc.addon.audio</code>
|Music Add-ons (audio)
|-
|<code>xbmc.addon.image</code>
|Picture Add-ons (image)
|-
|<code>kodi.resource.images</code>
|Additional image files
|-
|<code>kodi.resource.language</code>
|Additional language files
|}

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 ===
{{See also|Plugin sources}}

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

==== library attribute ====

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.

==== <provides> element ====

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:

{| class="prettytable"
!Provides
!Appears in
|-
|<code>image</code>
|Pictures
|-
|<code>audio</code>
|Music
|-
|<code>video</code>
|Video
|-
|<code>executable</code>
|Programs
|-
|''(blank)''
|Not visible
|}

==== Example ====

<source lang="xml">
<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py">
<provides>audio video</provides>
</extension>
</source>

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

==== Required elements ====

There are several elements that this should contain and all are compulsory (except the broken tag). Each of the elements below 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. See the [[List of language codes (ISO-639:1988)]] for possible language strings. If there's no <code>lang</code> attribute for a translatable element, it defaults to English. However, even for English, adding the <code>lang</code> attribute is recommended.

===== <summary> =====

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.

<source lang="xml">
<summary lang="en">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

From Kodi v15 Isengard we recommend you use

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

===== <description> =====

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.

<source lang="xml">
<description lang="en">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>
</source>

From Kodi v15 Isengard we recommend you use

<source lang="xml">
<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>
</source>

===== <disclaimer> =====

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.

<source lang="xml">
<disclaimer lang="en">Feel free to use this script. For information visit the wiki.</disclaimer>
</source>

From Kodi v15 Isengard we recommend you use

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

===== <platform> =====

The <code><platform></code> tag specifies which platforms (operating systems, hardware) 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:

* <code>all</code>
* <code>linux</code>
* <code>osx</code>
* <code>osx64</code>
* <code>osx32</code>
* <code>ios</code>
* <code>windx</code>
* <code>android</code>

<source lang="xml">
<platform>all</platform>
</source>

===== <language> =====

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, leave it blank.

<source lang="xml">
<language>en de fr</language>
or
<language></language>
</source>

===== <license> =====

The <code><license></code> element indicates what license is used for this add-on.

<source lang="xml">
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
</source>

===== <forum> =====

The <code><forum></code> element provides the forum thread URL for this specific add-on. Leave this blank if there is no forum thread.
<source lang="xml">
<forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum>
</source>

===== <website> =====

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

<source lang="xml">
<website>http://www.myaddonwebsite.com/</website>
</source>

===== <nowiki><source></nowiki> =====

The <code><nowiki><source></nowiki></code> element provides the URL for the source code for this specific add-on.
<syntaxhighlight lang="xml" enclose="div">
<source>http://github.com/someone/myaddon</source>
</syntaxhighlight>

===== <email> =====

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.
<source lang="xml">
<email>foo@bar.com</email>
or
<email>foo at bar dot com</email>
</source>

===== <broken> =====

The <code><broken></code> tag will mark the add-on as broken in the Kodi repo and provide the reason why. You don't need to do a version bump for this to work. However a bump is recommended as you could also add this to the changelog.

<source lang="xml">
<broken>deprecated</broken>
</source>

== Skin specific elements ==
=== Overview ===
{| class="prettytable"
| '''effectslowdown'''
| 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.
|-
| '''debugging'''
| When set to true, it'll display onscreen debug information (xml filename, mouse position and focused control type and name) in the skin.
|-
| '''res'''
| Support for arbitrary skin resolutions.
|}

=== How window xml files are found ===

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.

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

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

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

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.

= Examples =

== addon.xml for skins ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<addon
id="skin.confluence"
version="2.1.3"
name="Confluence"
provider-name="Jezz_X, Team Kodi">
<requires>
<import addon="xbmc.gui" version="4.0.0"/>
</requires>
<extension
point="xbmc.gui.skin"
debugging="false"
effectslowdown="0.75">
<res width="1280" height="720" aspect="16:9" default="true" folder="720p" />
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Confluence skin by Jezz_X. (Kodi's default skin)</summary>
<description lang="en">Confluence is the default skin for Kodi 9.11 and above. It is a combination of concepts from many popular skins, and attempts to embrace and integrate their good ideas into a skin that should be easy for first time Kodi users to understand and use.</description>
<disclaimer lang="en">Confluence is the default skin for Kodi, removing it may cause issues</disclaimer>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>
One thing to note is that <font color="red">all tag names are lower case.</font> XML tag names are case sensitive!

== addon.xml for scripts ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon
id="script.artwork.downloader"
name="Artwork Downloader"
version="12.0.12"
provider-name="Martijn">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
<import addon="xbmc.json" version="6.0.0"/>
<import addon="xbmc.addon" version="12.0.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10" optional="true"/>
<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.service" library="service.py" start="login"/>
<extension point="xbmc.addon.metadata">
<summary lang="en">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary>
<description lang="en">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">For bugs, requests or general questions visit the Artwork Downloader thread on the Kodi forum.</disclaimer>
<language></language>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

= Schema Definition =

The XML schema definition for <code>addon.xml</code> is located [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.addon/metadata.xsd here].

{{frodo updated}}

[[Category:Add-on development]]
[[Category:Skin development]]

Submitting Add-ons

2016-02-13T16:17:24Z

Martijn: /* Allowed submissions */

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

=== Submitting a Compliant Add-on to the Kodi.tv Repo ===

After you have read the [[Add-on rules|repository guidelines]] and made sure your addon is compliant with them, you may begin the submission process using the following steps.

=== Allowed submissions ===

We have restricted the allowed submissions of add-ons to past Kodi versions.
Several reasons:
* Kodi code improvements
* Reduce support load for add-on developers
* Reduce workload for repository maintainers

Below is a table of on which submissions are allowed to official Kodi repository.

{| class="prettytable" border="1"
|+ Allowed add-on submissions
! codename !! version !! update !! new
|-
| Dharma || 10.x || no || no
|-
| Eden || 11.x || no || no
|-
| Frodo || 12.x || no || no
|-
| Gotham || 13.x || yes || no
|-
| Helix || 14.x || yes || no
|-
| Isengard || 15.x || yes || yes
|-
| Jarvis || 16.x || yes || yes
|-
| Krypton || 17.x || yes || yes
|}

Additional feature is that we now use combined repositories. So if your add-on is Gotham/Helix compatible, you only need to send it to Gotham repository.
If it's only Helix compatible you need to send it to Helix repository.
This of course requires that the minimal Kodi dependencies are set accordingly.

{| class="prettytable" border="1"
|+ Which repos are used
! codename !! version !! repo
|-
| Dharma || 10.x || Dharma
|-
| Eden || 11.x || Eden
|-
| Frodo || 12.x || Frodo
|-
| Gotham || 13.x || Gotham
|-
| Helix || 14.x || Gotham || Helix
|-
| Isengard || 15.x || Gotham || Helix || Isengard
|-
| Jarvis || 16.x || Gotham || Helix || Isengard || Jarvis
|-
| Krypton || 17.x || Gotham || Helix || Isengard || Jarvis || Krypton
|}

{{see also|Addon.xml#Dependency_versions}}

=== The mailing list ===
We ask that all Add-on authors subscribe to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List].
This is done for several reasons.
:* This is where all updates and important information will be announced.
:* This way we can contact you regarding your add-ons if necessary.
:* You can see what other devs are requesting to be added so you know if possibly you need to check compatibility of the add-on you depend on.
:* You may find new and interesting add-ons this way on which you can get inspiration from or may depend on.

After you have subscribed to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] you will be send a conformation e-mail. Be sure to accept this before you can submit to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Mailing List].

All pull requests should be sent to this list so that repository maintainers will be notified that you want to add of update your add-on. They will do a sanity check if all seems ok and you are following the Kodi guidelines for add-ons. If any issues or questions arise they will contact you through the e-mail you registered with.
Once all checks out fine your add-on is added to repository and you will receive a confirmation e-mail that it is added.

{{tip|To un-subscribe from the mailinglist follow the same link as [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] and there's the option to unsubscribe at the bottom}}

==== How to submit your add-on and subsequent updates ====

In order to submit your addon, you must send a request that we add or update your add-on to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] (We call this a "pull request."). Each request will require a version bump in the [[addon.xml]]. We ask that you also keep a [[Add-on structure#changelog.txt|changelog.txt]] up to date so that users may easily see what has changed.

Note that .xbt files will be generated automatically for skins so you do not include this in your pull request.

There are several ways to request that we add or update your add-on. Please preface threads using the following conventions:

{| class="prettytable" border="1"
! Type !! Description
|-
| [Git Pull]|| Submit a request that we pull from your repo. This should include a url, branch/tag/revision, and the addon to pull. HEAD is NOT a revision.
|-
| [SVN Pull]|| Same as [Git Pull]
|-
| [Zip Pull]|| By far the least used but still a valid way. Submit a link where the add-on zip can be downloaded from.
For example you can just give us the link to .zip in your dropbox account. We do not want to download it from a public download site that holds questionable content or is filled with ads.
|-
| [Patch]|| Sometimes you may wish to submit a patch to the author for review.
Under most circumstances we will not merge this directly, it should go to the upstream maintainer first.
|}

After you have send it to the mailing list please keep an eye out for any reply from our repository maintainers if there are any remarks or changes needed or a simple confirmation it has been added. Do note it might take some time to process the request.

After it has been added or updated it will be available from the Kodi repository in Kodi itself, on http://addons.kodi.tv/ and on the wiki page http://kodi.wiki/index.php?title=Category:All_add-ons.

{{Note|Please locate you add-on in the root of the git repository. This to make sure we can easily pull the add-on into our repository.
Example: https://github.com/XBMC-Addons/service.xbmc.versioncheck}}

==== Example e-mail ====

Subject:
[Git Pull] my.cool.plugin
Body:
*addon - my.cool.plugin
*version - 1.1.0
*url - git://some.where.git
*revision - a241345a
*branch - master
*xbmc version - helix

{{Note|If you want to request multiple add-ons to be added you can just do this in one e-mail as long as you provide the "Body" part each time for every add-on and every Kodi version you want it to be included to. In this case the subject field doesn't need to contain the add-on name. Do provide the "[Git Pull]" part at least.}}

{{tip|At this moment Frodo/Gotham/Helix combine all repos into one single repo list in Kodi. You only need to do a request for the minimum repo your add-on supports.}}

=== Github ===

Alternatively, add-on updates may be submitted directly to the [[Official add-on repository]] on Github as pull requests. In addition to the [[Add-on rules|repository guidelines]] the following rules apply when submitting PRs on Github:

* PR should contain one commit only.
* Commit message should have the format "[addonid] version". Example: "[my.cool.addon] 1.0.1"

As with mailing list, only PRs from add-on author will be accepted. Patches should be submitted upstream. For an easy way to create PR from your own git repository, see [[HOW-TO: create add-on PRs using Git Subtree Merging]].

[[Category:Add-on development]]

Official:Sponsorship

2016-02-04T18:58:10Z

Martijn: /* Sponsorship Levels */

{{mininav|[[XBMC Foundation]]}}

== Sponsorship ==

XBMC is a fairly expensive operation to maintain, and as such, we are always happy to welcome new sponsors to the fold, as additional sponsorships tend to make it easier to further development and spread the word. Donations are used solely for purchasing hardware, to improve and extend XBMC, travel for conferences, operational costs and administrative/legal costs and fees. The "'''XBMC Foundation'''" is the non-profit organization that operates and endorses the [[XBMC Media Center]] project, and is registered in the US. To become a XBMC Foundation sponsor, any organization may simply contact the XBMC Foundation at contact (at) xbmc dot org.

With that said, the [[XBMC Foundation]] remains a non-profit organization, and as such, we would like very much to combine simple financial growth with definite software and community growth. Keeping that in mind, we ask that all potential sponsors answer the following brief questions in their contact email:

1. In a paragraph, could you tell us a bit about your organization?
2. Why would you like to become an XBMC Foundation sponsor?
3. What efforts have you made, if any, to advance Open Source Software generally and XBMC specifically?
4. What level of XBMC Sponsorship are you interested in?

== Becoming an XBMC Sponsor ==

Sponsorship can come in many forms.
- Promoting the usage our product by displaying it at conventions
- Providing needed hardware to develop on, expand current possibilities or support new platforms.
- Donating a certain amount of funds to help maintain our current goals.

We also provide the option for companies to become official sponsors (see the sponsors banner on our front page). In addition to the satisfaction of helping the open-source community, sponsors are entitled to some special perks as well. We strongly encourage anyone using XBMC as part of their business model to sponsor us in some way, though you are welcome to keep the details private if you wish.

Please understand that we cannot give legal advice regarding your possible implementation of our software. Multimedia licensing/copyrights/patents are very tricky, please contact a software attorney for help with these questions.

If you would like to discuss these aspects in more depth, please contact us so we can possibly work out any possible details.

Contact us at interest (at) xbmc dot org

== Sponsorship Levels ==
=== DevCon Sponsor ===

Each year, Team XBMC hosts a single Developers Conference sometime in early fall, typically in September. Each year we are happy to accept a single DevCon Sponsor to help defray the costs of the Conference. The DevCon sponsor will have its name included on all DevCon t-shirts, including any DevCon t-shirts the organization determines to sell to the general public. The DevCon sponsor will also have its name included in any Conference banners and the Conference and next Beta 1 blog posts. Finally, the DevCon Sponsor will receive all the perks of being a Diamond Sponsor.

The cost of the DevCon Sponsorship is negotiable.

=== Diamond Sponsor ===

All Diamond Sponsors will be listed alphabetically on the sponsorship page along with their logo, as well as having two links on the front page of the XBMC blog, at least one of which will be above the “fold.” All Diamond Sponsors may refer to themselves as an “XBMC Foundation Sponsor” or simply as an “Kodi Sponsor.” Diamond Sponsors are invited to come speak to the Team at the yearly DevCon at their expense.

A yearly Diamond Sponsorship costs $10,000, a portion of which may be donated as services (particularly services critical to the development or maintenance of Kodi) at the behest of the Foundation Board of Directors.

=== Gold Sponsor ===

All Gold Sponsors will be linked in text on the sponsorship page. All Gold Sponsors may refer to themselves in press as an “XBMC Foundation Sponsor” or simply as an “Kodi Sponsor.” Gold Sponsors are invited to come speak to the Team at the yearly DevCon at their expense.

A yearly Gold Sponsorship costs $2,500, a portion of which may be donated as services at the behest of the Foundation Board of Directors.

== Terms and Conditions ==

The [[XBMC Foundation]] reserves the right to refuse any sponsorship for any reason. No goods or services will be transferred to any sponsor in connection with their donation. Only the mentioned rights mentioned in the [[Sponsorship#Sponsorship_Levels|sponsorship levels]] are granted to the sponsor, unless otherwise agreed in the sponsorship deal, which must approved by the Board of directors. All sponsor must follow our [[rules of conduct]].

== Sponsors ==

The following pages contain the present and past sponsors who have contributed to the [[XBMC Foundation]].

:* [[Sponsorship/Present|Present sponsorships]]

:* [[Sponsorship/Past|Past sponsorships]]

[[Category:XBMC Foundation]]

Addon.xml

2015-12-28T09:22:28Z

Martijn: /* xbmc.addon.metadata */

{{mininav|[[Development]]|[[Add-on development]]}}
<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.

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

<syntaxhighlight lang="xml" enclose="div">
<?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.1.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></language>
<platform>all</platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

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

* The <code><addon></code> element must be present, and be the root node. It presents data about the add-on package as a whole.
* 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.
* Then there are one or more <code><extension></code> elements, each of which describes a part of Kodi that the add-on extends.
* Finally, there is a specific <code><extension></code> element that extends <code>"xbmc.addon.metadata"</code>. This describes the add-on to the user.

= Elements =

== <addon> ==

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:

<source lang="xml">
<addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2">
</source>

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

==== How versioning works ====

* <code>2.2.9</code> is newer than <code>2.2.1</code>
* <code>2.2.10</code> is newer than <code>2.2.1</code>
* <code>2.3.0</code> is newer than <code>2.2.9</code>
* <code>2.2.1</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1</code> is newer than <code>2.2.1~beta</code>
* <code>2.2.1~beta</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1~beta3</code> is newer than <code>2.2.1~beta2</code>
* <code>2.2.1~beta10</code> is newer than <code>2.2.1~beta1</code>

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

== <requires> ==

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.

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 <code><requires></code> block that imports two required modules:

<source lang="xml">
<requires>
<import addon="xbmc.python" version="2.14.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10"/>
</requires>
</source>

Here's another example, which will only install on OpenELEC:

<source lang="xml">
<requires>
<import addon="os.openelec.tv" version="2.0"/>
</requires>
</source>

== <import> ==

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

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.

=== addon attribute ===

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

=== version attribute ===

The <code>version</code> 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 <code>xbmc.*</code> add-on dependencies to control on which version of Kodi the add-on can be installed.

{| class="prettytable" border="1"
|+ Current versions
! Kodi version !! xbmc.python !! xbmc.gui !! xbmc.json !! xbmc.metadata !! xbmc.addon
|-
| Dharma 10.1 <font color="red">Deprecated</font>|| 1.0 || 2.11 || 2.0|| 1.0 || 0.1
|-
| Eden 11.0 <font color="red">Deprecated</font> || 2.0 || 3.0 || 4.0 || 1.0 || 11.0
|-
| Frodo 12.x <font color="red">Deprecated</font>|| 2.1.0 || 4.0.0 || 6.0.0 || 2.1.0 || 12.0.0
|-
| Gotham 13.x || 2.14.0 (ABI 2.1.0) || 5.0.1 || 6.6.0 (ABI 6.0.0) || 2.1.0 || 13.0.0 (ABI 12.0.0)
|-
| Helix 14.x || 2.19.0 (ABI 2.1.0) || 5.3.0 || 6.20.0 (ABI 6.0.0) || 2.1.0 || 14.0.0 (ABI 12.0.0)
|-
| 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 || 15.0.0 (ABI 12.0.0)
|-
| Jarvis 16.x || 2.24.0 (ABI 2.1.0) || 5.10.0 || 6.32.1 (ABI 6.0.0) || 2.1.0 || 16.0.0 (ABI 12.0.0)
|}

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

== <extension> ==

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.

The various extension points that Kodi provides are given in the list below.
{| class="prettytable"
!Extension point
!Add-on Category
|-
|<code>[[Skinning|xbmc.gui.skin]]</code>
|Skin
|-
|<code>xbmc.gui.webinterface</code>
|Web interface
|-
|<code>[[Add-on repositories|xbmc.addon.repository]]</code>
|''None''
|-
|<code>[[HOW-TO:_Automatically_start_addons_using_services|xbmc.service]]</code>
|Services
|-
|<code>xbmc.metadata.scraper.albums</code>
|Album information
|-
|<code>xbmc.metadata.scraper.artists</code>
|Artist information
|-
|<code>xbmc.metadata.scraper.movies</code>
|Movie information
|-
|<code>xbmc.metadata.scraper.musicvideos</code>
|Music video information
|-
|<code>xbmc.metadata.scraper.tvshows</code>
|TV information
|-
|<code>xbmc.metadata.scraper.library</code>
|''None''
|-
|<code>xbmc.ui.screensaver</code>
|Screensaver
|-
|<code>xbmc.player.musicviz</code>
|Visualization
|-
|<code>[[Plugin sources#What Kodi requires for your add-on|xbmc.python.pluginsource]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>[[Script sources#What Kodi requires for your add-on|xbmc.python.script]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>xbmc.python.weather</code>
|Weather
|-{{Gotham row}}
|<code>[[Script Subtitles#What Kodi requires for your add-on|xbmc.python.subtitles]]</code>
|'''([[:Category:Gotham feature|Future Gotham removal]])''' Subtitles
|-{{Gotham row}}
|<code>xbmc.subtitle.module</code>
|'''([[:Category:Gotham feature|Future Gotham addition]])''' Subtitle service module
|-
|<code>[[Script lyrics#What Kodi requires for your add-on|xbmc.python.lyrics]]</code>
|Lyrics
|-
|<code>[[Script library#What Kodi requires for your add-on|xbmc.python.library]]</code>
|''None''
|-
|<code>xbmc.python.module</code>
|These don't show up in the addon browser and are purely as support for other scripts.
|-
|<code>xbmc.addon.video</code>
|Video Add-ons (video)
|-
|<code>xbmc.addon.audio</code>
|Music Add-ons (audio)
|-
|<code>xbmc.addon.image</code>
|Picture Add-ons (image)
|-
|<code>kodi.resource.images</code>
|Additional image files
|-
|<code>kodi.resource.language</code>
|Additional language files
|}

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 ===
{{See also|Plugin sources}}

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

==== library attribute ====

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.

==== <provides> element ====

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:

{| class="prettytable"
!Provides
!Appears in
|-
|<code>image</code>
|Pictures
|-
|<code>audio</code>
|Music
|-
|<code>video</code>
|Video
|-
|<code>executable</code>
|Programs
|-
|''(blank)''
|Not visible
|}

==== Example ====

<source lang="xml">
<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py">
<provides>audio video</provides>
</extension>
</source>

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

==== Required elements ====

There are several elements that this should contain and all are compulsory (except the broken tag). Each of the elements below 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. See the [[List of language codes (ISO-639:1988)]] for possible language strings. If there's no <code>lang</code> attribute for a translatable element, it defaults to English. However, even for English, adding the <code>lang</code> attribute is recommended.

===== <summary> =====

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.

<source lang="xml">
<summary lang="en">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

From Kodi v15 Isengard we recommend you use

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

===== <description> =====

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.

<source lang="xml">
<description lang="en">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>
</source>

From Kodi v15 Isengard we recommend you use

<source lang="xml">
<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>
</source>

===== <disclaimer> =====

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.

<source lang="xml">
<disclaimer lang="en">Feel free to use this script. For information visit the wiki.</disclaimer>
</source>

From Kodi v15 Isengard we recommend you use

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

===== <platform> =====

The <code><platform></code> tag specifies which platforms (operating systems, hardware) 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:

* <code>all</code>
* <code>linux</code>
* <code>osx</code>
* <code>osx64</code>
* <code>osx32</code>
* <code>ios</code>
* <code>windx</code>
* <code>android</code>

<source lang="xml">
<platform>all</platform>
</source>

===== <language> =====

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, leave it blank.

<source lang="xml">
<language>en de fr</language>
or
<language></language>
</source>

===== <license> =====

The <code><license></code> element indicates what license is used for this add-on.

<source lang="xml">
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
</source>

===== <forum> =====

The <code><forum></code> element provides the forum thread URL for this specific add-on. Leave this blank if there is no forum thread.
<source lang="xml">
<forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum>
</source>

===== <website> =====

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

<source lang="xml">
<website>http://www.myaddonwebsite.com/</website>
</source>

===== <nowiki><source></nowiki> =====

The <code><nowiki><source></nowiki></code> element provides the URL for the source code for this specific add-on.
<syntaxhighlight lang="xml" enclose="div">
<source>http://github.com/someone/myaddon</source>
</syntaxhighlight>

===== <email> =====

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.
<source lang="xml">
<email>foo@bar.com</email>
or
<email>foo at bar dot com</email>
</source>

===== <broken> =====

The <code><broken></code> tag will mark the add-on as broken in the Kodi repo and provide the reason why. You don't need to do a version bump for this to work. However a bump is recommended as you could also add this to the changelog.

<source lang="xml">
<broken>deprecated</broken>
</source>

== Skin specific elements ==
=== Overview ===
{| class="prettytable"
| '''effectslowdown'''
| 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.
|-
| '''debugging'''
| When set to true, it'll display onscreen debug information (xml filename, mouse position and focused control type and name) in the skin.
|-
| '''res'''
| Support for arbitrary skin resolutions.
|}

=== How window xml files are found ===

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.

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

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

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

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.

= Examples =

== addon.xml for skins ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<addon
id="skin.confluence"
version="2.1.3"
name="Confluence"
provider-name="Jezz_X, Team Kodi">
<requires>
<import addon="xbmc.gui" version="4.0.0"/>
</requires>
<extension
point="xbmc.gui.skin"
debugging="false"
effectslowdown="0.75">
<res width="1280" height="720" aspect="16:9" default="true" folder="720p" />
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Confluence skin by Jezz_X. (Kodi's default skin)</summary>
<description lang="en">Confluence is the default skin for Kodi 9.11 and above. It is a combination of concepts from many popular skins, and attempts to embrace and integrate their good ideas into a skin that should be easy for first time Kodi users to understand and use.</description>
<disclaimer lang="en">Confluence is the default skin for Kodi, removing it may cause issues</disclaimer>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>
One thing to note is that <font color="red">all tag names are lower case.</font> XML tag names are case sensitive!

== addon.xml for scripts ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon
id="script.artwork.downloader"
name="Artwork Downloader"
version="12.0.12"
provider-name="Martijn">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
<import addon="xbmc.json" version="6.0.0"/>
<import addon="xbmc.addon" version="12.0.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10" optional="true"/>
<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.service" library="service.py" start="login"/>
<extension point="xbmc.addon.metadata">
<summary lang="en">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary>
<description lang="en">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">For bugs, requests or general questions visit the Artwork Downloader thread on the Kodi forum.</disclaimer>
<language></language>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

= Schema Definition =

The XML schema definition for <code>addon.xml</code> is located [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.addon/metadata.xsd here].

{{frodo updated}}

[[Category:Add-on development]]
[[Category:Skin development]]

Addon.xml

2015-12-28T09:20:59Z

Martijn: /* xbmc.addon.metadata */

{{mininav|[[Development]]|[[Add-on development]]}}
<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.

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

<syntaxhighlight lang="xml" enclose="div">
<?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.1.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></language>
<platform>all</platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

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

* The <code><addon></code> element must be present, and be the root node. It presents data about the add-on package as a whole.
* 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.
* Then there are one or more <code><extension></code> elements, each of which describes a part of Kodi that the add-on extends.
* Finally, there is a specific <code><extension></code> element that extends <code>"xbmc.addon.metadata"</code>. This describes the add-on to the user.

= Elements =

== <addon> ==

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:

<source lang="xml">
<addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2">
</source>

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

==== How versioning works ====

* <code>2.2.9</code> is newer than <code>2.2.1</code>
* <code>2.2.10</code> is newer than <code>2.2.1</code>
* <code>2.3.0</code> is newer than <code>2.2.9</code>
* <code>2.2.1</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1</code> is newer than <code>2.2.1~beta</code>
* <code>2.2.1~beta</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1~beta3</code> is newer than <code>2.2.1~beta2</code>
* <code>2.2.1~beta10</code> is newer than <code>2.2.1~beta1</code>

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

== <requires> ==

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.

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 <code><requires></code> block that imports two required modules:

<source lang="xml">
<requires>
<import addon="xbmc.python" version="2.14.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10"/>
</requires>
</source>

Here's another example, which will only install on OpenELEC:

<source lang="xml">
<requires>
<import addon="os.openelec.tv" version="2.0"/>
</requires>
</source>

== <import> ==

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

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.

=== addon attribute ===

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

=== version attribute ===

The <code>version</code> 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 <code>xbmc.*</code> add-on dependencies to control on which version of Kodi the add-on can be installed.

{| class="prettytable" border="1"
|+ Current versions
! Kodi version !! xbmc.python !! xbmc.gui !! xbmc.json !! xbmc.metadata !! xbmc.addon
|-
| Dharma 10.1 <font color="red">Deprecated</font>|| 1.0 || 2.11 || 2.0|| 1.0 || 0.1
|-
| Eden 11.0 <font color="red">Deprecated</font> || 2.0 || 3.0 || 4.0 || 1.0 || 11.0
|-
| Frodo 12.x <font color="red">Deprecated</font>|| 2.1.0 || 4.0.0 || 6.0.0 || 2.1.0 || 12.0.0
|-
| Gotham 13.x || 2.14.0 (ABI 2.1.0) || 5.0.1 || 6.6.0 (ABI 6.0.0) || 2.1.0 || 13.0.0 (ABI 12.0.0)
|-
| Helix 14.x || 2.19.0 (ABI 2.1.0) || 5.3.0 || 6.20.0 (ABI 6.0.0) || 2.1.0 || 14.0.0 (ABI 12.0.0)
|-
| 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 || 15.0.0 (ABI 12.0.0)
|-
| Jarvis 16.x || 2.24.0 (ABI 2.1.0) || 5.10.0 || 6.32.1 (ABI 6.0.0) || 2.1.0 || 16.0.0 (ABI 12.0.0)
|}

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

== <extension> ==

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.

The various extension points that Kodi provides are given in the list below.
{| class="prettytable"
!Extension point
!Add-on Category
|-
|<code>[[Skinning|xbmc.gui.skin]]</code>
|Skin
|-
|<code>xbmc.gui.webinterface</code>
|Web interface
|-
|<code>[[Add-on repositories|xbmc.addon.repository]]</code>
|''None''
|-
|<code>[[HOW-TO:_Automatically_start_addons_using_services|xbmc.service]]</code>
|Services
|-
|<code>xbmc.metadata.scraper.albums</code>
|Album information
|-
|<code>xbmc.metadata.scraper.artists</code>
|Artist information
|-
|<code>xbmc.metadata.scraper.movies</code>
|Movie information
|-
|<code>xbmc.metadata.scraper.musicvideos</code>
|Music video information
|-
|<code>xbmc.metadata.scraper.tvshows</code>
|TV information
|-
|<code>xbmc.metadata.scraper.library</code>
|''None''
|-
|<code>xbmc.ui.screensaver</code>
|Screensaver
|-
|<code>xbmc.player.musicviz</code>
|Visualization
|-
|<code>[[Plugin sources#What Kodi requires for your add-on|xbmc.python.pluginsource]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>[[Script sources#What Kodi requires for your add-on|xbmc.python.script]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>xbmc.python.weather</code>
|Weather
|-{{Gotham row}}
|<code>[[Script Subtitles#What Kodi requires for your add-on|xbmc.python.subtitles]]</code>
|'''([[:Category:Gotham feature|Future Gotham removal]])''' Subtitles
|-{{Gotham row}}
|<code>xbmc.subtitle.module</code>
|'''([[:Category:Gotham feature|Future Gotham addition]])''' Subtitle service module
|-
|<code>[[Script lyrics#What Kodi requires for your add-on|xbmc.python.lyrics]]</code>
|Lyrics
|-
|<code>[[Script library#What Kodi requires for your add-on|xbmc.python.library]]</code>
|''None''
|-
|<code>xbmc.python.module</code>
|These don't show up in the addon browser and are purely as support for other scripts.
|-
|<code>xbmc.addon.video</code>
|Video Add-ons (video)
|-
|<code>xbmc.addon.audio</code>
|Music Add-ons (audio)
|-
|<code>xbmc.addon.image</code>
|Picture Add-ons (image)
|-
|<code>kodi.resource.images</code>
|Additional image files
|-
|<code>kodi.resource.language</code>
|Additional language files
|}

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 ===
{{See also|Plugin sources}}

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

==== library attribute ====

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.

==== <provides> element ====

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:

{| class="prettytable"
!Provides
!Appears in
|-
|<code>image</code>
|Pictures
|-
|<code>audio</code>
|Music
|-
|<code>video</code>
|Video
|-
|<code>executable</code>
|Programs
|-
|''(blank)''
|Not visible
|}

==== Example ====

<source lang="xml">
<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py">
<provides>audio video</provides>
</extension>
</source>

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

==== Required elements ====

There are several elements that this should contain and all are compulsory (except the broken tag). Each of the elements below 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. See the [[List of language codes (ISO-639:1988)]] for possible language strings. If there's no <code>lang</code> attribute for a translatable element, it defaults to English. However, even for English, adding the <code>lang</code> attribute is recommended.

===== <summary> =====

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.

<source lang="xml">
<summary lang="en">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

From Kodi v15 Isengard we recommend you use

<source lang="xml">
<summary lang="en_gb">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

===== <description> =====

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.

<source lang="xml">
<description lang="en">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>
</source>

From Kodi v15 Isengard we recommend you use

<source lang="xml">
<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>
</source>

===== <disclaimer> =====

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.

<source lang="xml">
<disclaimer lang="en">Feel free to use this script. For information visit the wiki.</disclaimer>
</source>

From Kodi v15 Isengard we recommend you use

<source lang="xml">
<disclaimer lang="en_gb">Feel free to use this script. For information visit the wiki.</disclaimer>
</source>

===== <platform> =====

The <code><platform></code> tag specifies which platforms (operating systems, hardware) 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:

* <code>all</code>
* <code>linux</code>
* <code>osx</code>
* <code>osx64</code>
* <code>osx32</code>
* <code>ios</code>
* <code>windx</code>
* <code>android</code>

<source lang="xml">
<platform>all</platform>
</source>

===== <language> =====

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, leave it blank.

<source lang="xml">
<language>en de fr</language>
or
<language></language>
</source>

===== <license> =====

The <code><license></code> element indicates what license is used for this add-on.

<source lang="xml">
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
</source>

===== <forum> =====

The <code><forum></code> element provides the forum thread URL for this specific add-on. Leave this blank if there is no forum thread.
<source lang="xml">
<forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum>
</source>

===== <website> =====

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

<source lang="xml">
<website>http://www.myaddonwebsite.com/</website>
</source>

===== <nowiki><source></nowiki> =====

The <code><nowiki><source></nowiki></code> element provides the URL for the source code for this specific add-on.
<syntaxhighlight lang="xml" enclose="div">
<source>http://github.com/someone/myaddon</source>
</syntaxhighlight>

===== <email> =====

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.
<source lang="xml">
<email>foo@bar.com</email>
or
<email>foo at bar dot com</email>
</source>

===== <broken> =====

The <code><broken></code> tag will mark the add-on as broken in the Kodi repo and provide the reason why. You don't need to do a version bump for this to work. However a bump is recommended as you could also add this to the changelog.

<source lang="xml">
<broken>deprecated</broken>
</source>

== Skin specific elements ==
=== Overview ===
{| class="prettytable"
| '''effectslowdown'''
| 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.
|-
| '''debugging'''
| When set to true, it'll display onscreen debug information (xml filename, mouse position and focused control type and name) in the skin.
|-
| '''res'''
| Support for arbitrary skin resolutions.
|}

=== How window xml files are found ===

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.

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

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

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

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.

= Examples =

== addon.xml for skins ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<addon
id="skin.confluence"
version="2.1.3"
name="Confluence"
provider-name="Jezz_X, Team Kodi">
<requires>
<import addon="xbmc.gui" version="4.0.0"/>
</requires>
<extension
point="xbmc.gui.skin"
debugging="false"
effectslowdown="0.75">
<res width="1280" height="720" aspect="16:9" default="true" folder="720p" />
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Confluence skin by Jezz_X. (Kodi's default skin)</summary>
<description lang="en">Confluence is the default skin for Kodi 9.11 and above. It is a combination of concepts from many popular skins, and attempts to embrace and integrate their good ideas into a skin that should be easy for first time Kodi users to understand and use.</description>
<disclaimer lang="en">Confluence is the default skin for Kodi, removing it may cause issues</disclaimer>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>
One thing to note is that <font color="red">all tag names are lower case.</font> XML tag names are case sensitive!

== addon.xml for scripts ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon
id="script.artwork.downloader"
name="Artwork Downloader"
version="12.0.12"
provider-name="Martijn">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
<import addon="xbmc.json" version="6.0.0"/>
<import addon="xbmc.addon" version="12.0.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10" optional="true"/>
<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.service" library="service.py" start="login"/>
<extension point="xbmc.addon.metadata">
<summary lang="en">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary>
<description lang="en">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">For bugs, requests or general questions visit the Artwork Downloader thread on the Kodi forum.</disclaimer>
<language></language>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

= Schema Definition =

The XML schema definition for <code>addon.xml</code> is located [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.addon/metadata.xsd here].

{{frodo updated}}

[[Category:Add-on development]]
[[Category:Skin development]]

Addon.xml

2015-12-28T09:19:58Z

Martijn:

{{mininav|[[Development]]|[[Add-on development]]}}
<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.

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

<syntaxhighlight lang="xml" enclose="div">
<?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.1.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></language>
<platform>all</platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

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

* The <code><addon></code> element must be present, and be the root node. It presents data about the add-on package as a whole.
* 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.
* Then there are one or more <code><extension></code> elements, each of which describes a part of Kodi that the add-on extends.
* Finally, there is a specific <code><extension></code> element that extends <code>"xbmc.addon.metadata"</code>. This describes the add-on to the user.

= Elements =

== <addon> ==

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:

<source lang="xml">
<addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2">
</source>

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

==== How versioning works ====

* <code>2.2.9</code> is newer than <code>2.2.1</code>
* <code>2.2.10</code> is newer than <code>2.2.1</code>
* <code>2.3.0</code> is newer than <code>2.2.9</code>
* <code>2.2.1</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1</code> is newer than <code>2.2.1~beta</code>
* <code>2.2.1~beta</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1~beta3</code> is newer than <code>2.2.1~beta2</code>
* <code>2.2.1~beta10</code> is newer than <code>2.2.1~beta1</code>

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

== <requires> ==

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.

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 <code><requires></code> block that imports two required modules:

<source lang="xml">
<requires>
<import addon="xbmc.python" version="2.14.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10"/>
</requires>
</source>

Here's another example, which will only install on OpenELEC:

<source lang="xml">
<requires>
<import addon="os.openelec.tv" version="2.0"/>
</requires>
</source>

== <import> ==

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

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.

=== addon attribute ===

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

=== version attribute ===

The <code>version</code> 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 <code>xbmc.*</code> add-on dependencies to control on which version of Kodi the add-on can be installed.

{| class="prettytable" border="1"
|+ Current versions
! Kodi version !! xbmc.python !! xbmc.gui !! xbmc.json !! xbmc.metadata !! xbmc.addon
|-
| Dharma 10.1 <font color="red">Deprecated</font>|| 1.0 || 2.11 || 2.0|| 1.0 || 0.1
|-
| Eden 11.0 <font color="red">Deprecated</font> || 2.0 || 3.0 || 4.0 || 1.0 || 11.0
|-
| Frodo 12.x <font color="red">Deprecated</font>|| 2.1.0 || 4.0.0 || 6.0.0 || 2.1.0 || 12.0.0
|-
| Gotham 13.x || 2.14.0 (ABI 2.1.0) || 5.0.1 || 6.6.0 (ABI 6.0.0) || 2.1.0 || 13.0.0 (ABI 12.0.0)
|-
| Helix 14.x || 2.19.0 (ABI 2.1.0) || 5.3.0 || 6.20.0 (ABI 6.0.0) || 2.1.0 || 14.0.0 (ABI 12.0.0)
|-
| 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 || 15.0.0 (ABI 12.0.0)
|-
| Jarvis 16.x || 2.24.0 (ABI 2.1.0) || 5.10.0 || 6.32.1 (ABI 6.0.0) || 2.1.0 || 16.0.0 (ABI 12.0.0)
|}

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

== <extension> ==

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.

The various extension points that Kodi provides are given in the list below.
{| class="prettytable"
!Extension point
!Add-on Category
|-
|<code>[[Skinning|xbmc.gui.skin]]</code>
|Skin
|-
|<code>xbmc.gui.webinterface</code>
|Web interface
|-
|<code>[[Add-on repositories|xbmc.addon.repository]]</code>
|''None''
|-
|<code>[[HOW-TO:_Automatically_start_addons_using_services|xbmc.service]]</code>
|Services
|-
|<code>xbmc.metadata.scraper.albums</code>
|Album information
|-
|<code>xbmc.metadata.scraper.artists</code>
|Artist information
|-
|<code>xbmc.metadata.scraper.movies</code>
|Movie information
|-
|<code>xbmc.metadata.scraper.musicvideos</code>
|Music video information
|-
|<code>xbmc.metadata.scraper.tvshows</code>
|TV information
|-
|<code>xbmc.metadata.scraper.library</code>
|''None''
|-
|<code>xbmc.ui.screensaver</code>
|Screensaver
|-
|<code>xbmc.player.musicviz</code>
|Visualization
|-
|<code>[[Plugin sources#What Kodi requires for your add-on|xbmc.python.pluginsource]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>[[Script sources#What Kodi requires for your add-on|xbmc.python.script]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>xbmc.python.weather</code>
|Weather
|-{{Gotham row}}
|<code>[[Script Subtitles#What Kodi requires for your add-on|xbmc.python.subtitles]]</code>
|'''([[:Category:Gotham feature|Future Gotham removal]])''' Subtitles
|-{{Gotham row}}
|<code>xbmc.subtitle.module</code>
|'''([[:Category:Gotham feature|Future Gotham addition]])''' Subtitle service module
|-
|<code>[[Script lyrics#What Kodi requires for your add-on|xbmc.python.lyrics]]</code>
|Lyrics
|-
|<code>[[Script library#What Kodi requires for your add-on|xbmc.python.library]]</code>
|''None''
|-
|<code>xbmc.python.module</code>
|These don't show up in the addon browser and are purely as support for other scripts.
|-
|<code>xbmc.addon.video</code>
|Video Add-ons (video)
|-
|<code>xbmc.addon.audio</code>
|Music Add-ons (audio)
|-
|<code>xbmc.addon.image</code>
|Picture Add-ons (image)
|-
|<code>kodi.resource.images</code>
|Additional image files
|-
|<code>kodi.resource.language</code>
|Additional language files
|}

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 ===
{{See also|Plugin sources}}

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

==== library attribute ====

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.

==== <provides> element ====

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:

{| class="prettytable"
!Provides
!Appears in
|-
|<code>image</code>
|Pictures
|-
|<code>audio</code>
|Music
|-
|<code>video</code>
|Video
|-
|<code>executable</code>
|Programs
|-
|''(blank)''
|Not visible
|}

==== Example ====

<source lang="xml">
<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py">
<provides>audio video</provides>
</extension>
</source>

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

==== Required elements ====

There are several elements that this should contain and all are compulsory (except the broken tag). Each of the elements below 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. See the [[List of language codes (ISO-639:1988)]] for possible language strings. If there's no <code>lang</code> attribute for a translatable element, it defaults to English. However, even for English, adding the <code>lang</code> attribute is recommended.

===== <summary> =====

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.

<source lang="xml">
<summary lang="en">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

From Kodi v15 Isengard we recommend you use

<source lang="xml">
<summary lang="en_gb">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

===== <description> =====

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.

<source lang="xml">
<description lang="en">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>
</source>

From Kodi v15 Isengard we recommend you use

<source lang="xml">
<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>
</source>

===== <platform> =====

The <code><platform></code> tag specifies which platforms (operating systems, hardware) 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:

* <code>all</code>
* <code>linux</code>
* <code>osx</code>
* <code>osx64</code>
* <code>osx32</code>
* <code>ios</code>
* <code>windx</code>
* <code>android</code>

<source lang="xml">
<platform>all</platform>
</source>

===== <language> =====

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, leave it blank.

<source lang="xml">
<language>en de fr</language>
or
<language></language>
</source>

===== <license> =====

The <code><license></code> element indicates what license is used for this add-on.

<source lang="xml">
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
</source>

===== <forum> =====

The <code><forum></code> element provides the forum thread URL for this specific add-on. Leave this blank if there is no forum thread.
<source lang="xml">
<forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum>
</source>

===== <website> =====

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

<source lang="xml">
<website>http://www.myaddonwebsite.com/</website>
</source>

===== <nowiki><source></nowiki> =====

The <code><nowiki><source></nowiki></code> element provides the URL for the source code for this specific add-on.
<syntaxhighlight lang="xml" enclose="div">
<source>http://github.com/someone/myaddon</source>
</syntaxhighlight>

===== <email> =====

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.
<source lang="xml">
<email>foo@bar.com</email>
or
<email>foo at bar dot com</email>
</source>

===== <disclaimer> =====

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.

<source lang="xml">
<disclaimer lang="en">Feel free to use this script. For information visit the wiki.</disclaimer>
</source>

===== <broken> =====

The <code><broken></code> tag will mark the add-on as broken in the Kodi repo and provide the reason why. You don't need to do a version bump for this to work. However a bump is recommended as you could also add this to the changelog.

<source lang="xml">
<broken>deprecated</broken>
</source>

== Skin specific elements ==
=== Overview ===
{| class="prettytable"
| '''effectslowdown'''
| 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.
|-
| '''debugging'''
| When set to true, it'll display onscreen debug information (xml filename, mouse position and focused control type and name) in the skin.
|-
| '''res'''
| Support for arbitrary skin resolutions.
|}

=== How window xml files are found ===

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.

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

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

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

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.

= Examples =

== addon.xml for skins ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<addon
id="skin.confluence"
version="2.1.3"
name="Confluence"
provider-name="Jezz_X, Team Kodi">
<requires>
<import addon="xbmc.gui" version="4.0.0"/>
</requires>
<extension
point="xbmc.gui.skin"
debugging="false"
effectslowdown="0.75">
<res width="1280" height="720" aspect="16:9" default="true" folder="720p" />
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Confluence skin by Jezz_X. (Kodi's default skin)</summary>
<description lang="en">Confluence is the default skin for Kodi 9.11 and above. It is a combination of concepts from many popular skins, and attempts to embrace and integrate their good ideas into a skin that should be easy for first time Kodi users to understand and use.</description>
<disclaimer lang="en">Confluence is the default skin for Kodi, removing it may cause issues</disclaimer>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>
One thing to note is that <font color="red">all tag names are lower case.</font> XML tag names are case sensitive!

== addon.xml for scripts ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon
id="script.artwork.downloader"
name="Artwork Downloader"
version="12.0.12"
provider-name="Martijn">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
<import addon="xbmc.json" version="6.0.0"/>
<import addon="xbmc.addon" version="12.0.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10" optional="true"/>
<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.service" library="service.py" start="login"/>
<extension point="xbmc.addon.metadata">
<summary lang="en">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary>
<description lang="en">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">For bugs, requests or general questions visit the Artwork Downloader thread on the Kodi forum.</disclaimer>
<language></language>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

= Schema Definition =

The XML schema definition for <code>addon.xml</code> is located [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.addon/metadata.xsd here].

{{frodo updated}}

[[Category:Add-on development]]
[[Category:Skin development]]

Addon.xml

2015-12-28T09:19:36Z

Martijn: /* */

{{mininav|[[Development]]|[[Add-on development]]}}
<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.

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

<syntaxhighlight lang="xml" enclose="div">
<?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.1.0"/>
</requires>
<extension point="xbmc.python.pluginsource" library="addon.py">
<provides>video</provides>
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Your add-on's summary</summary>
<description lang="en">Your add-on's description</description>
<disclaimer lang="en"></disclaimer>
<language></language>
<platform>all</platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

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

* The <code><addon></code> element must be present, and be the root node. It presents data about the add-on package as a whole.
* 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.
* Then there are one or more <code><extension></code> elements, each of which describes a part of Kodi that the add-on extends.
* Finally, there is a specific <code><extension></code> element that extends <code>"xbmc.addon.metadata"</code>. This describes the add-on to the user.

= Elements =

== <addon> ==

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:

<source lang="xml">
<addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2">
</source>

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

==== How versioning works ====

* <code>2.2.9</code> is newer than <code>2.2.1</code>
* <code>2.2.10</code> is newer than <code>2.2.1</code>
* <code>2.3.0</code> is newer than <code>2.2.9</code>
* <code>2.2.1</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1</code> is newer than <code>2.2.1~beta</code>
* <code>2.2.1~beta</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1~beta3</code> is newer than <code>2.2.1~beta2</code>
* <code>2.2.1~beta10</code> is newer than <code>2.2.1~beta1</code>

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

== <requires> ==

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.

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 <code><requires></code> block that imports two required modules:

<source lang="xml">
<requires>
<import addon="xbmc.python" version="2.14.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10"/>
</requires>
</source>

Here's another example, which will only install on OpenELEC:

<source lang="xml">
<requires>
<import addon="os.openelec.tv" version="2.0"/>
</requires>
</source>

== <import> ==

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

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.

=== addon attribute ===

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

=== version attribute ===

The <code>version</code> 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 <code>xbmc.*</code> add-on dependencies to control on which version of Kodi the add-on can be installed.

{| class="prettytable" border="1"
|+ Current versions
! Kodi version !! xbmc.python !! xbmc.gui !! xbmc.json !! xbmc.metadata !! xbmc.addon
|-
| Dharma 10.1 <font color="red">Deprecated</font>|| 1.0 || 2.11 || 2.0|| 1.0 || 0.1
|-
| Eden 11.0 <font color="red">Deprecated</font> || 2.0 || 3.0 || 4.0 || 1.0 || 11.0
|-
| Frodo 12.x <font color="red">Deprecated</font>|| 2.1.0 || 4.0.0 || 6.0.0 || 2.1.0 || 12.0.0
|-
| Gotham 13.x || 2.14.0 (ABI 2.1.0) || 5.0.1 || 6.6.0 (ABI 6.0.0) || 2.1.0 || 13.0.0 (ABI 12.0.0)
|-
| Helix 14.x || 2.19.0 (ABI 2.1.0) || 5.3.0 || 6.20.0 (ABI 6.0.0) || 2.1.0 || 14.0.0 (ABI 12.0.0)
|-
| 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 || 15.0.0 (ABI 12.0.0)
|-
| Jarvis 16.x || 2.24.0 (ABI 2.1.0) || 5.10.0 || 6.32.1 (ABI 6.0.0) || 2.1.0 || 16.0.0 (ABI 12.0.0)
|}

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

== <extension> ==

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.

The various extension points that Kodi provides are given in the list below.
{| class="prettytable"
!Extension point
!Add-on Category
|-
|<code>[[Skinning|xbmc.gui.skin]]</code>
|Skin
|-
|<code>xbmc.gui.webinterface</code>
|Web interface
|-
|<code>[[Add-on repositories|xbmc.addon.repository]]</code>
|''None''
|-
|<code>[[HOW-TO:_Automatically_start_addons_using_services|xbmc.service]]</code>
|Services
|-
|<code>xbmc.metadata.scraper.albums</code>
|Album information
|-
|<code>xbmc.metadata.scraper.artists</code>
|Artist information
|-
|<code>xbmc.metadata.scraper.movies</code>
|Movie information
|-
|<code>xbmc.metadata.scraper.musicvideos</code>
|Music video information
|-
|<code>xbmc.metadata.scraper.tvshows</code>
|TV information
|-
|<code>xbmc.metadata.scraper.library</code>
|''None''
|-
|<code>xbmc.ui.screensaver</code>
|Screensaver
|-
|<code>xbmc.player.musicviz</code>
|Visualization
|-
|<code>[[Plugin sources#What Kodi requires for your add-on|xbmc.python.pluginsource]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>[[Script sources#What Kodi requires for your add-on|xbmc.python.script]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>xbmc.python.weather</code>
|Weather
|-{{Gotham row}}
|<code>[[Script Subtitles#What Kodi requires for your add-on|xbmc.python.subtitles]]</code>
|'''([[:Category:Gotham feature|Future Gotham removal]])''' Subtitles
|-{{Gotham row}}
|<code>xbmc.subtitle.module</code>
|'''([[:Category:Gotham feature|Future Gotham addition]])''' Subtitle service module
|-
|<code>[[Script lyrics#What Kodi requires for your add-on|xbmc.python.lyrics]]</code>
|Lyrics
|-
|<code>[[Script library#What Kodi requires for your add-on|xbmc.python.library]]</code>
|''None''
|-
|<code>xbmc.python.module</code>
|These don't show up in the addon browser and are purely as support for other scripts.
|-
|<code>xbmc.addon.video</code>
|Video Add-ons (video)
|-
|<code>xbmc.addon.audio</code>
|Music Add-ons (audio)
|-
|<code>xbmc.addon.image</code>
|Picture Add-ons (image)
|-
|<code>kodi.resource.images</code>
|Additional image files
|-
|<code>kodi.resource.language</code>
|Additional language files
|}

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 ===
{{See also|Plugin sources}}

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

==== library attribute ====

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.

==== <provides> element ====

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:

{| class="prettytable"
!Provides
!Appears in
|-
|<code>image</code>
|Pictures
|-
|<code>audio</code>
|Music
|-
|<code>video</code>
|Video
|-
|<code>executable</code>
|Programs
|-
|''(blank)''
|Not visible
|}

==== Example ====

<source lang="xml">
<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py">
<provides>audio video</provides>
</extension>
</source>

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

==== Required elements ====

There are several elements that this should contain and all are compulsory (except the broken tag). Each of the elements below 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. See the [[List of language codes (ISO-639:1988)]] for possible language strings. If there's no <code>lang</code> attribute for a translatable element, it defaults to English. However, even for English, adding the <code>lang</code> attribute is recommended.

===== <summary> =====

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.

<source lang="xml">
<summary lang="en">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

From Kodi v15 Isengard we recommend you use

<source lang="xml">
<summary lang="en_gb">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

===== <description> =====

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.

<source lang="xml">
<description lang="en">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>
</source>

From Kodi v15 Isengard we recommend you use

<source lang="xml">
<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>
</source>

===== <platform> =====

The <code><platform></code> tag specifies which platforms (operating systems, hardware) 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:

* <code>all</code>
* <code>linux</code>
* <code>osx</code>
* <code>osx64</code>
* <code>osx32</code>
* <code>ios</code>
* <code>windx</code>
* <code>android</code>

<source lang="xml">
<platform>all</platform>
</source>

===== <language> =====

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, leave it blank.

<source lang="xml">
<language>en de fr</language>
or
<language></language>
</source>

===== <license> =====

The <code><license></code> element indicates what license is used for this add-on.

<source lang="xml">
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
</source>

===== <forum> =====

The <code><forum></code> element provides the forum thread URL for this specific add-on. Leave this blank if there is no forum thread.
<source lang="xml">
<forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum>
</source>

===== <website> =====

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

<source lang="xml">
<website>http://www.myaddonwebsite.com/</website>
</source>

===== <nowiki><source></nowiki> =====

The <code><nowiki><source></nowiki></code> element provides the URL for the source code for this specific add-on.
<syntaxhighlight lang="xml" enclose="div">
<source>http://github.com/someone/myaddon</source>
</syntaxhighlight>

===== <email> =====

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.
<source lang="xml">
<email>foo@bar.com</email>
or
<email>foo at bar dot com</email>
</source>

===== <disclaimer> =====

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.

<source lang="xml">
<disclaimer lang="en">Feel free to use this script. For information visit the wiki.</disclaimer>
</source>

===== <broken> =====

The <code><broken></code> tag will mark the add-on as broken in the Kodi repo and provide the reason why. You don't need to do a version bump for this to work. However a bump is recommended as you could also add this to the changelog.

<source lang="xml">
<broken>deprecated</broken>
</source>

== Skin specific elements ==
=== Overview ===
{| class="prettytable"
| '''effectslowdown'''
| 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.
|-
| '''debugging'''
| When set to true, it'll display onscreen debug information (xml filename, mouse position and focused control type and name) in the skin.
|-
| '''res'''
| Support for arbitrary skin resolutions.
|}

=== How window xml files are found ===

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.

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

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

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

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.

= Examples =

== addon.xml for skins ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<addon
id="skin.confluence"
version="2.1.3"
name="Confluence"
provider-name="Jezz_X, Team Kodi">
<requires>
<import addon="xbmc.gui" version="4.0.0"/>
</requires>
<extension
point="xbmc.gui.skin"
debugging="false"
effectslowdown="0.75">
<res width="1280" height="720" aspect="16:9" default="true" folder="720p" />
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Confluence skin by Jezz_X. (Kodi's default skin)</summary>
<description lang="en">Confluence is the default skin for Kodi 9.11 and above. It is a combination of concepts from many popular skins, and attempts to embrace and integrate their good ideas into a skin that should be easy for first time Kodi users to understand and use.</description>
<disclaimer lang="en">Confluence is the default skin for Kodi, removing it may cause issues</disclaimer>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>
One thing to note is that <font color="red">all tag names are lower case.</font> XML tag names are case sensitive!

== addon.xml for scripts ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon
id="script.artwork.downloader"
name="Artwork Downloader"
version="12.0.12"
provider-name="Martijn">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
<import addon="xbmc.json" version="6.0.0"/>
<import addon="xbmc.addon" version="12.0.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10" optional="true"/>
<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.service" library="service.py" start="login"/>
<extension point="xbmc.addon.metadata">
<summary lang="en">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary>
<description lang="en">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">For bugs, requests or general questions visit the Artwork Downloader thread on the Kodi forum.</disclaimer>
<language></language>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

= Schema Definition =

The XML schema definition for <code>addon.xml</code> is located [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.addon/metadata.xsd here].

{{frodo updated}}

[[Category:Add-on development]]
[[Category:Skin development]]

Addon.xml

2015-12-28T09:18:43Z

Martijn: /* */

{{mininav|[[Development]]|[[Add-on development]]}}
<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.

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

<syntaxhighlight lang="xml" enclose="div">
<?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.1.0"/>
</requires>
<extension point="xbmc.python.pluginsource" library="addon.py">
<provides>video</provides>
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Your add-on's summary</summary>
<description lang="en">Your add-on's description</description>
<disclaimer lang="en"></disclaimer>
<language></language>
<platform>all</platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

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

* The <code><addon></code> element must be present, and be the root node. It presents data about the add-on package as a whole.
* 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.
* Then there are one or more <code><extension></code> elements, each of which describes a part of Kodi that the add-on extends.
* Finally, there is a specific <code><extension></code> element that extends <code>"xbmc.addon.metadata"</code>. This describes the add-on to the user.

= Elements =

== <addon> ==

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:

<source lang="xml">
<addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2">
</source>

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

==== How versioning works ====

* <code>2.2.9</code> is newer than <code>2.2.1</code>
* <code>2.2.10</code> is newer than <code>2.2.1</code>
* <code>2.3.0</code> is newer than <code>2.2.9</code>
* <code>2.2.1</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1</code> is newer than <code>2.2.1~beta</code>
* <code>2.2.1~beta</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1~beta3</code> is newer than <code>2.2.1~beta2</code>
* <code>2.2.1~beta10</code> is newer than <code>2.2.1~beta1</code>

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

== <requires> ==

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.

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 <code><requires></code> block that imports two required modules:

<source lang="xml">
<requires>
<import addon="xbmc.python" version="2.14.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10"/>
</requires>
</source>

Here's another example, which will only install on OpenELEC:

<source lang="xml">
<requires>
<import addon="os.openelec.tv" version="2.0"/>
</requires>
</source>

== <import> ==

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

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.

=== addon attribute ===

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

=== version attribute ===

The <code>version</code> 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 <code>xbmc.*</code> add-on dependencies to control on which version of Kodi the add-on can be installed.

{| class="prettytable" border="1"
|+ Current versions
! Kodi version !! xbmc.python !! xbmc.gui !! xbmc.json !! xbmc.metadata !! xbmc.addon
|-
| Dharma 10.1 <font color="red">Deprecated</font>|| 1.0 || 2.11 || 2.0|| 1.0 || 0.1
|-
| Eden 11.0 <font color="red">Deprecated</font> || 2.0 || 3.0 || 4.0 || 1.0 || 11.0
|-
| Frodo 12.x <font color="red">Deprecated</font>|| 2.1.0 || 4.0.0 || 6.0.0 || 2.1.0 || 12.0.0
|-
| Gotham 13.x || 2.14.0 (ABI 2.1.0) || 5.0.1 || 6.6.0 (ABI 6.0.0) || 2.1.0 || 13.0.0 (ABI 12.0.0)
|-
| Helix 14.x || 2.19.0 (ABI 2.1.0) || 5.3.0 || 6.20.0 (ABI 6.0.0) || 2.1.0 || 14.0.0 (ABI 12.0.0)
|-
| 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 || 15.0.0 (ABI 12.0.0)
|-
| Jarvis 16.x || 2.24.0 (ABI 2.1.0) || 5.10.0 || 6.32.1 (ABI 6.0.0) || 2.1.0 || 16.0.0 (ABI 12.0.0)
|}

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

== <extension> ==

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.

The various extension points that Kodi provides are given in the list below.
{| class="prettytable"
!Extension point
!Add-on Category
|-
|<code>[[Skinning|xbmc.gui.skin]]</code>
|Skin
|-
|<code>xbmc.gui.webinterface</code>
|Web interface
|-
|<code>[[Add-on repositories|xbmc.addon.repository]]</code>
|''None''
|-
|<code>[[HOW-TO:_Automatically_start_addons_using_services|xbmc.service]]</code>
|Services
|-
|<code>xbmc.metadata.scraper.albums</code>
|Album information
|-
|<code>xbmc.metadata.scraper.artists</code>
|Artist information
|-
|<code>xbmc.metadata.scraper.movies</code>
|Movie information
|-
|<code>xbmc.metadata.scraper.musicvideos</code>
|Music video information
|-
|<code>xbmc.metadata.scraper.tvshows</code>
|TV information
|-
|<code>xbmc.metadata.scraper.library</code>
|''None''
|-
|<code>xbmc.ui.screensaver</code>
|Screensaver
|-
|<code>xbmc.player.musicviz</code>
|Visualization
|-
|<code>[[Plugin sources#What Kodi requires for your add-on|xbmc.python.pluginsource]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>[[Script sources#What Kodi requires for your add-on|xbmc.python.script]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>xbmc.python.weather</code>
|Weather
|-{{Gotham row}}
|<code>[[Script Subtitles#What Kodi requires for your add-on|xbmc.python.subtitles]]</code>
|'''([[:Category:Gotham feature|Future Gotham removal]])''' Subtitles
|-{{Gotham row}}
|<code>xbmc.subtitle.module</code>
|'''([[:Category:Gotham feature|Future Gotham addition]])''' Subtitle service module
|-
|<code>[[Script lyrics#What Kodi requires for your add-on|xbmc.python.lyrics]]</code>
|Lyrics
|-
|<code>[[Script library#What Kodi requires for your add-on|xbmc.python.library]]</code>
|''None''
|-
|<code>xbmc.python.module</code>
|These don't show up in the addon browser and are purely as support for other scripts.
|-
|<code>xbmc.addon.video</code>
|Video Add-ons (video)
|-
|<code>xbmc.addon.audio</code>
|Music Add-ons (audio)
|-
|<code>xbmc.addon.image</code>
|Picture Add-ons (image)
|-
|<code>kodi.resource.images</code>
|Additional image files
|-
|<code>kodi.resource.language</code>
|Additional language files
|}

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 ===
{{See also|Plugin sources}}

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

==== library attribute ====

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.

==== <provides> element ====

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:

{| class="prettytable"
!Provides
!Appears in
|-
|<code>image</code>
|Pictures
|-
|<code>audio</code>
|Music
|-
|<code>video</code>
|Video
|-
|<code>executable</code>
|Programs
|-
|''(blank)''
|Not visible
|}

==== Example ====

<source lang="xml">
<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py">
<provides>audio video</provides>
</extension>
</source>

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

==== Required elements ====

There are several elements that this should contain and all are compulsory (except the broken tag). Each of the elements below 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. See the [[List of language codes (ISO-639:1988)]] for possible language strings. If there's no <code>lang</code> attribute for a translatable element, it defaults to English. However, even for English, adding the <code>lang</code> attribute is recommended.

===== <summary> =====

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.

<source lang="xml">
<summary lang="en">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

From Kodi v15 Isengard we recommend you use

<source lang="xml">
<summary lang="en_gb">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

===== <description> =====

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.

<source lang="xml">
<description lang="en">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>
</source>

===== <platform> =====

The <code><platform></code> tag specifies which platforms (operating systems, hardware) 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:

* <code>all</code>
* <code>linux</code>
* <code>osx</code>
* <code>osx64</code>
* <code>osx32</code>
* <code>ios</code>
* <code>windx</code>
* <code>android</code>

<source lang="xml">
<platform>all</platform>
</source>

===== <language> =====

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, leave it blank.

<source lang="xml">
<language>en de fr</language>
or
<language></language>
</source>

===== <license> =====

The <code><license></code> element indicates what license is used for this add-on.

<source lang="xml">
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
</source>

===== <forum> =====

The <code><forum></code> element provides the forum thread URL for this specific add-on. Leave this blank if there is no forum thread.
<source lang="xml">
<forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum>
</source>

===== <website> =====

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

<source lang="xml">
<website>http://www.myaddonwebsite.com/</website>
</source>

===== <nowiki><source></nowiki> =====

The <code><nowiki><source></nowiki></code> element provides the URL for the source code for this specific add-on.
<syntaxhighlight lang="xml" enclose="div">
<source>http://github.com/someone/myaddon</source>
</syntaxhighlight>

===== <email> =====

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.
<source lang="xml">
<email>foo@bar.com</email>
or
<email>foo at bar dot com</email>
</source>

===== <disclaimer> =====

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.

<source lang="xml">
<disclaimer lang="en">Feel free to use this script. For information visit the wiki.</disclaimer>
</source>

===== <broken> =====

The <code><broken></code> tag will mark the add-on as broken in the Kodi repo and provide the reason why. You don't need to do a version bump for this to work. However a bump is recommended as you could also add this to the changelog.

<source lang="xml">
<broken>deprecated</broken>
</source>

== Skin specific elements ==
=== Overview ===
{| class="prettytable"
| '''effectslowdown'''
| 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.
|-
| '''debugging'''
| When set to true, it'll display onscreen debug information (xml filename, mouse position and focused control type and name) in the skin.
|-
| '''res'''
| Support for arbitrary skin resolutions.
|}

=== How window xml files are found ===

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.

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

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

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

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.

= Examples =

== addon.xml for skins ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<addon
id="skin.confluence"
version="2.1.3"
name="Confluence"
provider-name="Jezz_X, Team Kodi">
<requires>
<import addon="xbmc.gui" version="4.0.0"/>
</requires>
<extension
point="xbmc.gui.skin"
debugging="false"
effectslowdown="0.75">
<res width="1280" height="720" aspect="16:9" default="true" folder="720p" />
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Confluence skin by Jezz_X. (Kodi's default skin)</summary>
<description lang="en">Confluence is the default skin for Kodi 9.11 and above. It is a combination of concepts from many popular skins, and attempts to embrace and integrate their good ideas into a skin that should be easy for first time Kodi users to understand and use.</description>
<disclaimer lang="en">Confluence is the default skin for Kodi, removing it may cause issues</disclaimer>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>
One thing to note is that <font color="red">all tag names are lower case.</font> XML tag names are case sensitive!

== addon.xml for scripts ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon
id="script.artwork.downloader"
name="Artwork Downloader"
version="12.0.12"
provider-name="Martijn">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
<import addon="xbmc.json" version="6.0.0"/>
<import addon="xbmc.addon" version="12.0.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10" optional="true"/>
<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.service" library="service.py" start="login"/>
<extension point="xbmc.addon.metadata">
<summary lang="en">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary>
<description lang="en">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">For bugs, requests or general questions visit the Artwork Downloader thread on the Kodi forum.</disclaimer>
<language></language>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

= Schema Definition =

The XML schema definition for <code>addon.xml</code> is located [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.addon/metadata.xsd here].

{{frodo updated}}

[[Category:Add-on development]]
[[Category:Skin development]]

Addon.xml

2015-12-28T08:59:10Z

Martijn:

{{mininav|[[Development]]|[[Add-on development]]}}
<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.

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

<syntaxhighlight lang="xml" enclose="div">
<?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.1.0"/>
</requires>
<extension point="xbmc.python.pluginsource" library="addon.py">
<provides>video</provides>
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Your add-on's summary</summary>
<description lang="en">Your add-on's description</description>
<disclaimer lang="en"></disclaimer>
<language></language>
<platform>all</platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

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

* The <code><addon></code> element must be present, and be the root node. It presents data about the add-on package as a whole.
* 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.
* Then there are one or more <code><extension></code> elements, each of which describes a part of Kodi that the add-on extends.
* Finally, there is a specific <code><extension></code> element that extends <code>"xbmc.addon.metadata"</code>. This describes the add-on to the user.

= Elements =

== <addon> ==

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:

<source lang="xml">
<addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2">
</source>

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

==== How versioning works ====

* <code>2.2.9</code> is newer than <code>2.2.1</code>
* <code>2.2.10</code> is newer than <code>2.2.1</code>
* <code>2.3.0</code> is newer than <code>2.2.9</code>
* <code>2.2.1</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1</code> is newer than <code>2.2.1~beta</code>
* <code>2.2.1~beta</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1~beta3</code> is newer than <code>2.2.1~beta2</code>
* <code>2.2.1~beta10</code> is newer than <code>2.2.1~beta1</code>

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

== <requires> ==

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.

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 <code><requires></code> block that imports two required modules:

<source lang="xml">
<requires>
<import addon="xbmc.python" version="2.14.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10"/>
</requires>
</source>

Here's another example, which will only install on OpenELEC:

<source lang="xml">
<requires>
<import addon="os.openelec.tv" version="2.0"/>
</requires>
</source>

== <import> ==

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

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.

=== addon attribute ===

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

=== version attribute ===

The <code>version</code> 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 <code>xbmc.*</code> add-on dependencies to control on which version of Kodi the add-on can be installed.

{| class="prettytable" border="1"
|+ Current versions
! Kodi version !! xbmc.python !! xbmc.gui !! xbmc.json !! xbmc.metadata !! xbmc.addon
|-
| Dharma 10.1 <font color="red">Deprecated</font>|| 1.0 || 2.11 || 2.0|| 1.0 || 0.1
|-
| Eden 11.0 <font color="red">Deprecated</font> || 2.0 || 3.0 || 4.0 || 1.0 || 11.0
|-
| Frodo 12.x <font color="red">Deprecated</font>|| 2.1.0 || 4.0.0 || 6.0.0 || 2.1.0 || 12.0.0
|-
| Gotham 13.x || 2.14.0 (ABI 2.1.0) || 5.0.1 || 6.6.0 (ABI 6.0.0) || 2.1.0 || 13.0.0 (ABI 12.0.0)
|-
| Helix 14.x || 2.19.0 (ABI 2.1.0) || 5.3.0 || 6.20.0 (ABI 6.0.0) || 2.1.0 || 14.0.0 (ABI 12.0.0)
|-
| 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 || 15.0.0 (ABI 12.0.0)
|-
| Jarvis 16.x || 2.24.0 (ABI 2.1.0) || 5.10.0 || 6.32.1 (ABI 6.0.0) || 2.1.0 || 16.0.0 (ABI 12.0.0)
|}

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

== <extension> ==

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.

The various extension points that Kodi provides are given in the list below.
{| class="prettytable"
!Extension point
!Add-on Category
|-
|<code>[[Skinning|xbmc.gui.skin]]</code>
|Skin
|-
|<code>xbmc.gui.webinterface</code>
|Web interface
|-
|<code>[[Add-on repositories|xbmc.addon.repository]]</code>
|''None''
|-
|<code>[[HOW-TO:_Automatically_start_addons_using_services|xbmc.service]]</code>
|Services
|-
|<code>xbmc.metadata.scraper.albums</code>
|Album information
|-
|<code>xbmc.metadata.scraper.artists</code>
|Artist information
|-
|<code>xbmc.metadata.scraper.movies</code>
|Movie information
|-
|<code>xbmc.metadata.scraper.musicvideos</code>
|Music video information
|-
|<code>xbmc.metadata.scraper.tvshows</code>
|TV information
|-
|<code>xbmc.metadata.scraper.library</code>
|''None''
|-
|<code>xbmc.ui.screensaver</code>
|Screensaver
|-
|<code>xbmc.player.musicviz</code>
|Visualization
|-
|<code>[[Plugin sources#What Kodi requires for your add-on|xbmc.python.pluginsource]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>[[Script sources#What Kodi requires for your add-on|xbmc.python.script]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>xbmc.python.weather</code>
|Weather
|-{{Gotham row}}
|<code>[[Script Subtitles#What Kodi requires for your add-on|xbmc.python.subtitles]]</code>
|'''([[:Category:Gotham feature|Future Gotham removal]])''' Subtitles
|-{{Gotham row}}
|<code>xbmc.subtitle.module</code>
|'''([[:Category:Gotham feature|Future Gotham addition]])''' Subtitle service module
|-
|<code>[[Script lyrics#What Kodi requires for your add-on|xbmc.python.lyrics]]</code>
|Lyrics
|-
|<code>[[Script library#What Kodi requires for your add-on|xbmc.python.library]]</code>
|''None''
|-
|<code>xbmc.python.module</code>
|These don't show up in the addon browser and are purely as support for other scripts.
|-
|<code>xbmc.addon.video</code>
|Video Add-ons (video)
|-
|<code>xbmc.addon.audio</code>
|Music Add-ons (audio)
|-
|<code>xbmc.addon.image</code>
|Picture Add-ons (image)
|-
|<code>kodi.resource.images</code>
|Additional image files
|-
|<code>kodi.resource.language</code>
|Additional language files
|}

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 ===
{{See also|Plugin sources}}

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

==== library attribute ====

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.

==== <provides> element ====

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:

{| class="prettytable"
!Provides
!Appears in
|-
|<code>image</code>
|Pictures
|-
|<code>audio</code>
|Music
|-
|<code>video</code>
|Video
|-
|<code>executable</code>
|Programs
|-
|''(blank)''
|Not visible
|}

==== Example ====

<source lang="xml">
<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py">
<provides>audio video</provides>
</extension>
</source>

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

==== Required elements ====

There are several elements that this should contain and all are compulsory (except the broken tag). Each of the elements below 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. See the [[List of language codes (ISO-639:1988)]] for possible language strings. If there's no <code>lang</code> attribute for a translatable element, it defaults to English. However, even for English, adding the <code>lang</code> attribute is recommended.

===== <summary> =====

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.

<source lang="xml">
<summary lang="en">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

===== <description> =====

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.

<source lang="xml">
<description lang="en">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>
</source>

===== <platform> =====

The <code><platform></code> tag specifies which platforms (operating systems, hardware) 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:

* <code>all</code>
* <code>linux</code>
* <code>osx</code>
* <code>osx64</code>
* <code>osx32</code>
* <code>ios</code>
* <code>windx</code>
* <code>android</code>

<source lang="xml">
<platform>all</platform>
</source>

===== <language> =====

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, leave it blank.

<source lang="xml">
<language>en de fr</language>
or
<language></language>
</source>

===== <license> =====

The <code><license></code> element indicates what license is used for this add-on.

<source lang="xml">
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
</source>

===== <forum> =====

The <code><forum></code> element provides the forum thread URL for this specific add-on. Leave this blank if there is no forum thread.
<source lang="xml">
<forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum>
</source>

===== <website> =====

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

<source lang="xml">
<website>http://www.myaddonwebsite.com/</website>
</source>

===== <nowiki><source></nowiki> =====

The <code><nowiki><source></nowiki></code> element provides the URL for the source code for this specific add-on.
<syntaxhighlight lang="xml" enclose="div">
<source>http://github.com/someone/myaddon</source>
</syntaxhighlight>

===== <email> =====

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.
<source lang="xml">
<email>foo@bar.com</email>
or
<email>foo at bar dot com</email>
</source>

===== <disclaimer> =====

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.

<source lang="xml">
<disclaimer lang="en">Feel free to use this script. For information visit the wiki.</disclaimer>
</source>

===== <broken> =====

The <code><broken></code> tag will mark the add-on as broken in the Kodi repo and provide the reason why. You don't need to do a version bump for this to work. However a bump is recommended as you could also add this to the changelog.

<source lang="xml">
<broken>deprecated</broken>
</source>

== Skin specific elements ==
=== Overview ===
{| class="prettytable"
| '''effectslowdown'''
| 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.
|-
| '''debugging'''
| When set to true, it'll display onscreen debug information (xml filename, mouse position and focused control type and name) in the skin.
|-
| '''res'''
| Support for arbitrary skin resolutions.
|}

=== How window xml files are found ===

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.

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

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

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

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.

= Examples =

== addon.xml for skins ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<addon
id="skin.confluence"
version="2.1.3"
name="Confluence"
provider-name="Jezz_X, Team Kodi">
<requires>
<import addon="xbmc.gui" version="4.0.0"/>
</requires>
<extension
point="xbmc.gui.skin"
debugging="false"
effectslowdown="0.75">
<res width="1280" height="720" aspect="16:9" default="true" folder="720p" />
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Confluence skin by Jezz_X. (Kodi's default skin)</summary>
<description lang="en">Confluence is the default skin for Kodi 9.11 and above. It is a combination of concepts from many popular skins, and attempts to embrace and integrate their good ideas into a skin that should be easy for first time Kodi users to understand and use.</description>
<disclaimer lang="en">Confluence is the default skin for Kodi, removing it may cause issues</disclaimer>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>
One thing to note is that <font color="red">all tag names are lower case.</font> XML tag names are case sensitive!

== addon.xml for scripts ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon
id="script.artwork.downloader"
name="Artwork Downloader"
version="12.0.12"
provider-name="Martijn">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
<import addon="xbmc.json" version="6.0.0"/>
<import addon="xbmc.addon" version="12.0.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10" optional="true"/>
<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.service" library="service.py" start="login"/>
<extension point="xbmc.addon.metadata">
<summary lang="en">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary>
<description lang="en">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">For bugs, requests or general questions visit the Artwork Downloader thread on the Kodi forum.</disclaimer>
<language></language>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

= Schema Definition =

The XML schema definition for <code>addon.xml</code> is located [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.addon/metadata.xsd here].

{{frodo updated}}

[[Category:Add-on development]]
[[Category:Skin development]]

Addon.xml

2015-12-28T08:54:54Z

Martijn: Undo revision 111209 by Martijn (talk)

{{mininav|[[Development]]|[[Add-on development]]}}
<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.

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

<syntaxhighlight lang="xml" enclose="div">
<?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.1.0"/>
</requires>
<extension point="xbmc.python.pluginsource" library="addon.py">
<provides>video</provides>
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Your add-on's summary</summary>
<description lang="en">Your add-on's description</description>
<disclaimer lang="en"></disclaimer>
<language></language>
<platform>all</platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

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

* The <code><addon></code> element must be present, and be the root node. It presents data about the add-on package as a whole.
* 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.
* Then there are one or more <code><extension></code> elements, each of which describes a part of Kodi that the add-on extends.
* Finally, there is a specific <code><extension></code> element that extends <code>"xbmc.addon.metadata"</code>. This describes the add-on to the user.

= Elements =

== <addon> ==

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:

<source lang="xml">
<addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2">
</source>

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

==== How versioning works ====

* <code>2.2.9</code> is newer than <code>2.2.1</code>
* <code>2.2.10</code> is newer than <code>2.2.1</code>
* <code>2.3.0</code> is newer than <code>2.2.9</code>
* <code>2.2.1</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1</code> is newer than <code>2.2.1~beta</code>
* <code>2.2.1~beta</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1~beta3</code> is newer than <code>2.2.1~beta2</code>
* <code>2.2.1~beta10</code> is newer than <code>2.2.1~beta1</code>

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

== <requires> ==

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.

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 <code><requires></code> block that imports two required modules and one optional one:

<source lang="xml">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10" optional="true"/>
</requires>
</source>

Here's another example, which will only install on OpenELEC:

<source lang="xml">
<requires>
<import addon="os.openelec.tv" version="2.0" optional="false"/>
</requires>
</source>

== <import> ==

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

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.

=== addon attribute ===

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

=== version attribute ===

The <code>version</code> 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 <code>xbmc.*</code> add-on dependencies to control on which version of Kodi the add-on can be installed.

{| class="prettytable" border="1"
|+ Current versions
! Kodi version !! xbmc.python !! xbmc.gui !! xbmc.json !! xbmc.metadata !! xbmc.addon
|-
| Dharma 10.1 <font color="red">Deprecated</font>|| 1.0 || 2.11 || 2.0|| 1.0 || 0.1
|-
| Eden 11.0 <font color="red">Deprecated</font> || 2.0 || 3.0 || 4.0 || 1.0 || 11.0
|-
| Frodo 12.x <font color="red">Deprecated</font>|| 2.1.0 || 4.0.0 || 6.0.0 || 2.1.0 || 12.0.0
|-
| Gotham 13.x || 2.1.0 > 2.14.0 || 5.0.1 || 6.0.0 > 6.6.0 || 2.1.0 || 13.0.0
|-
| Helix 14.x || 2.1.0 > 2.19.0 || 5.3.0 || 6.0.0 > 6.20.0 || 2.1.0 || 14.0.0
|-
| Isengard 15.x || 2.1.0 > 2.20.0 || 5.3.0 > 5.9.0 || 6.0.0 > 6.25.1 || 2.1.0 || 15.0.0
|-
| Jarvis 16.x || 2.1.0 > 2.24.0 || 5.10.0 || 6.0.0 > 6.32.1 || 2.1.0 || 16.0.0
|}

=== optional attribute ===

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.

== <extension> ==

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.

The various extension points that Kodi provides are given in the list below.
{| class="prettytable"
!Extension point
!Add-on Category
|-
|<code>[[Skinning|xbmc.gui.skin]]</code>
|Skin
|-
|<code>xbmc.gui.webinterface</code>
|Web interface
|-
|<code>[[Add-on repositories|xbmc.addon.repository]]</code>
|''None''
|-
|<code>[[HOW-TO:_Automatically_start_addons_using_services|xbmc.service]]</code>
|Services
|-
|<code>xbmc.metadata.scraper.albums</code>
|Album information
|-
|<code>xbmc.metadata.scraper.artists</code>
|Artist information
|-
|<code>xbmc.metadata.scraper.movies</code>
|Movie information
|-
|<code>xbmc.metadata.scraper.musicvideos</code>
|Music video information
|-
|<code>xbmc.metadata.scraper.tvshows</code>
|TV information
|-
|<code>xbmc.metadata.scraper.library</code>
|''None''
|-
|<code>xbmc.ui.screensaver</code>
|Screensaver
|-
|<code>xbmc.player.musicviz</code>
|Visualization
|-
|<code>[[Plugin sources#What Kodi requires for your add-on|xbmc.python.pluginsource]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>[[Script sources#What Kodi requires for your add-on|xbmc.python.script]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>xbmc.python.weather</code>
|Weather
|-{{Gotham row}}
|<code>[[Script Subtitles#What Kodi requires for your add-on|xbmc.python.subtitles]]</code>
|'''([[:Category:Gotham feature|Future Gotham removal]])''' Subtitles
|-{{Gotham row}}
|<code>xbmc.subtitle.module</code>
|'''([[:Category:Gotham feature|Future Gotham addition]])''' Subtitle service module
|-
|<code>[[Script lyrics#What Kodi requires for your add-on|xbmc.python.lyrics]]</code>
|Lyrics
|-
|<code>[[Script library#What Kodi requires for your add-on|xbmc.python.library]]</code>
|''None''
|-
|<code>xbmc.python.module</code>
|These don't show up in the addon browser and are purely as support for other scripts.
|-
|<code>xbmc.addon.video</code>
|Video Add-ons (video)
|-
|<code>xbmc.addon.audio</code>
|Music Add-ons (audio)
|-
|<code>xbmc.addon.image</code>
|Picture Add-ons (image)
|-
|<code>kodi.resource.images</code>
|Additional image files
|-
|<code>kodi.resource.language</code>
|Additional language files
|}

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 ===
{{See also|Plugin sources}}

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

==== library attribute ====

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.

==== <provides> element ====

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:

{| class="prettytable"
!Provides
!Appears in
|-
|<code>image</code>
|Pictures
|-
|<code>audio</code>
|Music
|-
|<code>video</code>
|Video
|-
|<code>executable</code>
|Programs
|-
|''(blank)''
|Not visible
|}

==== Example ====

<source lang="xml">
<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py">
<provides>audio video</provides>
</extension>
</source>

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

==== Required elements ====

There are several elements that this should contain and all are compulsory (except the broken tag). Each of the elements below 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. See the [[List of language codes (ISO-639:1988)]] for possible language strings. If there's no <code>lang</code> attribute for a translatable element, it defaults to English. However, even for English, adding the <code>lang</code> attribute is recommended.

===== <summary> =====

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.

<source lang="xml">
<summary lang="en">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

===== <description> =====

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.

<source lang="xml">
<description lang="en">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>
</source>

===== <platform> =====

The <code><platform></code> tag specifies which platforms (operating systems, hardware) 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:

* <code>all</code>
* <code>linux</code>
* <code>osx</code>
* <code>osx64</code>
* <code>osx32</code>
* <code>ios</code>
* <code>windx</code>
* <code>android</code>

<source lang="xml">
<platform>all</platform>
</source>

===== <language> =====

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, leave it blank.

<source lang="xml">
<language>en de fr</language>
or
<language></language>
</source>

===== <license> =====

The <code><license></code> element indicates what license is used for this add-on.

<source lang="xml">
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
</source>

===== <forum> =====

The <code><forum></code> element provides the forum thread URL for this specific add-on. Leave this blank if there is no forum thread.
<source lang="xml">
<forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum>
</source>

===== <website> =====

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

<source lang="xml">
<website>http://www.myaddonwebsite.com/</website>
</source>

===== <nowiki><source></nowiki> =====

The <code><nowiki><source></nowiki></code> element provides the URL for the source code for this specific add-on.
<syntaxhighlight lang="xml" enclose="div">
<source>http://github.com/someone/myaddon</source>
</syntaxhighlight>

===== <email> =====

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.
<source lang="xml">
<email>foo@bar.com</email>
or
<email>foo at bar dot com</email>
</source>

===== <disclaimer> =====

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.

<source lang="xml">
<disclaimer lang="en">Feel free to use this script. For information visit the wiki.</disclaimer>
</source>

===== <broken> =====

The <code><broken></code> tag will mark the add-on as broken in the Kodi repo and provide the reason why. You don't need to do a version bump for this to work. However a bump is recommended as you could also add this to the changelog.

<source lang="xml">
<broken>deprecated</broken>
</source>

== Skin specific elements ==
=== Overview ===
{| class="prettytable"
| '''effectslowdown'''
| 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.
|-
| '''debugging'''
| When set to true, it'll display onscreen debug information (xml filename, mouse position and focused control type and name) in the skin.
|-
| '''res'''
| Support for arbitrary skin resolutions.
|}

=== How window xml files are found ===

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.

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

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

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

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.

= Examples =

== addon.xml for skins ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<addon
id="skin.confluence"
version="2.1.3"
name="Confluence"
provider-name="Jezz_X, Team Kodi">
<requires>
<import addon="xbmc.gui" version="4.0.0"/>
</requires>
<extension
point="xbmc.gui.skin"
debugging="false"
effectslowdown="0.75">
<res width="1280" height="720" aspect="16:9" default="true" folder="720p" />
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Confluence skin by Jezz_X. (Kodi's default skin)</summary>
<description lang="en">Confluence is the default skin for Kodi 9.11 and above. It is a combination of concepts from many popular skins, and attempts to embrace and integrate their good ideas into a skin that should be easy for first time Kodi users to understand and use.</description>
<disclaimer lang="en">Confluence is the default skin for Kodi, removing it may cause issues</disclaimer>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>
One thing to note is that <font color="red">all tag names are lower case.</font> XML tag names are case sensitive!

== addon.xml for scripts ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon
id="script.artwork.downloader"
name="Artwork Downloader"
version="12.0.12"
provider-name="Martijn">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
<import addon="xbmc.json" version="6.0.0"/>
<import addon="xbmc.addon" version="12.0.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10" optional="true"/>
<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.service" library="service.py" start="login"/>
<extension point="xbmc.addon.metadata">
<summary lang="en">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary>
<description lang="en">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">For bugs, requests or general questions visit the Artwork Downloader thread on the Kodi forum.</disclaimer>
<language></language>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

= Schema Definition =

The XML schema definition for <code>addon.xml</code> is located [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.addon/metadata.xsd here].

{{frodo updated}}

[[Category:Add-on development]]
[[Category:Skin development]]

Addon.xml

2015-12-28T08:41:46Z

Martijn: /* Dependency versions */

{{mininav|[[Development]]|[[Add-on development]]}}
<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.

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

<syntaxhighlight lang="xml" enclose="div">
<?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.1.0"/>
</requires>
<extension point="xbmc.python.pluginsource" library="addon.py">
<provides>video</provides>
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Your add-on's summary</summary>
<description lang="en">Your add-on's description</description>
<disclaimer lang="en"></disclaimer>
<language></language>
<platform>all</platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

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

* The <code><addon></code> element must be present, and be the root node. It presents data about the add-on package as a whole.
* 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.
* Then there are one or more <code><extension></code> elements, each of which describes a part of Kodi that the add-on extends.
* Finally, there is a specific <code><extension></code> element that extends <code>"xbmc.addon.metadata"</code>. This describes the add-on to the user.

= Elements =

== <addon> ==

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:

<source lang="xml">
<addon id="script.hello.world" name="Hello World" version="0.0.1" provider-name="Dev1, Dev2">
</source>

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

==== How versioning works ====

* <code>2.2.9</code> is newer than <code>2.2.1</code>
* <code>2.2.10</code> is newer than <code>2.2.1</code>
* <code>2.3.0</code> is newer than <code>2.2.9</code>
* <code>2.2.1</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1</code> is newer than <code>2.2.1~beta</code>
* <code>2.2.1~beta</code> is newer than <code>2.2.1~alpha</code>
* <code>2.2.1~beta3</code> is newer than <code>2.2.1~beta2</code>
* <code>2.2.1~beta10</code> is newer than <code>2.2.1~beta1</code>

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

== <requires> ==

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.

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 <code><requires></code> block that imports two required modules and one optional one:

<source lang="xml">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10" optional="true"/>
</requires>
</source>

Here's another example, which will only install on OpenELEC:

<source lang="xml">
<requires>
<import addon="os.openelec.tv" version="2.0" optional="false"/>
</requires>
</source>

== <import> ==

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

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.

=== addon attribute ===

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

=== version attribute ===

The <code>version</code> 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 <code>xbmc.*</code> add-on dependencies to control on which version of Kodi the add-on can be installed.

{| class="prettytable" border="1"
|+ Current versions
! Kodi version !! xbmc.python !! xbmc.gui !! xbmc.json !! xbmc.metadata !! xbmc.addon
|-
| Dharma 10.1 <font color="red">Deprecated</font>|| 1.0 || 2.11 || 2.0|| 1.0 || 0.1
|-
| Eden 11.0 <font color="red">Deprecated</font> || 2.0 || 3.0 || 4.0 || 1.0 || 11.0
|-
| Frodo 12.x <font color="red">Deprecated</font>|| 2.1.0 || 4.0.0 || 6.0.0 || 2.1.0 || 12.0.0
|-
| Gotham 13.x || 2.14.0 || 5.0.1 || 6.6.0 || 2.1.0 || 13.0.0
|-
| Helix 14.x || 2.19.0 || 5.3.0 || 6.20.0 || 2.1.0 || 14.0.0
|-
| Isengard 15.x || 2.20.0 || 5.9.0 || 6.25.1 || 2.1.0 || 15.0.0
|-
| Jarvis 16.x || 2.24.0 || 5.10.0 || 6.32.1 || 2.1.0 || 16.0.0
|}

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 not that this might change in the future.

=== optional attribute ===

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.

== <extension> ==

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.

The various extension points that Kodi provides are given in the list below.
{| class="prettytable"
!Extension point
!Add-on Category
|-
|<code>[[Skinning|xbmc.gui.skin]]</code>
|Skin
|-
|<code>xbmc.gui.webinterface</code>
|Web interface
|-
|<code>[[Add-on repositories|xbmc.addon.repository]]</code>
|''None''
|-
|<code>[[HOW-TO:_Automatically_start_addons_using_services|xbmc.service]]</code>
|Services
|-
|<code>xbmc.metadata.scraper.albums</code>
|Album information
|-
|<code>xbmc.metadata.scraper.artists</code>
|Artist information
|-
|<code>xbmc.metadata.scraper.movies</code>
|Movie information
|-
|<code>xbmc.metadata.scraper.musicvideos</code>
|Music video information
|-
|<code>xbmc.metadata.scraper.tvshows</code>
|TV information
|-
|<code>xbmc.metadata.scraper.library</code>
|''None''
|-
|<code>xbmc.ui.screensaver</code>
|Screensaver
|-
|<code>xbmc.player.musicviz</code>
|Visualization
|-
|<code>[[Plugin sources#What Kodi requires for your add-on|xbmc.python.pluginsource]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>[[Script sources#What Kodi requires for your add-on|xbmc.python.script]]</code>
|Music Add-ons (audio) / Picture Add-ons (image) / Program Add-ons (executable) / Video Add-ons (video)
|-
|<code>xbmc.python.weather</code>
|Weather
|-{{Gotham row}}
|<code>[[Script Subtitles#What Kodi requires for your add-on|xbmc.python.subtitles]]</code>
|'''([[:Category:Gotham feature|Future Gotham removal]])''' Subtitles
|-{{Gotham row}}
|<code>xbmc.subtitle.module</code>
|'''([[:Category:Gotham feature|Future Gotham addition]])''' Subtitle service module
|-
|<code>[[Script lyrics#What Kodi requires for your add-on|xbmc.python.lyrics]]</code>
|Lyrics
|-
|<code>[[Script library#What Kodi requires for your add-on|xbmc.python.library]]</code>
|''None''
|-
|<code>xbmc.python.module</code>
|These don't show up in the addon browser and are purely as support for other scripts.
|-
|<code>xbmc.addon.video</code>
|Video Add-ons (video)
|-
|<code>xbmc.addon.audio</code>
|Music Add-ons (audio)
|-
|<code>xbmc.addon.image</code>
|Picture Add-ons (image)
|-
|<code>kodi.resource.images</code>
|Additional image files
|-
|<code>kodi.resource.language</code>
|Additional language files
|}

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 ===
{{See also|Plugin sources}}

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

==== library attribute ====

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.

==== <provides> element ====

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:

{| class="prettytable"
!Provides
!Appears in
|-
|<code>image</code>
|Pictures
|-
|<code>audio</code>
|Music
|-
|<code>video</code>
|Video
|-
|<code>executable</code>
|Programs
|-
|''(blank)''
|Not visible
|}

==== Example ====

<source lang="xml">
<extension point="xbmc.python.pluginsource" library="gpodderxbmc.py">
<provides>audio video</provides>
</extension>
</source>

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

==== Required elements ====

There are several elements that this should contain and all are compulsory (except the broken tag). Each of the elements below 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. See the [[List of language codes (ISO-639:1988)]] for possible language strings. If there's no <code>lang</code> attribute for a translatable element, it defaults to English. However, even for English, adding the <code>lang</code> attribute is recommended.

===== <summary> =====

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.

<source lang="xml">
<summary lang="en">Hello World script provides some basic examples on how to create your first script.</summary>
</source>

===== <description> =====

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.

<source lang="xml">
<description lang="en">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>
</source>

===== <platform> =====

The <code><platform></code> tag specifies which platforms (operating systems, hardware) 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:

* <code>all</code>
* <code>linux</code>
* <code>osx</code>
* <code>osx64</code>
* <code>osx32</code>
* <code>ios</code>
* <code>windx</code>
* <code>android</code>

<source lang="xml">
<platform>all</platform>
</source>

===== <language> =====

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, leave it blank.

<source lang="xml">
<language>en de fr</language>
or
<language></language>
</source>

===== <license> =====

The <code><license></code> element indicates what license is used for this add-on.

<source lang="xml">
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
</source>

===== <forum> =====

The <code><forum></code> element provides the forum thread URL for this specific add-on. Leave this blank if there is no forum thread.
<source lang="xml">
<forum>http://www.myaddonwebsite.com/forum.php?thread=12345</forum>
</source>

===== <website> =====

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

<source lang="xml">
<website>http://www.myaddonwebsite.com/</website>
</source>

===== <nowiki><source></nowiki> =====

The <code><nowiki><source></nowiki></code> element provides the URL for the source code for this specific add-on.
<syntaxhighlight lang="xml" enclose="div">
<source>http://github.com/someone/myaddon</source>
</syntaxhighlight>

===== <email> =====

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.
<source lang="xml">
<email>foo@bar.com</email>
or
<email>foo at bar dot com</email>
</source>

===== <disclaimer> =====

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.

<source lang="xml">
<disclaimer lang="en">Feel free to use this script. For information visit the wiki.</disclaimer>
</source>

===== <broken> =====

The <code><broken></code> tag will mark the add-on as broken in the Kodi repo and provide the reason why. You don't need to do a version bump for this to work. However a bump is recommended as you could also add this to the changelog.

<source lang="xml">
<broken>deprecated</broken>
</source>

== Skin specific elements ==
=== Overview ===
{| class="prettytable"
| '''effectslowdown'''
| 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.
|-
| '''debugging'''
| When set to true, it'll display onscreen debug information (xml filename, mouse position and focused control type and name) in the skin.
|-
| '''res'''
| Support for arbitrary skin resolutions.
|}

=== How window xml files are found ===

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.

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

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

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

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.

= Examples =

== addon.xml for skins ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<addon
id="skin.confluence"
version="2.1.3"
name="Confluence"
provider-name="Jezz_X, Team Kodi">
<requires>
<import addon="xbmc.gui" version="4.0.0"/>
</requires>
<extension
point="xbmc.gui.skin"
debugging="false"
effectslowdown="0.75">
<res width="1280" height="720" aspect="16:9" default="true" folder="720p" />
</extension>
<extension point="xbmc.addon.metadata">
<summary lang="en">Confluence skin by Jezz_X. (Kodi's default skin)</summary>
<description lang="en">Confluence is the default skin for Kodi 9.11 and above. It is a combination of concepts from many popular skins, and attempts to embrace and integrate their good ideas into a skin that should be easy for first time Kodi users to understand and use.</description>
<disclaimer lang="en">Confluence is the default skin for Kodi, removing it may cause issues</disclaimer>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>
One thing to note is that <font color="red">all tag names are lower case.</font> XML tag names are case sensitive!

== addon.xml for scripts ==

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon
id="script.artwork.downloader"
name="Artwork Downloader"
version="12.0.12"
provider-name="Martijn">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
<import addon="xbmc.json" version="6.0.0"/>
<import addon="xbmc.addon" version="12.0.0"/>
<import addon="script.module.elementtree" version="1.2.7"/>
<import addon="script.module.simplejson" version="2.0.10" optional="true"/>
<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.service" library="service.py" start="login"/>
<extension point="xbmc.addon.metadata">
<summary lang="en">Downloads Artwork for TV shows, Movies and Musicvideos in your library</summary>
<description lang="en">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">For bugs, requests or general questions visit the Artwork Downloader thread on the Kodi forum.</disclaimer>
<language></language>
<platform>all</platform>
<license>GNU GENERAL PUBLIC LICENSE. Version 2, June 1991</license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

= Schema Definition =

The XML schema definition for <code>addon.xml</code> is located [https://github.com/xbmc/xbmc/blob/master/addons/xbmc.addon/metadata.xsd here].

{{frodo updated}}

[[Category:Add-on development]]
[[Category:Skin development]]

Add-on structure

2015-12-28T08:39:32Z

Martijn: /* changelog.txt */

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

This page summarizes the add-ons system introduced in the Dharma release (v10) of XBMC. This system allows 3rd party-developed enhancements to Kodi to be distributed to Kodi users directly from inside the Kodi interface.

The add-ons system is based on the plugin library [http://www.c-pluff.org c-pluff].

== Introduction ==

Each add-on is kept in its own folder, and is described via an XML file named <code>addon.xml</code>. In addition, some other files can also come with the add-on, such as <code>icon.png</code>, <code>changelog.txt</code>, and <code>fanart.jpg</code>. These are all optional, though we encourage you to at least have <code>icon.png</code>. All of these reside in the "root" of the folder that contains the add-on. Additional data may be contained within a <code>resources/</code> subfolder, such as language translations and descriptions of settings.

When installed, the whole add-on folder will be placed inside <code>.xbmc/addons/</code>.

== Directory Name ==

Your directory name should follow this convention: <code><addon-type>[.<media-type>].<your-plugin-name></code>

Each name part is case sensitive and must be in lower case. The dot character separates each name part; you can use further dots to separate things in your plugin name if you wish. Alternatively, you may use a hyphen (-). No other non-alphanumeric characters should be used.

<code>addon-type</code> is one of the following:

{| class="prettytable" border="1"
!Add-on Type
!Description
!Media Type Required?
|-
|<code>repository</code>
|A repository definition file that allows users to add new repositories to the Kodi addon manager.
|No
|-
|<code>plugin</code>
|A plugin script or module that adds to the functionality of XBMC. Plugins appear under the relevant media section of the main home menu.
|'''Yes'''
|-
|<code>script</code>
|A runnable program file that will appear in the Program section of the main home menu.
|'''Yes'''
|-
|<code>skin</code>
|An Kodi skin definition and its supporting script files.
|No
|-
|<code>resource</code>
|An addon that will provide additional files (language files, images, [[sounds.xml|uisounds]]).
|No
|}

The following table describes the available <code>media-type</code>s for the available add-on types. Your add-on may provide more than one <code>media-type</code> if
you wish, whereby it will appear in more than one section. In most cases, however, a single media type will suffice, and it may be preferable to have multiple add-ons each providing a single media type rather than one add-on that tries to do it all.

{| class="prettytable" border="1"
!Add-on Type
!Media Type
! Description
|-
|<code>plugin</code>
|<code>audio</code>
|A music add-on that will appear in the Music main menu.
|-
|<code>plugin</code>
|<code>video</code>
|A video add-on that will appear in the Video main menu.
|-
|<code>plugin</code>
|<code>picture</code>
|A picture add-on that will appear in the Pictures main menu.
|-
|<code>plugin</code>
|<code>weather</code>
|A weather add-on that will appear in the Weather main menu.
|-
|<code>script</code>
|<code>module</code>
|A script plugin that will not appear under a category or within the Add-ons manager, but provides support for other add-ons.
|-
|<code>script</code>
|<code>service</code>
|A script that will be run at either login or startup
|}

The add-on name is up to you, but be sure that it isn't already in use by another add-on. For instance, if you are creating an add-on that integrates the Gpodder software with Kodi for audio podcasts you might name your directory <code>plugin.audio.gpodder-xbmc3</code>. If you are creating a screen scraper to present TV shows from MyGreatTv.com. It might be <code>plugin.video.my-great-tv-com</code>. A script to ping all your friends on twitter to tell them you are home might be called
<code>script.service.ping-twits-i-am-home</code>.

== Directory structure ==

Your directory contains all the resources needed to operate your add-on. The directory must be considered read-only and should not be used for storing transient or inter-session data. Other mechanisms are available to do that (more later). The directory should be structured as follows:

addon.py
addon.xml
changelog.txt
fanart.jpg
icon.png
LICENSE.txt
resources/
settings.xml
language/
lib/
data/
media/

Other files may be required to run your add-on, if your add-on becomes more complex. It is considered good practice to place various add-on resources and support code modules in the <code>lib/</code> folder. If those libs are commonly used by multiple add-ons, consider adding them as a separate add-on, e.g. <code>script.module.foo</code>.

The most important thing to remember from this is that everything that doesn't need to be in the root of your directory is considered a resource and should be placed inside <code>resources/</code> or one of its subdirectories. Also remember, all the above is a ''recommended'' outline for your add-on; if you need fewer or more
directories to organise your work, just change it. For instance, skins are add-ons that will require more directories than this.

=== addon.py ===

This will contain the main Python code for your add-on. You can name it whatever you want, since you'll define this Python file in <code>[[addon.xml]]</code> as your main script file.

=== addon.xml ===
{{See also|addon.xml}}

<code>addon.xml</code> gives Kodi important metadata about your add-on, such as:
* what the add-on provides
* what the add-on relies on to work
* what script to run when it is fired up (if it is meant to be started)

=== changelog.txt ===

A text file that contains a description of the changes you make to the add-on for each release. This is displayed in the Kodi addon installation/update system. The recommended format is to have it sorted by version in descending order, with a simple description as to the major changes (new functionality, big fixes, etc) in each version. (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.)

Here is a sample
<code>changelog.txt:

v0.1.3 (2015-12-25)
- Update with 15.0 Isengard

v0.1.2 (2014-1-15)
- Add notification for Ubuntu users checking through apt command

v0.1.1 (2014-1-1)
- Initial version
</code>

It is recommend to add a date so users know when last update was done. Best is to use YYYY-MM-DD as this is the least confusing way of dat notation.

=== icon.png ===

This is an icon used to represent your add-on in various parts of XBMC. In order to keep a coherent look and give the skinner a good idea how the icons of the add-ons look, we have defined the following rules:

* The icon size must be 256x256 pixels.
* File format is PNG.
* Background must be 100% solid. That doesn't mean one color, it also can be a gradient or a low contrast texture. Just make sure there is no transparency.
* Keep the logo as simple a possible, no exaggerated 3D effects or high contrast textures.
* Use a padding of at least 25px for your logo (not the background!). Excepted are large text logos (see icon for themoviedb.org).
* Keep text to a minimum. However, a text logo along with the graphical logo is recommended in order to easily recognize the addon.
* Don't mix logos with XBMC's logo; it's obvious that we're talking about Kodi here.
* Don't add borders or any overlays, that's the skinner's job. However, if borders are an element of your logo, make sure there is enough padding.
* It is suggested that a logo on a plain background (non-transparent) is best in many situations (e.g. for addons that retrieve media from an online service, use that service's logo ''as long as you are free to do so'').

=== fanart.jpg ===

This helps to keep Kodi graphically rich when browsing and using add-ons. Some simple guidelines:

* It should be 16:9 aspect ratio
* It is intended for the background, so should be simple and without text where reasonable.
* We recommend a 1280x720 JPEG image. It should certainly be no larger than 1920x1080.
* We recommend keeping it as small as is reasonable with respect to file-size. Remember that hundreds of thousands of users are going to be downloading this.

=== LICENSE.txt ===
{{See also|Submitting_Add-ons#Repository_Submission_Guidelines_-_Please_Read_Before_Submitting_Your_Addon|label 1=Repository guidelines}}

This file should contain the text of whatever software license you've chosen to release your add-on under (e.g. GPLv2).

=== resources/ ===

The <code>resources/</code> subdirectory is the preferred place to put any files that the add-on uses that don't need to be stored in the root directory. For instance, translations, software libraries, and image resources would go in <code>resources/</code> or one of its subdirectories.

==== resources/settings.xml ====
{{See also|Add-on settings}}

This is an XML file that defines the user-configurable settings used by the add-on. The file defines the names and types of the settings, and how they should appear in the settings dialog for the add-on.

==== resources/language/ ====

'''Translation tools:'''
* [[Language support]]
* [[Translation System]]
* Convert .xml to .po: [https://github.com/alanwww1/xbmc-xml2po xbmc-xml2po]
* Check for .po files: [https://github.com/alanwww1/xbmc-checkpo xbmc-checkpo]
* Utility for keeping Kodi upstream language files and the language files hosted on transifex.com in sync: [https://github.com/alanwww1/xbmc-txupdate xbmc-txupdate]

'''String ID range:'''
* strings 30000 thru 30999 reserved for plugins and plugin settings
* strings 31000 thru 31999 reserved for skins
* strings 32000 thru 32999 reserved for scripts
* strings 33000 thru 33999 reserved for common strings used in add-ons

'''strings.po'''

{{note|strings.xml will possibly be deprecated after the release of Frodo/Gotham. Frodo and Gotham will still be backwards compatible with .xml}}

==== resources/lib/ ====

Put any module definitions or third party software libraries into this directory.

==== resources/data/ ====

Store any other static data structures your application requires here. Examples might be
XLT/XSD files or static XML files that contain lookup tables etc.

==== resources/media/ ====

Store any static media (picture, audio, video etc.) files in this directory.

== Getting started ==

Following pages will explain in more depth to get started. Providing examples, background information and useful links.

* [[Python development]]
* [[Skinning]]

== See also ==
* [[Add-ons]]
* [[:Category:All add-ons]]
* [[3rd party add-on repositories]]
'''Development:'''
* [[Add-on development]]
* [[Addon Settings]]
* [[Python development]]
* [[Skinning]]
* [[Add-on repositories]]
* [[Official add-on repository]]

[[Category:Add-on development]]

HOW-TO:Install Kodi for Windows

2015-12-26T15:37:48Z

Martijn:

{{mininav| [[Windows]] }}

{{Kodi migration note}}

== Installing of {{kodi}} for Windows ==

The installation of {{kodi}} for Windows is straightforward like most other Windows applications.

Download the latest version from [http://kodi.tv/download/ http://kodi.tv/download/]. After download open the .exe file after which you will get the installation dialog. Simply follow the shown installation screen after which the installation will begin. For most users the offered default settings are sufficient, if not, change them accordingly if you are sure you have to.

{{youtube|pfV9Z691n40}}

If you have [https://chocolatey.org/ Chocolatey] installed you can run <pre>cinst xbmc</pre> from an elevated command line or powershell instance.

After the installation you can immediately start using Kodi. To start Kodi, find it under the Windows '''Start''' button in a '''Program Group''' called '''Kodi'''. or simply use the desktop icon.

You can use the keyboard, mouse or remote control to navigate through the program. Add one or more sources in Videos, Music and/or Photos, see [[Media Sources]] and you are ready to play your media. For more information you can visit the main [[Main Page|wiki page]].

== Uninstalling of {{kodi}} for Windows ==
Go to "''Add or Remove Programs''" in the "''Control Panel''" under Windows then choose to remove "''{{kodi}}''". You can also find it under the Windows '''Start''' button in a '''Program Group''' called '''Kodi'''.

== Upgrading {{kodi}} for Windows ==
Unless your copy of {{kodi}} is more than two years old, simply installing a newer version of {{kodi}} over an older version should cause no problems. If you are upgrading your copy of {{kodi}}, it is ALWAYS recommended that you backup your data: [[Backup]].

{{Helix updated}}

[[Category:Manual]]
[[Category:Installation|Windows]]
[[Category:Windows]]
[[Category:How-to]]

HOW-TO:Install Kodi for Android

2015-12-26T15:35:16Z

Martijn: /* Google Play */

{{mininav| [[Android]] }}
<section begin="intro" />This page describes how to install Kodi, either from an app "store" such as Google Play, or manually from an APK file.<section end="intro" />

= Installing Kodi from an app store =

== Google Play ==

Kodi is now available on Google Play:

{{Google Play}}<br />
'''https://play.google.com/store/apps/details?id=org.xbmc.kodi'''

Google Play will automatically select which version (ARM or x86) of Kodi you need, and will also automatically handle updates (unless you change your Google Play preferences).

{{isengard note|Initially, Kodi v15 Beta/Release Candidates are being posted on Google Play. Once the final "stable" version of v15 is released, then Google Play will only update for stable releases, like v15.0, v15.1, v16.0, etc. This is because current v15 "unstable" builds are actually a little more stable than v14.2 for Android users, due to the various Android-specific changes and fixes.}}

{{youtube|hmO_qVDoXCk}}

= Manual installation =

== Enabling installation ==
Here's how to install Kodi from an .APK file. This is commonly known as "sideloading".

<gallery widths="500px" heights="313">
File:Android install step01.jpg|{{big|'''Step 1:'''}} First located the settings menu on your Android device and search for the "security" menu.
File:Android install step02.jpg|{{big|'''Step 2:'''}} Now enable "Unknown sources" option. This will allow you to directly install Kodi as easy as you would install it from Play Store.
</gallery>

== Download ==
Download Kodi for Android from our servers. Official stable builds can be found here: '''http://kodi.tv/download/''' You need to either select the '''ARM''' or '''x86''' version depending on your hardware.
<gallery widths="500px" heights="313px">
File:Android_install_step03.png|{{big|'''Step 1:'''}} Load up '''http://kodi.tv/download/''' in your Android web browser. Most users will want to use the '''ARM''' link, unless you have an Intel or AMD CPU. You may get a warning trying to download the file depending on which browser you use. You should say "OK" to actually download it.
File:Android_install_step04.png|{{big|'''Step 2:'''}} Wait for the "apk" to download.
</gallery>

== Install ==
Installing the Kodi app package is as simple as just finding the .apk you just downloaded and opening it up. You can do this either though the download menu in the web browser or selecting it with a file explorer.

<gallery widths="500px" heights="313px">
File:Android install step05.png| {{big|'''Step 1:'''}} After selecting the Kodi apk file you might be asked to select something to open it with. "Package installer", "Google Play", or some similar option will be what you want.
File:Android install step06.png| {{big|'''Step 2:'''}} You will get another confirmation screen where you will need to select "install".
File:Android install step07.png| {{big|'''Step 3:'''}} Wait for the installation to complete.
File:Android install step08.png| {{big|'''Step 4:'''}} You've now installed Kodi for Android!
File:Android install step09.png| {{big|'''First run:'''}} The first time you run Kodi it will take slightly longer than normal in order to finish some final installation steps. When it is done Kodi will open normally. This is only done once per installation/update, so the next time Kodi will start up a little faster.
File:Android install step10.png| {{big|'''All done!:'''}} Once started you are on Kodi home menu just like on any other platform.
</gallery>

If you are new to Kodi you might wish to check out this section of the wiki: '''[[First time user]]'''.

== Tidy up ==

After Kodi has installed you can delete the downloaded Kodi APK file to save some disk space.

== Update ==
{{Kodi migration note}}

To update Kodi for Android simply follow the normal install steps with the newer version. All your settings and files will be preserved as they are located in a different place in the userdata folder. Be sure to make a backup of the userdata folder when doing updates in case something goes wrong.

{{note|Since Kodi for Android is signed with our own signatures you will be able to install all succeeding versions without a problem. If you are using a non-official version not signed by us you may be required to un-install Kodi and you will loose all your settings due to this. Be warned before trying.}}

== Uninstall ==

To un-install Kodi just go to your Android settings menu and select "apps". From there you will be able to un-install Kodi like any other Android app.

{{note|Unlike other OSes, uninstalling Kodi on Android will also erase your [[userdata folder]] and all of your settings.}}

<gallery widths="500px" heights="313px">
File:Android install step13.jpg| {{big|'''Step 1:'''}} Go into your Android "Settings" app and then select "Apps".
File:Android install step14.jpg| {{big|'''Step 2:'''}} Select Kodi from the list.
File:Android install step15.jpg| {{big|'''Step 3:'''}} Select uninstall and confirm.
</gallery>

== See also ==
* [[Android]]
* [[Android FAQ]]
* [[Android hardware]]

{{Isengard updated}}

[[Category:Manual]]
[[Category:Installation|Android]]
[[Category:Android]]
[[Category:How-to]]

Submitting Add-ons

2015-12-19T15:34:01Z

Martijn: /* Allowed submissions */

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

=== Submitting a Compliant Add-on to the Kodi.tv Repo ===

After you have read the [[Add-on rules|repository guidelines]] and made sure your addon is compliant with them, you may begin the submission process using the following steps.

=== Allowed submissions ===

We have restricted the allowed submissions of add-ons to past Kodi versions.
Several reasons:
* Kodi code improvements
* Reduce support load for add-on developers
* Reduce workload for repository maintainers

Below is a table of on which submissions are allowed to official Kodi repository.

{| class="prettytable" border="1"
|+ Allowed add-on submissions
! codename !! version !! update !! new
|-
| Dharma || 10.x || no || no
|-
| Eden || 11.x || no || no
|-
| Frodo || 12.x || no || no
|-
| Gotham || 13.x || yes || no
|-
| Helix || 14.x || yes || no
|-
| Isengard || 15.x || yes || yes
|-
| Jarvis || 16.x || yes || yes
|}

Additional feature is that we now use combined repositories. So if your add-on is Gotham/Helix compatible, you only need to send it to Gotham repository.
If it's only Helix compatible you need to send it to Helix repository.
This of course requires that the minimal Kodi dependencies are set accordingly.

{| class="prettytable" border="1"
|+ Which repos are used
! codename !! version !! repo !! repo !! repo !! repo
|-
| Dharma || 10.x || Dharma || || ||
|-
| Eden || 11.x || Eden || || ||
|-
| Frodo || 12.x || Frodo || || ||
|-
| Gotham || 13.x || Gotham || || ||
|-
| Helix || 14.x || Gotham || Helix || ||
|-
| Isengard || 15.x || Gotham || Helix || Isengard ||
|-
| Isengard || 15.x || Gotham || Helix || Isengard || Jarvis
|}

{{see also|Addon.xml#Dependency_versions}}

=== The mailing list ===
We ask that all Add-on authors subscribe to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List].
This is done for several reasons.
:* This is where all updates and important information will be announced.
:* This way we can contact you regarding your add-ons if necessary.
:* You can see what other devs are requesting to be added so you know if possibly you need to check compatibility of the add-on you depend on.
:* You may find new and interesting add-ons this way on which you can get inspiration from or may depend on.

After you have subscribed to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] you will be send a conformation e-mail. Be sure to accept this before you can submit to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Mailing List].

All pull requests should be sent to this list so that repository maintainers will be notified that you want to add of update your add-on. They will do a sanity check if all seems ok and you are following the Kodi guidelines for add-ons. If any issues or questions arise they will contact you through the e-mail you registered with.
Once all checks out fine your add-on is added to repository and you will receive a confirmation e-mail that it is added.

{{tip|To un-subscribe from the mailinglist follow the same link as [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] and there's the option to unsubscribe at the bottom}}

==== How to submit your add-on and subsequent updates ====

In order to submit your addon, you must send a request that we add or update your add-on to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] (We call this a "pull request."). Each request will require a version bump in the [[addon.xml]]. We ask that you also keep a [[Add-on structure#changelog.txt|changelog.txt]] up to date so that users may easily see what has changed.

Note that .xbt files will be generated automatically for skins so you do not include this in your pull request.

There are several ways to request that we add or update your add-on. Please preface threads using the following conventions:

{| class="prettytable" border="1"
! Type !! Description
|-
| [Git Pull]|| Submit a request that we pull from your repo. This should include a url, branch/tag/revision, and the addon to pull. HEAD is NOT a revision.
|-
| [SVN Pull]|| Same as [Git Pull]
|-
| [Zip Pull]|| By far the least used but still a valid way. Submit a link where the add-on zip can be downloaded from.
For example you can just give us the link to .zip in your dropbox account. We do not want to download it from a public download site that holds questionable content or is filled with ads.
|-
| [Patch]|| Sometimes you may wish to submit a patch to the author for review.
Under most circumstances we will not merge this directly, it should go to the upstream maintainer first.
|}

After you have send it to the mailing list please keep an eye out for any reply from our repository maintainers if there are any remarks or changes needed or a simple confirmation it has been added. Do note it might take some time to process the request.

After it has been added or updated it will be available from the Kodi repository in Kodi itself, on http://addons.kodi.tv/ and on the wiki page http://kodi.wiki/index.php?title=Category:All_add-ons.

{{Note|Please locate you add-on in the root of the git repository. This to make sure we can easily pull the add-on into our repository.
Example: https://github.com/XBMC-Addons/service.xbmc.versioncheck}}

==== Example e-mail ====

Subject:
[Git Pull] my.cool.plugin
Body:
*addon - my.cool.plugin
*version - 1.1.0
*url - git://some.where.git
*revision - a241345a
*branch - master
*xbmc version - helix

{{Note|If you want to request multiple add-ons to be added you can just do this in one e-mail as long as you provide the "Body" part each time for every add-on and every Kodi version you want it to be included to. In this case the subject field doesn't need to contain the add-on name. Do provide the "[Git Pull]" part at least.}}

{{tip|At this moment Frodo/Gotham/Helix combine all repos into one single repo list in Kodi. You only need to do a request for the minimum repo your add-on supports.}}

=== Github ===

Alternatively, add-on updates may be submitted directly to the [[Official add-on repository]] on Github as pull requests. In addition to the [[Add-on rules|repository guidelines]] the following rules apply when submitting PRs on Github:

* PR should contain one commit only.
* Commit message should have the format "[addonid] version". Example: "[my.cool.addon] 1.0.1"

As with mailing list, only PRs from add-on author will be accepted. Patches should be submitted upstream. For an easy way to create PR from your own git repository, see [[HOW-TO: create add-on PRs using Git Subtree Merging]].

[[Category:Add-on development]]

Submitting Add-ons

2015-12-19T15:32:31Z

Martijn: /* Allowed submissions */

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

=== Submitting a Compliant Add-on to the Kodi.tv Repo ===

After you have read the [[Add-on rules|repository guidelines]] and made sure your addon is compliant with them, you may begin the submission process using the following steps.

=== Allowed submissions ===

We have restricted the allowed submissions of add-ons to past Kodi versions.
Several reasons:
* Kodi code improvements
* Reduce support load for add-on developers
* Reduce workload for repository maintainers

Below is a table of on which submissions are allowed to official Kodi repository.

{| class="prettytable" border="1"
|+ Allowed add-on submissions
! codename !! version !! update !! new
|-
| Dharma || 10.x || no || no
|-
| Eden || 11.x || no || no
|-
| Frodo || 12.x || no || no
|-
| Gotham || 13.x || yes || no
|-
| Helix || 14.x || yes || no
|-
| Isengard || 15.x || yes || yes
|-
| Jarvis || 16.x || yes || yes
|}

Additional feature is that we now use combined repositories. So if your add-on is Gotham/Helix compatible, you only need to send it to Gotham repository.
If it's only Helix compatible you need to send it to Helix repository.
This of course requires that the minimal Kodi dependencies are set accordingly.

{| class="prettytable" border="1"
|+ Which repos are used
! codename !! version !! repo !! repo !! repo
|-
| Dharma || 10.x || Dharma || ||
|-
| Eden || 11.x || Eden || ||
|-
| Frodo || 12.x || Frodo || ||
|-
| Gotham || 13.x || Frodo || Gotham ||
|-
| Helix || 14.x || Gotham || Helix ||
|-
| Isengard || 15.x || Gotham || Helix || Isengard
|}

{{see also|Addon.xml#Dependency_versions}}

=== The mailing list ===
We ask that all Add-on authors subscribe to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List].
This is done for several reasons.
:* This is where all updates and important information will be announced.
:* This way we can contact you regarding your add-ons if necessary.
:* You can see what other devs are requesting to be added so you know if possibly you need to check compatibility of the add-on you depend on.
:* You may find new and interesting add-ons this way on which you can get inspiration from or may depend on.

After you have subscribed to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] you will be send a conformation e-mail. Be sure to accept this before you can submit to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Mailing List].

All pull requests should be sent to this list so that repository maintainers will be notified that you want to add of update your add-on. They will do a sanity check if all seems ok and you are following the Kodi guidelines for add-ons. If any issues or questions arise they will contact you through the e-mail you registered with.
Once all checks out fine your add-on is added to repository and you will receive a confirmation e-mail that it is added.

{{tip|To un-subscribe from the mailinglist follow the same link as [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] and there's the option to unsubscribe at the bottom}}

==== How to submit your add-on and subsequent updates ====

In order to submit your addon, you must send a request that we add or update your add-on to the [https://lists.sourceforge.net/lists/listinfo/xbmc-addons Add-ons Mailing List] (We call this a "pull request."). Each request will require a version bump in the [[addon.xml]]. We ask that you also keep a [[Add-on structure#changelog.txt|changelog.txt]] up to date so that users may easily see what has changed.

Note that .xbt files will be generated automatically for skins so you do not include this in your pull request.

There are several ways to request that we add or update your add-on. Please preface threads using the following conventions:

{| class="prettytable" border="1"
! Type !! Description
|-
| [Git Pull]|| Submit a request that we pull from your repo. This should include a url, branch/tag/revision, and the addon to pull. HEAD is NOT a revision.
|-
| [SVN Pull]|| Same as [Git Pull]
|-
| [Zip Pull]|| By far the least used but still a valid way. Submit a link where the add-on zip can be downloaded from.
For example you can just give us the link to .zip in your dropbox account. We do not want to download it from a public download site that holds questionable content or is filled with ads.
|-
| [Patch]|| Sometimes you may wish to submit a patch to the author for review.
Under most circumstances we will not merge this directly, it should go to the upstream maintainer first.
|}

After you have send it to the mailing list please keep an eye out for any reply from our repository maintainers if there are any remarks or changes needed or a simple confirmation it has been added. Do note it might take some time to process the request.

After it has been added or updated it will be available from the Kodi repository in Kodi itself, on http://addons.kodi.tv/ and on the wiki page http://kodi.wiki/index.php?title=Category:All_add-ons.

{{Note|Please locate you add-on in the root of the git repository. This to make sure we can easily pull the add-on into our repository.
Example: https://github.com/XBMC-Addons/service.xbmc.versioncheck}}

==== Example e-mail ====

Subject:
[Git Pull] my.cool.plugin
Body:
*addon - my.cool.plugin
*version - 1.1.0
*url - git://some.where.git
*revision - a241345a
*branch - master
*xbmc version - helix

{{Note|If you want to request multiple add-ons to be added you can just do this in one e-mail as long as you provide the "Body" part each time for every add-on and every Kodi version you want it to be included to. In this case the subject field doesn't need to contain the add-on name. Do provide the "[Git Pull]" part at least.}}

{{tip|At this moment Frodo/Gotham/Helix combine all repos into one single repo list in Kodi. You only need to do a request for the minimum repo your add-on supports.}}

=== Github ===

Alternatively, add-on updates may be submitted directly to the [[Official add-on repository]] on Github as pull requests. In addition to the [[Add-on rules|repository guidelines]] the following rules apply when submitting PRs on Github:

* PR should contain one commit only.
* Commit message should have the format "[addonid] version". Example: "[my.cool.addon] 1.0.1"

As with mailing list, only PRs from add-on author will be accepted. Patches should be submitted upstream. For an easy way to create PR from your own git repository, see [[HOW-TO: create add-on PRs using Git Subtree Merging]].

[[Category:Add-on development]]

Mirrors

2015-12-08T08:28:35Z

Martijn: /* euro */

{{mininav|[[Team XBMC]]|[[:Category:Team Kodi specific notes]]}}

This page contains information about our mirrors network setup.

== Download mirrors ==

=== Current ===
'''August 2015 to present day'''
To provide these downloads we use a network of mirrors across the globe to provide the best possible location to download from. For actually distributing the downloads and making sure you will download from the best server available we have been using Mirrorbits, which has been operating since August 2015 and so far hasn't failed us yet. This is a great piece of software that constantly checks the status of the mirrors and dishes out files based on certain criteria, in an effort to ensure that downloads work as quickly and reliably as possible. Besides these builds it also hosts all the add-on which you can find in our official XBMC.org repository.

=== Past ===
'''2010 to August 2015'''
To provide these downloads we use a network of mirrors across the globe to provide the best possible location to download from. For actually distributing the downloads and making sure you will download from the best server available we have been using Mirrorbrain, which has been operating since 2010 and so far hasn't failed us yet. This is a great piece of software that constantly checks the status of the mirrors and dishes out files based on certain criteria, in an effort to ensure that downloads work as quickly and reliably as possible. Besides these builds it also hosts all the add-on which you can find in our official Kodi.tv repository.

== Information ==

The actual mirror list is generated automatic and can be found at '''WIP (need to added again in some way)'''
We also provide a status report for each server if they are still in sync at '''WIP (need to added again in some way)'''
So we would like to thank all these providers for helping us out on distributing Kodi throughout the world. If you are interested in being added to this list feel free to contact us. Do note that we will only accept offers from large institutions or companies to keep possible problems at a minimum.

Our main mirror address is: http://mirrors.kodi.tv

Current mirrorlist is: WIP (need to added again in some way)

== rsync setup ==

We have two main rsync mirror which are used by main Tier1 mirror hosts per continent.
All other hosts should use those hosts according to their location.

=== main ===

primary Tier1 USA server:
* Name: gatech.edu
* Uses: rsync://rsync.xbmc.org/main/
** sync on half past the hour XX:30
* address: rsync://rsync.gtlib.gatech.edu/xbmc/
* Notes:
** This excludes plugins as a courtesy to hosts to avoid possibly infringing files (to be determined if still needed)
** all other USA mirrors should sync from this host
** mirrors should sync at XX:00

=== euro ===

primary Tier1 Europe server:
* Name: heanet.ie
* Uses: rsync://rsync.xbmc.org/euro/
** sync on the hour XX:00
* address: rsync://ftp.heanet.ie/mirrors/xbmc/
* Notes:
** This his no exclusions
** all other non-USA mirrors pull from them
** mirrors should sync at XX:00

== Requirements ==
* Space needed: ~70GB
* Mirrors pull at various times, the mirrorbits database contains notes about these times.
* Every couple of hours. Max is every 24h.
* If mirrors ever move to a new server, the dns entry for rsync.xbmc.org or rsync.kodi.tv can be changed and there should theoretically be no interruption. In reality, it makes sense to be sure that no one is pulling by IP or has white-listed the current IP for our constant mirror status checks.
* hosts need to provide this information to have proper setup
** http:// location (mandatory)
** ftp:// location (currently not used at all)
** rsync:// access to the mirrors for scanning available files(mandatory)
** Network bandwidth (gives indication of probability factor for traffic redirecting)
** Host webpage
** Host description
** Redirect options: AS network only / Continent only/ Country only / Global
** Admin name (will not be made public)
** Admin e-mail (will not be made public)
* rsync server is split up in two sections for providing data
** Please choose one of the TIER server rsync locations

Extra information
* rsync data could range to ~400Mb a day (amount may vary up or down)
* We have no hard data on amount of data that we redirect. We try to expand our network to reduce the amount for each mirror. We can always reduce the redirection criteria to reduce traffic to your mirror. Please contact us if needed.

[[Category:Team Kodi specific notes]]

Settings/System

2015-11-30T08:46:08Z

Martijn:

{{mininav|[[Settings]]}}
<section begin="intro" />System settings are found here. Set up and calibrate displays/video output, configure audio output, set up remote controls, set power saving options, enable debugging, set up master lock.<section end="intro" />
__TOC__
{{-}}
== Video output ==
{{see also|Settings/Videos|Video playback#OSD video settings}}
[[File:Settings.system.video output.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Display Mode
| Display Kodi in a window, or fullscreen on the selected screen.
|
|-
|
:-Display/Resolution 
| Changes the resolution that the User Interface is displayed in.
|
|-
|
:-Use a fullscreen window rather than true fullscreen
| ...when active (Windows only). Does not use the DirectX fullscreen mode. The main benefit is for multi-screen configurations, where Kodi can be used at the same time as other applications without automatically minimizing. Uses a bit more resources and playback may be slightly less smooth.
|
|-
|
:-Blank other displays
| In a multi-screen configuration, the screens where Kodi is not displayed are blacked out.
|
|-
| Stereoscopic mode (current)
| {{main|3D}}
|
|-
|
:-Preferred mode
|
|
|-
| Vertical blank sync
| Compensation for [[w:horizontal tearing|horizontal tearing]].
|
|-
| Video calibration...
| See [[#Video calibration...]]
|
|-
| Test patterns...
|
|
|-
| Use limited color range (16-235)
| Use limited color range instead of full color range (0-255). Limited range should be used if your display is a regular HDMI TV, while full color range should be used if your display is a PC monitor.
|
|}

==== Video calibration... ====
{{Note|Always adjust your TV display settings before Kodi's settings (such as overscan, etc). In most cases, you can get a "just scan/just fit/PC mode/something" mode turned on that will not require any adjustments in Kodi, and will allow for the best screen quality.}}
This screen allows you to calibrate the User Interface by adjusting the overscan. Use this tool if the image being displayed is too large or small for your display.<br />
Simply adjust the screen so that the arrows are in the top left and bottom right corners and that the entire frame is visible on screen.

It offers the ability to adjust:
* The overscan of the video - How close to the edges of the screen that the image is displayed.
* The position where subtitles are displayed.
* The pixel ratio allows you calibrate the aspect ratio at which videos are played back.
<gallery widths=250px heights=141px>
File:uicalibration1.png|Upper left corner
File:uicalibration2.png|Lower right corner
File:uicalibration3.png|Subtitles position
File:uicalibration4.png|Aspect ratio
</gallery>
{{-}}

== Audio output ==
{{Main|Audio}}
{{see also|Settings/Music|Video playback#OSD audio and subtitle settings}}
<section begin="Audio output settings" />
[[File:Settings - Audio Output.png|800px|center]]
{{-}}
{| class="prettytable" style="color: black;"
|-
!style="width:15%" colspan="2"| Setting
!style="width:70%" | Description
!style="width:8%" | Setting level
!style="width:7%" | Device type
|-
|colspan="2"|'''Audio output device'''
|Select the device to be used for audio output.
|Standard
|All
|-
|colspan="2"|'''Number of channels'''
|Select the number of channels supported by the audio connection.

;For digital connections
:This is the number of PCM channels that the audio connection supports and '''not''' the number of speakers connected. For example, using Dolby Digital over SPDIF will provide 5.1 audio to your system, even though SPDIF only supports 2.0 PCM channels. This setting does not apply to passthrough audio connections, if enabled.

;For analog connections
:This is the number of speakers outputs used, which is likely the number of speakers your system is using. Note that some "2.1" systems only use two audio channels and do not have a dedicated subwoofer output.

{{note|This setting might not be exposed depending on what is set for '''Audio output device'''.}}
|Basic
|HDMI/Analog-Speakers
|-
|rowspan="3"|'''Output configuration'''
|'''Fixed'''
|rowspan="3"|Select how the properties of the audio output are set:<br />
'''[Fixed] -''' output properties are set to the specified sampling rate & speaker configuration at all times<br />
'''[Optimized] -''' output properties are set at the start of playback and will not change if the properties of the source changes<br />
'''[Best Match] -''' output properties are set to always be as close a match to the source properties as possible
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Optimized'''
|-
|'''Best Match'''
|-
|-
|colspan="2"|'''Limit sampling rate (kHz)'''
|Maximum sampling rate for spdif or sampling rate for fixed output configuration
|Advanced
|SPDIF
|-
|colspan="2"|'''Stereo upmix'''
|Select to enable upmixing of 2 channel audio to the number of audio channels specified by the channel configuration
|Advanced
|All
|-
|colspan="2"|'''Normalize levels on downmix'''
| {{string|36533}}
|Advanced
|All
|-
|rowspan="3"|'''Resample quality'''
|'''Low'''
|rowspan="3"|Select the quality of resampling for cases where the audio output needs to be at a different sampling rate from that used by the source<br />
'''[Low]''' is fast and will have minimal impact on system resources such as the use of the CPU<br />
'''[Medium] & [High]''' will use progressively more system resources
|rowspan="3"|Advanced
|rowspan="3"|All
|-
|'''Medium'''
|-
|'''High'''
|-
|colspan="2"|'''Keep audio device alive'''
|Select the behaviour when no sound is required for either playback or GUI sounds:<br />
'''[Always] -''' continuous inaudible signal is output, this keeps the receiving audio device alive for any new sounds, however this might also block sound from other applications<br />
'''[1- 10 Minutes] -''' same as Always except that after the selected period of time audio enters a suspended state<br />
'''[Off] -''' audio output enters a suspended state. Note - sounds can be missed if audio enters suspended state<br />
<br />
'''Note:''' This is not supported on Raspberry PI devices because of high CPU usage
|Standard
|All
|-
|colspan="2"|'''Play GUI sounds'''
|Configure how interface sounds are handled, such as menu navigation and important notifications
|Basic
|All
|-
|colspan="2"|'''Enable passthrough'''
|Select to enable the passthrough audio options for playback of encoded audio such as Dolby Digital
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Passthrough output device'''
|Select the device to be used for playback of encoded formats, these are any of the formats below in the 'capable receiver' options
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital (AC3) capable receiver'''
|Select this option if your receiver is capable of decoding AC3 streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''- Enable Dolby Digital transcoding'''
|Select this if the audio out connection only supports multichannel audio as Dolby Digital 5.1, such as an SPDIF connection. If your system supports LPCM multichannel sound via HDMI then leave this disabled. This option is only available where the number of channels is 2.0, for SPDIF this is set automatically so this option is always available, if using HDMI then you may need to change the Number of Channels setting to 2.0.
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''Dolby Digital Plus (E-AC3) capable receiver'''
|Select this option if your receiver is capable of decoding E-AC3 streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS capable receiver'''
|Select this option if your receiver is capable of decoding DTS streams
|Advanced
|HDMI/SPDIF
|-
|colspan="2"|'''TrueHD capable receiver'''
|Select this option if your receiver is capable of decoding TrueHD streams
|Advanced
|HDMI
|-
|colspan="2"|'''DTS-HD capable receiver'''
|Select this option if your receiver is capable of decoding DTS-HD streams
|Advanced
|HDMI
|}

{{redv|'''IMPORTANT NOTE:'''|
The "'''capable receiver'''" options relate only to the '''passthrough''' of audio to another device such as an AVR, where that device must support decoding of the format. Before leaving any "'''capable receiver'''" option enabled check to make sure that both the playback device running Kodi (e.g. HTPC) and the connected device (e.g. AVR) both support that format.

If you have a "'''capable receiver'''" option enabled that your device does not support then this will result in poor playback of video typically with a very low frames-per-second and no audio, so for example if the '''TrueHD capable receiver''' option were enabled then make sure that the playback device can passthrough TrueHD and that the connected device can decode TrueHD, if either of the devices do not support TrueHD then the '''TrueHD capable receiver''' option '''MUST''' be left disabled.

For any format where the "capable receiver" option is not selected, Kodi will still playback any content containing those audio types, however instead of the audio being passed through, Kodi will decode audio and then send the audio in a compatible format.

If connected directly to a TV be aware that TV are not compatible with DTS, TrueHD or DTS-HD, typically the only encoded format a TV will be compatible with is AC3.}}
<section end="Audio output settings" />

== Input devices ==
{{note|The content of this screen largely depends on the input devices that Kodi detects and the OS being used.}}
[[File:Settings.system.input devices.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Peripherals
| See '''[[#Peripherals]]'''.
|
|-
| Apple remote ''(OS X only)''
|
|
|-
| Allow start of Kodi using the remote ''(OS X only)''
|
|
|-
| Sequence delay time
|
|
|-
| Enable mouse and touch screen support
| {{see also|Touch screen}}
If deactivated, Kodi will ignore all mouse movements and clicks.
|
|-
| Enable joystick and gamepad support
|
|
|-
| Enable system keys in fullscreen ''(Linux only)''
|
|
|}

=== Peripherals ===

== Internet access ==
[[File:Settings.network.internet access.png|center|800px]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Use an HTTP proxy server to access the internet
| If your internet connection uses a proxy, configure it here.
|
|-
|
:-Proxy type
|
|
|-
|
:-Server
| Proxy server address.
|
|-
|
:-Port
| Defines the port of the proxy server
|
|-
|
:-Username
| Defines the username used for the proxy server
|
|-
|
:-Password
| Defines the password used for the proxy server
|
|-
| Internet connection bandwidth limitation
| If you have limited bandwidth available, select a suitable value here and Kodi will try to keep to these limits. {{?}}
|
|}

== Power saving ==
{{see also|Settings/Appearance#Screensaver}}
{{note|Some options might not be available on all hardware or OSes. For example, Kodi cannot control shutdown or sleep on [[Android]].}}
[[File:Settings.system.power saving.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Put display to sleep when idle
| Turns off display when idle. Useful for TVs that turn off when there is no display signal detected, but you don't want to suspend/shutdown the whole computer. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function timer
| Sleeps the computer when idle. Selectable from 5 minutes to 120 minutes.
|
|-
| Shutdown function
| Defines what "Shutdown" will do by default. Can be set to actually shutdown, suspend, minimize, or quit.
|
|-
| Try to wake remote servers on access
| {{Main|Wake on lan}}
|
|}

{{note|Kodi also has a "Custom shutdown timer" selectable from the power icon on the home screen, or from the shutdown menu (press {{keypress|S}} on a keyboard or {{button|Power}} on a remote).}}

== Debugging ==
{{main|Log file|Log file/Advanced}}
<section begin="debugging" />
[[File:Settings.system.debugging.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Enable debug logging
| Toggles [[debug log]] on / off. Useful for troubleshooting.
|
|-
|-
| Enable component-specific logging
| Enables extra logging for specific areas of Kodi.
|
|-
|
:-Specify component-specific logging
| {{see also|#Component-specific logging}}
Select which additional components to include in the debug log.
|
|-
| Screenshot folder
| Folder used to save screenshots taken within Kodi. (see [[Keyboard controls]] for the screenshot key for your OS)
|
|}

=== Component-specific logging ===
{{anchor|Verbose logging}}
[[File:Verbose logging options.png|right|400px|thumb|The component-specific logging selection window, with multiple options selected.]]

Component-specific logging options enables extra logging for specific areas of Kodi. This allows the debug logs to be easier to read as they can exclude information that is not important for a specific bug or issue, while still allowing that extra information to be turned on as-needed. Multiple components can be enabled if needed.

:{| class="prettytable"
! Setting !! Description
|-
| SMB library ||
|-
| CURL library ||
|-
| CMYTH library ||
|-
| FFMPEG libraries ||
|-
| AUDIO component ||
|-
| VIDEO component ||
|-
| RTMP library ||
|-
| JSON-RPC requests ||
|-
| AirTunes library ||
|-
| UPnP components ||
|-
| CEC library ||
|}

{{-}}
<section end="debugging" />

== Master lock ==
{{see also|Profiles}}
{{note|''The Master lock options are ONLY available while using the default user [[profile]].''}}
[[File:Settings.system.master lock.png|800px|center]]
{| class="prettytable"
! width="20%" | Setting
! Description
! Setting level
|-
| Master lock code and settings
| Opens the [[#Master lock settings|Master lock settings window]], where you can configure your Master Lock options. See '''[[#Master lock settings]]'''.
|
|-
|
:-Ask for master lock code on startup
| If enabled, the master lock code is required to unlock Kodi on startup
|
|}

=== Master lock settings ===
[[File:Lock settings.png|center|600px]]
{| class="prettytable"
! width="20%" | Setting
! Description
|-
| Master Lock
| Allows you to set the master lock password. Can be one of three types:
* '''Numeric password''' - Enter a Numeric Password using the On Screen Keyboard
* '''Gamepad button combo''' - Enter a series of buttons using the Gamepad
* '''Full-text password''' - Enter a plain-text password using the On Screen Keyboard
|-
| Lock music window
|
|-
| Lock video window
|
|-
| Lock pictures window
|
|-
| Lock programs and scripts windows
|
|-
| Lock file manager
|
|-
| Lock settings
|
|-
| Lock Add-on manager
|
|}

=== Locking media sources ===
{{main|Media sources#Locking}}
{{#lst:Media sources|Locking}}

=== Locked out? ===
Kodi will give you three tries when you need to enter a lock/password to access something that is locked. If you max out these three tries then just quit Kodi and re-open it to get three more tries. The Master Lock code is stored in the "'''profiles.xml'''" file in the [[userdata]] folder. Should you get locked out, you can delete or edit the "'''profiles.xml'''" file.

=== Advanced settings ===
{{note|It's generally not recommended to manually edit guisettings.xml at all. If you're unsure about this, don't touch it. Strange things might happen (maybe?). Spooooky.}}
The number of tries before being "locked out" can be tweaked by manually editing the guisettings.xml file in the [[userdata folder]].

<syntaxhighlight lang="xml" enclose="div">
<masterlock>
<maxretries>3</maxretries> 
<startuplock>false</startuplock> 
</masterlock>
</syntaxhighlight>

{{Gotham updated}}

[[Category:Manual]]
[[Category:Settings]]

Official:Forum rules/Banned add-ons

2015-11-24T22:49:33Z

Martijn: /* Add-on blacklist */

{{mininav| [[Forum rules]] }}

This is an example list of repositories and add-ons that have been identified as violating the {{kodi}} '''[[forum rules]]'''. This means they have been banned from any official {{kodi}} forums, websites, IRC channels and any social media accounts that are under the control of [[Team Kodi]] or the [[XBMC Foundation]].

'''This list is only an example, and does not include all add-ons or services that violate the [[forum rules#Piracy Policy|forum rules]].'''

While Team Kodi does not regulate what users install or use, we ask that you do not come to any of the official {{kodi}} websites for support on these repos/add-ons. Failure to do so may result in a ban.

== How do I tell if something is allowed or not==
{{collapse top|click "Expand" to view the rules on piracy/bootleg video content -->}}
{{main|forum rules}}
{{#lst:Official:Forum rules|piracy policy}}
{{collapse bottom}}

The basic rule of thumb for what is not allowed, is that if the Add-on is offering something for free that you would normally expect to pay for by any other means, then it'll most likely be using pirate feeds.

If the Add-on simply allows access to web feeds from the rights holders then discussion of these is normally allowed, in this case there generally will be a website equivalent of the service, for example Youtube, BBC iPlayer, Netflix.

'''Note -''' If the Add-on is from our Official Add-on Repo then it has already been checked that it doesn't break our rules, therefore anything contained in the Official Repo is safe to discuss in any of our websites/channels.

== Repository blacklist ==
* Aftershock

* Fusion
* J1nx
* Kinkin
* SuperRepo
* Metal Kettle
* Mobie
* MTLFREETV (Montreal Free TV)
* Unity
* Total Installer
* TOTALXBMC
* TVADDONS
* WikiXBMC
* Wookie
* XBMCHUB
* Xfinity (not to be confused with the TV service from Comcast Cable)
* Xunity / XunityTalk (Xunity Talk)

== Add-on blacklist ==
*1Channel
*4K UHD
*Aftershock
*Animeram
*BBTS
*CartoonHD
*Cartoons8
*cCloud TV
*Cloudword
*DOCU-HUB
*F.T.V.
*Free Streams
*HUB/TVADDONS/Xfinity Config Wizard
*HUB/TVADDONS/Xfinity 'fresh start'
*Genesis
*GoMovies
*GoTV
*I Watch Online
*IceFilms
*Indian TV (OTT)
*IPTV Stalker (not to be confused with Stalker Middleware)
*IPTV Simple Client 2 (not to be confused with the original and official "IPTV Simple Client")
*iStream
*iwannawatch
*J1nxPack (J1nx Pack)
*Kiss Anime
*LatestDude
*MashUp
*MK Sports
*Movie25
*Movie4k
*MovieStorm
*MuchMovies
*Navi-X
*OneClickMoviez
*Phoenix
*Popcorn Time
*Primewire
*ProjectFreeTV (Project Free TV)
*SportsAccess
*Sport-A-Holic
*SportsDevil
*SuperTV
*Vdubt25
*Wookie Wizard
*Xfinity Installer
*S.A.L.T.S. Stream all the Sources
*Zeus

==So where do I get support?==

Every Add-on should contain the authors name, this found by opening the Context menu on the Add-on and selecting '''Add-on Information'''

[[File:add-on-context.JPG|400px]]

[[File:add-on-info.JPG|400px]]

Generally a search of the Add-on's name together with the author name will give the location of where the author is active.

For example a search term might be:

'''Kodi TheCollective Youtube'''

__NOINDEX__
[[Category:Forum]]

Official:Forum rules/Banned add-ons

2015-11-22T13:04:46Z

Martijn: /* Add-on blacklist */

{{mininav| [[Forum rules]] }}

This is an example list of repositories and add-ons that have been identified as violating the {{kodi}} '''[[forum rules]]'''. This means they have been banned from any official {{kodi}} forums, websites, IRC channels and any social media accounts that are under the control of [[Team Kodi]] or the [[XBMC Foundation]].

'''This list is only an example, and does not include all add-ons or services that violate the [[forum rules#Piracy Policy|forum rules]].'''

While Team Kodi does not regulate what users install or use, we ask that you do not come to any of the official {{kodi}} websites for support on these repos/add-ons. Failure to do so may result in a ban.

== How do I tell if something is allowed or not==
{{collapse top|click "Expand" to view the rules on piracy/bootleg video content -->}}
{{main|forum rules}}
{{#lst:Official:Forum rules|piracy policy}}
{{collapse bottom}}

The basic rule of thumb for what is not allowed, is that if the Add-on is offering something for free that you would normally expect to pay for by any other means, then it'll most likely be using pirate feeds.

If the Add-on simply allows access to web feeds from the rights holders then discussion of these is normally allowed, in this case there generally will be a website equivalent of the service, for example Youtube, BBC iPlayer, Netflix.

'''Note -''' If the Add-on is from our Official Add-on Repo then it has already been checked that it doesn't break our rules, therefore anything contained in the Official Repo is safe to discuss in any of our websites/channels.

== Repository blacklist ==
* Aftershock

* Fusion
* J1nx
* Kinkin
* SuperRepo
* Metal Kettle
* Mobie
* MTLFREETV (Montreal Free TV)
* Unity
* Total Installer
* TOTALXBMC
* TVADDONS
* WikiXBMC
* Wookie
* XBMCHUB
* Xfinity (not to be confused with the TV service from Comcast Cable)
* Xunity / XunityTalk (Xunity Talk)

== Add-on blacklist ==
*1Channel
*Aftershock
*Animeram
*BBTS
*CartoonHD
*Cartoons8
*cCloud TV
*Cloudword
*DOCU-HUB
*F.T.V.
*Free Streams
*HUB/TVADDONS/Xfinity Config Wizard
*HUB/TVADDONS/Xfinity 'fresh start'
*Genesis
*GoMovies
*GoTV
*I Watch Online
*IceFilms
*Indian TV (OTT)
*IPTV Stalker (not to be confused with Stalker Middleware)
*IPTV Simple Client 2 (not to be confused with the original and official "IPTV Simple Client")
*iStream
*iwannawatch
*J1nxPack (J1nx Pack)
*Kiss Anime
*LatestDude
*MashUp
*MK Sports
*Movie25
*Movie4k
*MovieStorm
*MuchMovies
*Navi-X
*OneClickMoviez
*Phoenix
*Popcorn Time
*Primewire
*ProjectFreeTV (Project Free TV)
*SportsAccess
*Sport-A-Holic
*SportsDevil
*SuperTV
*Vdubt25
*Wookie Wizard
*Xfinity Installer
*S.A.L.T.S. Stream all the Sources
*Zeus

==So where do I get support?==

Every Add-on should contain the authors name, this found by opening the Context menu on the Add-on and selecting '''Add-on Information'''

[[File:add-on-context.JPG|400px]]

[[File:add-on-info.JPG|400px]]

Generally a search of the Add-on's name together with the author name will give the location of where the author is active.

For example a search term might be:

'''Kodi TheCollective Youtube'''

__NOINDEX__
[[Category:Forum]]

Official:List of Foundation Trademarks

2015-11-17T12:35:45Z

Martijn: /* Wordmarks */

{{mininav|[[XBMC Foundation]]|[[Official:Trademark Policy index|Trademarks]]}}

== List of XBMC Foundation Trademarks ==
As other trademarks are created or registered, this list will be updated. As used in this policy, "trademarks" means not just the XBMC Foundation's logos, but also the names of its various products and projects, also called word marks, (collectively "XBMC Foundation Marks").

=== Wordmarks ===
* Kodi ®
** USPTO registration number [[http://tsdr.uspto.gov/#caseNumber=86284077&caseType=SERIAL_NO&searchType=statusSearch 4852083]]
* Kore ™
* XBMC ™
* XBMCbuntu ™
* [[Zappy]] ™
* KodiBuntu ™

=== Logos ===
<gallery>
Side-by-side-dark-transparent.png | Kodi ® logo ™
Kore Artwork Concept 2.png | Kore logo ™
KodiBuntu.png | Kodibuntu logo ™
XBMC logo-solid shadow.png | Classic XBMC logo ™
XBMC new logo.png | XBMC logo ™
Zappy.png | Zappy ™
</gallery>

[[Category:Trademark Policy]]