Official Kodi Wiki - User contributions [en]

Language support

2020-07-10T08:03:13Z

ThumbOne: /* What is strings.po */ Adding clarifications from https://forum.kodi.tv/showthread.php?tid=355578 (a first cut for now)

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

This is a format defined by [https://www.gnu.org/software/gettext/ GNU gettext] but adapted in a very specific way by Kodi. The blocks of 3 settings in the example above are defined by GNU gettext as:

msgctxt ''context''
msgid ''untranslated-string''
msgstr ''translated-string''

Where the text is defined by ''untranslated-string'' and ''context'' serves to differentiate identical values.

Take note, in Kodi, these are used as follows:

msgctxt "#''label_id''"
msgid ''label_text''
msgstr ''translation''

where ''label_id'' is a numeric ID. These IDs are reserved by Kodi:

* 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

and are used in [[Add-on_settings_conversion|settings.xml]] to label settings.

''label_text'' defines the English text for the label.

''translation'' is empty for "en_GB" labels, and the translation for other languages with msgid retaining the English text.

The important thing is that you cannot refer to the label with msgid in the settings.py file, you need to use the ''label_id'' which must be encoded in msgctxt as above.

You can of course edit .po files in a text editor or with a specialist editor. There is a tool that will help converting old settings.xml files to the settings.po format:

https://gitlab.com/ronie/script.language-convert

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

{{warning|1=Strings.xml support was completely removed from v19 Matrix. Addons should update and comply to the strings.po file from now on.}}

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

NFO files

2020-07-06T02:47:16Z

ThumbOne: /* What is nfo */ Fixed a typo

{{NFO_content}}

{{mininav|[[Video library]] {{l2| [[Music library]] }} }}

<section begin="intro" />NFO files are used to populate the music and video library using locally stored information. They are helpful if data for your particular title does not exist, such as for home movies and sporting events. They can also be used to control the search behaviour of scrapers when problematic and ambiguous titles prevent your preferred title from being fetched.<section end="intro" />

= What is nfo =
'''nfo''' is a contraction of Info or Information. It is a Filename Extension - ''mymovie.nfo'' and the contents of the file are written in [http://en.wikipedia.org/wiki/XML XML]. The file itself does nothing except hold information. It is basically a text document with special tags inserted around the information. These tags are recognised by Kodi which enables data importing.

Kodi uses nfo files as one way of importing metadata into the library. It is also used as a method of exporting the library for various reasons, including backup. '''''See: [[Import-Export_library | Import & Export]]'''''

'''Note''': During the scanning process {{kodi}} always searches for, and uses NFO files first. When NFO files are not found then the scrapers are used to download information from online sources. Be aware of this if you are experiencing unexpected results.

Kodi uses [[Artwork]], and Extended Information to display your media. This information includes Actors, Directors, Plots, Taglines, Ratings, Run Times and more. All this data, known as metadata, is stored in the Kodi Library. The Library is stored in an [http://www.sqlite.org/ SQLite database].

There are two primary methods to load metadata into your library:
#Create a nfo file, from which Kodi is able to import the metadata (Primary- nfo files are always searched for)
#Use the online scraper (Secondary- if no nfo files exist, scrapers are used)

For information on how to use the online scraper within Kodi:<br />
:'''''See: [[Adding_music_to_the_library|Adding Music to Library]]'''''
:'''''See: [[Adding_video_sources|Adding Video Sources]]'''''<br />

'''The remainder of this wiki topic will provide the required information to create and use nfo files.'''

= Types of nfo =
Kodi can use the nfo file in one of three ways depending on the contents of the nfo file, as explained in the following sub-sections.

== Metadata nfo ==
This is the most common use of the nfo file. The Metadata nfo contains the metadata for the movie/tv show/music video/album/artist within the file. Kodi will scan this file and import its contents into the library.

For more details on creating and using the common Metadata NFO file, see the following sections...

=== Movie nfo ===
:'''''See: [[NFO_files/movies | Movie nfo]]'''''

=== TV Show nfo ===
:'''''See: [[NFO_files/tvshows | TV Show nfo]]'''''

=== Music nfo ===
:'''''See: [[NFO_files/music | Music nfo]]'''''

=== Music Video nfo ===
:'''''See: [[NFO_files/musicvideos | Music Videos nfo]]'''''

== Parsing nfo ==
A Parsing nfo does not contain any metadata that Kodi can use to import into the library. Instead it contains the URL to the the information at the site of the information provider.

As an example, searching for ''The Mummy'' on [https://www.themoviedb.org/ TMDB] returns 65 titles. If you are attempting to add one of the more obscure versions to your library, chances are that Kodi will scrape the incorrect title. The Parsing nfo offers an easy solution to this problem by pointing {{kodi}} to the correct title.

{{red|'''Note''': Most online Movie and TV Show databases include an IMDB field that contains the IMDB ID. This allows the use of the IMDB address in the Parsing NFO for Movies and TV Shows. This does NOT mean the title will be scraped from IMDB. The scraper simply recognises the ''ttxxxxx'' ID and uses it to search for the title at the online database of the currently active scraper. If your preference is for IMDB data, then you will need to install the appropriate scraper.}}

To create and use the parsing nfo, follow these steps:
#Locate the title at the appropriate site of the information provider, eg ''[https://www.themoviedb.org/ TheMovieDB]''
#Ensure you have correctly named your media files/folder. See: '''''[[Naming_video_files|Kodi naming conventions]]'''''
#Open a text file and copy the entire URL address of the movie from the address bar and paste it into the text file. No tags or code is required. ''See example below''
#Save the file and ensure it is correctly named. See the nfo sub-pages listed above for correct naming. '''Ensure the extension is *.nfo''' and not ''*.nfo.txt'' or ''*.nfo.doc''
#Run an ''Update Library'' or a ''Scan item to library''. Kodi will parse the URL and locate the title and scrape the correct metadata.

Example of Parsing Movie NFO :

<syntaxhighlight lang="xml">
https://www.themoviedb.org/movie/15849-the-mummy
</syntaxhighlight>

'''Notes:'''
*Parsing NFO files cannot be used for individual episodes or seasons, they can only be used at the TV Show level. Once the TV Show is found the <episodeguide> URL will then find the episodes.
*If there is more than one URL in the file only the first URL will be used.

== Combination nfo ==
It is possible to combine the above two types of nfo files into one nfo file. An example use would be to override data from the scraper site such as the title, runtime, movieset etc. It will scan the metadata located between the ''<movie></movie>'' XML tags and the omitted data will be scraped at the provided URL. An example:

''Example: Contents of Combination NFO file:''
<syntaxhighlight lang="xml">
<movie>
<title>Star Wars (99 second cut)</title>
<runtime>2</runtime>
<set>Star Wars Saga</set>
<sorttitle>Star Wars 01</sorttitle>
<genre clear="true">SciFi</genre>
<genre>Romance</genre>
<genre>Action</genre>
</movie>
http://www.imdb.com/title/tt0076759/
</syntaxhighlight>

Various tags allow multiple entries, eg multiple ''<genre>'' and ''<director>'' tags. If you use these tags in a Combination nfo, these tags will have their data '''added''' to the scraped entry in the database and, in some cases, may result in duplicate entries. To avoid this, use the ''clear'' attribute to clear out the downloaded metadata for those particular tags. See the <genre> tag in the above example.

A listing of which tags allow multiple entries can be found in the appropriate sub-pages. Does not apply to muic.

'''Notes:'''
*Combination NFO files cannot be used for individual episodes or seasons, they can only be used at the TV Show level.
*If there is more than one URL in the file only the first URL will be used.

= Creating nfo =
The following are the three methods that may be used to create nfo files for Kodi.

== Kodi Created nfo ==
This option requires that your library has already been scraped with metadata. Using the built in [[Import-export_library| Import & Export]] function of Kodi, you can export the library metadata into individual nfo files which are correctly created and saved. This is useful if you have an existing library and would like to backup the library or to import the library into another Kodi installation.
:'''''See: [[Import-export_library| Import & Export]]'''''

== Manual Creation ==
NFO files are simple text files containing XML tags. Creating your own nfo files is simple, and templates and examples are provided in the sub-pages of this wiki topic. They can be created using a simple text editor such as Notepad in Windows, or the equivelant in other operating systems. There are dedicated code editors that can also be used. They will not provide the required Kodi tags, but they will avoid glitches when saving the nfo file, which is commonly experienced with text editors.

Two common code editors that can be used:
*[https://notepad-plus-plus.org/ Notepad++]
*[https://code.visualstudio.com/ Visual Studio Code]

'''Structure of the nfo file''':

1. The file must be saved as Unicode Transformation Format-8 (UTF-8). The first line of the file will contain the following...
:<syntaxhighlight lang=xml enclose="div"><?xml version="1.0" encoding="UTF-8" standalone="yes"?></syntaxhighlight>

2. The second line and the last line of the file contains the nfo category opening and closing tags. Avaliable category tags are...
:<syntaxhighlight lang=xml enclose="div"><movie></movie>, <tvshow></tvshow>, <episodedetails></episodedetails>, <artist></artist>, <album></album> and <musicvideo></musicvideo></syntaxhighlight>

3. Between the opening and closing category tags are the tags for the media metadata. Each tag must have an opening tag and a closing tag. eg...
:<syntaxhighlight lang=xml enclose="div"><title>Blade Runner 2049</title>

<title> = opening tag
Blade Runner 2049 = metadata
</title> = closing tag
</syntaxhighlight>

4. Available tags are listed in the relevant sub-pages along with a sample and template nfo file.

Once created, the file must be saved with the ''.nfo'' extension in accordance with the details in the relevant sub-pages.

== Media Managers ==
The Media Manager can create nfo files in one of three ways:
#Scraping- This is the same process as performed by the Kodi scraper. The Media Manager will fetch metadata from the online scraper site and will create the nfo file which then needs to be scanned into the library, unlike Kodi that imports the metadata directly into the library.
#Manual- The Media Manager offers an interface that allows you to manually type in the data.
#Combination- A combination of both methods can be used. If you are not satisfied with the scraped metadata, then you are able to modify it.

<section begin="MediaManagers" />The following is a list of Media Managers on the forum. Questions regarding their use should be directed to the media manager developers.
*[https://forum.kodi.tv/forumdisplay.php?fid=195 Ember Media Manager]
*[https://forum.kodi.tv/showthread.php?tid=142723 Tiny Media Manager aka TMM]
*[https://forum.kodi.tv/showthread.php?tid=129134 Media Companion 3]
*[https://forum.kodi.tv/showthread.php?tid=136333 MediaElch]

Be aware there are many other media managers available that claim to be Kodi compatible but have not been updated in many years, and are clearly not compatible. Use of these incompatible media managers can break your library and require rebuilding using the {{kodi}} scrapers.

{{red|'''Note''': While Media Managers offer some level of control, there are limitations with their use. {{Kodi}} is in a constant state of development. Changes to allow new types of data or features into the library must be expected. Media Managers are known to be slow in catching up to these changes and, in many instances, these changes are never incorporated. No media manager is 100% Kodi compatible.}}

'''{{red|Kodi can create correct and accurate NFO's from the data already in the library which has been populated by a correct scraping process.}}'''
<section end="MediaManagers" />

= Scanning nfo files =
There is no special procedure to scrape nfo files. Performing the usual '''''[[Updating_or_removing_videos|Library Update]]''''', or selecting '''''[[Updating_or_removing_videos#Refresh_Library|Refresh]]''''' for individual items, will scan the nfo files into the library.

Be aware that nfo files are not easily interchangeable between Movies, TV Shows, Music Videos, Artists and Albums. Although they all share common tags, each also has its own specific tags that won't be recognised in other parts of the library.

'''After the NFO files are scanned into the library, they are no longer used and only serves as a backup. If you make changes to the NFO file you will need to ''[[Updating_or_removing_videos#Refresh_Library|Refresh]]'' that library entry for the changes to be loaded into Kodi.''' An Update Library will not capture the change as this only looks for '''new''' items.

= Troubleshooting =
If you have followed the guidelines of this wiki topic, and the NFO File still does not scan into the library, then check the following:

#Ensure your NFO File is encoded correctly. The NFO File must be encoded as a '''UTF-8''' type file. ANSI, has also been known to work.
#Check the setting '''Movies are in separate folders that match the movie title''' in the scraper settings is correctly set for your folder structure.
#If TV Shows are being mixed, this is most likely caused by using outdated or incorrectly created NFO Files. Ensure at least one of the following tags is in the tvshow.nfo file. If there are no ID's at the scraper site (eg home movies) then any random alpha-numeric entry will suffice.

:<syntaxhighlight lang=xml enclose="div">
<uniqueid type="" default="true"></uniqueid>


</syntaxhighlight>

= References =
<references />

{{top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

Keymap

2020-07-04T06:02:53Z

ThumbOne: /* Defaults */ Fixed small typo

{{mininav| [[Remote controls]] }}
<section begin="intro" />Keymaps are XML base files that define the mappings of keys (keyboard keys, mouse/remote/joysticks buttons and more) to Kodi actions.<section end="intro" />

== Customizing keymaps through the GUI ==
{{main|Add-on:Keymap Editor}}
Users can customize keymaps for remotes in GUI by using the community [[Add-on:Keymap Editor|Keymap Editor]] add-on.

== Location of keymaps ==
User modified keymap files must be stored in the "'''keymaps'''" folder in the [[userdata]] folder:
{{#lsth:userdata|Location of the UserData folder}}

=== Defaults ===
Default keymaps are included when Kodi is installed, but users should not edit those install files directly. Instead, place user modified keymaps in the [[userdata]]/keymaps/ directory.

Kodi can process multiple keymap files and does so like this:

* All *.xml files from the default install settings and userdata/keymaps/ folders are applied as keymaps.
* All *.xml files are processed in alphabetical order.
* Keymaps defined in an .xml file add to or override mappings in previous .xml file.
* Keymaps defined in the userdata folder add to or override mappings in the global keymap.

By default there will be no files in these locations, so grab one from the link below to make a new one/over-ride:

* ''' https://github.com/xbmc/xbmc/tree/master/system/keymaps '''
* ''' https://github.com/kodi-game/peripheral.joystick/tree/master/peripheral.joystick/resources/buttonmaps/xml '''

== Structure ==

There is one '''global''' keymap and several '''window'''-specific keymaps.<br />
Kodi falls back to the global map when the window-specific map hasn't bound the key being pressed.

The format of keymapping files is as follows:

<syntaxhighlight lang=xml enclose="div">
<keymap>
<global>
<gamepad>
<A>Select</A>
[...]
</gamepad>

<remote>
<select>Select</select>
[...]
</remote>

<keyboard>
<enter>Select</enter>
[...]
</keyboard>

<mouse>
<leftclick>Select</leftclick>
[...]
</mouse>

<universalremote>
<obc25>XBMC.ActivateWindow(MyMusic)</obc25>
[...]
</universalremote>

<joystick name="PLAYSTATION(R)3 Controller (00:1B:FB:F6:E0:F2)">
<button id="15">Select</button>
[...]
</joystick>
</global>

<Home>
[...]
</Home>

[...]

</keymap>
</syntaxhighlight>

As you can see, it's divided into a <global> section, and a number of window sections (such as <Home>).<br />
A list of the available window names can be seen [[Window IDs|here]]. The WINDOW can also be a custom window formatted as <windowId#> (e. g. <window1113>). <br />
Each of these sections can contain Gamepad, Remote, Keyboard, Universal Remote, and custom Joystick sections.

The format for mapping a particular key under one of these device types is as follows:
<syntaxhighlight lang=xml enclose="div">
<keyname>action</keyname>
</syntaxhighlight>

== Keynames ==
Depending on your device you will need to use a specific "keyname".
=== Gamepads ===
An up to date list of the available actions can be found in the source code of Kodi in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp ButtonTranslator.cpp] where the ''TranslateGamepadString()'' function does the work.

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<gamepad>
<A>Select</A>
</gamepad>
</syntaxhighlight>

=== Remotes ===
An up to date list of IR-remote button names can be found in the source code of Kodi [https://github.com/xbmc/xbmc/blob/master/xbmc/input/IRTranslator.cpp IRTranslator.cpp]. See the method TranslateString().

The available actions are discussed in section [[Keymap#Actions|Actions]].

{{Note|Some remotes (e.g. FLIRC) are actually seen as "keyboards". Those will need to use the <keyboard> tag instead.}}

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<remote>
<play>Play</play>
</remote>
</syntaxhighlight>

=== Universal Remotes ===
To map Universal Remote buttons using the RCA infrared protocol, you may add '''<universalremote>''' sections to keymap.xml.<br />
In this case, the tags used are <obc#> where # is the original button code (OBC) of the button.<br />
You would put it inside a <universalremote> section in the <window> or <global> sections.

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<universalremote>
<obc148>Stop</obc148>
</universalremote>
</syntaxhighlight>

:Will map ''Stop Playback'' to the RCA DVD repeat button <obc148>, which is not used by Kodi by default.

* '''Note:''' ensure that the <universalremote> section is '''NOT''' added 'within' the <remote> section - it can appear before or after. Otherwise it will not be recognised and produces errors in the logfile.

Remote keys can be observed in the kodi.log file ('''~/.kodi/temp/kodi.log''' on Linux) when debugging is enabled in the GUI (Settings -> debugging ). The list of pre-defined OBC codes can be found at [https://github.com/xbmc/xbmc/blob/master/xbmc/input/XBIRRemote.h XBIRRemote.h].

=== Keyboards ===
Valid keyboard keymap syntax includes <keyname>, <key id="">, and <keyname mod="">.

Mapping for arbitrary key codes can be configured using the following syntax:
<syntaxhighlight lang=xml enclose="div">
<key id="123">
</syntaxhighlight>
where "123" is replaced by the key code.

A full list of valid keynames can be found in
* the [https://github.com/xbmc/xbmc/blob/master/xbmc/input/XBMC_keytable.cpp XBMC_keytable.cpp] source code file
* or in [[List of Kodi keynames]].<br />

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<keyboard>
<key id="123">action</key> -- id is the keys keycode. >
<a mod="shift,alt">action</a> -- corresponds to shift-alt-a, the mod="" syntax is enabled since build 26407. >
<space>action</space> -- for a complete list of valid keynames, see ButtonTranslator.cpp or List of Kodi keynames above. >
</keyboard>
</syntaxhighlight>

;Modifiers
* shift
* alt
* ctrl

=== Mouse ===

As this highly depends on the mouse you are using and which kind of buttons are available, we only mention the most common buttons on a mouse:
<syntaxhighlight lang=xml enclose="div">
<keymap>
<mouse>
<global>
<leftclick>...</leftclick>
<middleclick>...</middleclick>
<rightclick>...</rightclick>
<wheelup>...</wheelup>
<wheeldown>...</wheeldown>
</global>
</mouse>
</keymap>
</syntaxhighlight>

'''''Example for changing the volume while on MusicOSD (On Screen Display) window using the mouse wheel'''''

<syntaxhighlight lang=xml enclose="div">
<keymap>
<MusicOSD>
<mouse>
<wheeldown>VolumeDown</wheeldown>
<wheelup>VolumeUp</wheelup>
</mouse>
</MusicOSD>
</keymap>
</syntaxhighlight>

=== Custom Joystick Configuration ===
See [[HOW-TO:Modify_joystick.xml]].

== Long-press ==
{{note| Longpress seems to only be working on keyboard keymaps at the moment }}
Depending on the device, many remotes, keyboards, and gamepads can use the long-press modifier. This allows a button to do a separate action when held for a short period of time. The syntax for this is as follows:

<pre><button mod="longpress">action</button></pre>

Not all devices will correctly work with the longpress action, but most should.

{{Note|Long-press will disable keyrepeat for that key/window.}}

=== Removing a long-press action from a default keymap ===
If you want to simply remove a long-press action, rather than override it, you can place an empty long-press tag in a keymap. This also has the effect of re-enabling keyrepeat for the short-press action.

For example, this will remove the context menu action from the default keyboard.xml keymap:

<pre>
<keymap>
<global>
<keyboard>
<return mod="longpress"></return>
<enter mod="longpress"></enter>
</keyboard>
</global>
</keymap>
</pre>

== Commands ==
The most recent available actions can be found in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/actions/ActionIDs.h ActionIDs.h].

For those debugging integer action codes from the debug log, the mapping of action codes to constants is in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/Key.h Key.h]

In addition to the following actions, you can also use '''[[Built-in scripting]]''' in Kodi.

=== Actions ===
{{Main|Action IDs}}
{{#lst:Action IDs|Action IDs}}

=== Functions ===
{{main|List of built-in functions|Built-in scripting}}
{{#lst:List of built-in functions|functions}}

== Windows ==
{{main|Window IDs}}
{{#lst:Window IDs|main content}}

== Additional keys ==
Other keys that can be mapped to actions.

=== Media keyboards/remotes ===
* browser_back
* browser_forward
* browser_refresh
* browser_stop
* browser_search
* browser_favorites
* browser_home
* volume_mute
* volume_down
* volume_up
* next_track
* prev_track
* stop
* play_pause
* launch_mail
* launch_media_select
* launch_app1
* launch_app2
* play
* pause
* fastforward
* rewind
* channelup
* channeldown

=== Mouse actions ===
* leftclick
* rightclick
* middleclick
* doubleclick
* wheelup
* wheeldown
* mousemove
* mousedrag
* mousedragstart
* mousedragend
* mouserdrag - right button drag
* mouserdragstart - start of right button drag
* mouserdragend - end of right button drag

== Examples and pre-made keymaps ==
{{see|:Category:Custom keymaps}}

== See also ==
* [[Remote controls]]
* [[Keyboard controls]]
'''Development:'''
* [[Add-on development]]
* [[Python development]]
* [[Skinning]]

{{Updated|16}}

[[Category:Development]]
[[Category:Manual]]
[[Category:Remotes]]
[[Category:Settings]]
[[Category:Controls]]

Built-in scripting

2020-07-04T05:55:12Z

ThumbOne: /* Using Built-in Functions from python */ Removing very dated addendum and incorprating it as the new fact

{{mininav| [[Python development]] {{l2| [[Add-on development]] }} {{l2| [[Skinning]] }} }}
Kodi contains several built-in functions that can be accessed from the skin (via a button), from within a python script, or [[keymap]].

== General form of built-in Functions ==
Built-in functions take the form

[XBMC.]Function(param1,param2,...).

The XBMC. prefix is optional. Some parameters are required, depending on the function. In parsing built-in functions, Kodi first treats quoted (using double quotes ") character strings as literal, and drops the quotes. Thus, when inside a quote, any otherwise special characters will be ignored until the quote is complete. Parameters are separated by commas and, given that functions may be parameters to other functions (such as with the AlarmClock function), anything within brackets () are treated as a single block as well. Finally, prior to passing parameters into the function, any initial and trailing spaces are removed. This system allows you to pass in functions as parameters (the commas used for the passed function are ignored as they're within a () block), as well as allowing you to ignore whitespace around parameter separators. If you wish to pass commas in directly as part of a parameter, simply put quotes around the parameter string - Kodi will strip off the quotes prior to passing it in. Lastly, to pass in an actual quote character, make sure it's escaped (using the \ character), as in "\".

Some examples:

ActivateWindow(VideoFiles, path_to_some_files )
ActivateWindow(VideoFiles,path_to_some_files)
ActivateWindow(VideoFiles,"path_to_some_files")

will all produce the exact same functionality, under the assumption that path_to_some_files contains no initial or trailing spaces (unlikely) and no unmatched brackets and commas. The "ActivateWindow" function will be called with two parameters: "VideoFiles" (the window to open) and "path_to_some_files" (a starting path for the browsing). If path_to_some_files contains initial or trailing spaces, or contains commas or brackets, then only the last form will function correctly.

== Using Built-in Functions from the skin ==
To have a button (or toggle button) on the skin run a particular function, you just have to add an <onclick> tag (or <onfocus> tag) containing the function you wish to run.<br />
For example, adding the following to a button control will create a stop button.
<onclick>PlayerControl(Stop)</onclick>

If you want a button in your skin taking you directly to the movie listing, add a parameter to the [[Window IDs|Window ID]] as follows:
<onclick>ActivateWindow(myvideolibrary,movietitles)</onclick>
A list of parameters can be found here:
* [[Opening Windows and Dialogs]]<br />

== Using Built-in Functions from python ==
To run a built-in Kodi function from within a python script, you just need to call executebuiltin() with the function name. For example,
xbmc.executebuiltin('XBMC.RunScript(Q:\Scripts\myscript.py)')
will run the script myscript.py located in the Scripts directory. There is an optional second argument, a boolean which requests a blocking call. By default built-on functions are non-blocking and executebuiltin() will return before the built-in function has run to completion. By specifying True, you can request executebuiltin() to wait until the built-in function is finished before returning:
xbmc.executebuiltin('XBMC.RunScript(Q:\Scripts\myscript.py)', True)

== Using Built-in Functions from keymap.xml ==
To bind a built-in function to a particular key, you just add the built-in command to the appropriate section and button in keymap.xml

For example, to map the running of an executeable to the BLACK button, we'd add:

<syntaxhighlight lang="xml" enclose="div">
<gamepad>
...
<black>XBMC.RunXBE(E:\Apps\AVALaunch.xbe)</black>
...
</gamepad>
</syntaxhighlight>

to whatever window section of keymap.xml is appropriate.<br />
For more information on changing the keymapping with keymap.xml see: [[Keyboard.xml|Changing the keymapping]]

== List of built-in functions ==
{{see|List of built-in functions}}

[[Category:Skin development]]

GUI tutorial

2020-07-04T05:38:12Z

ThumbOne: /* using built-in functions */ Another typo fixed

{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}
<br />

= Introduction =

This How To will explain several ways of showing a "Hello World" popup on screen

= Examples =

== Using xbmc modules ==

Simple example using xbmc python modules showing a notification dialog that will show for 5 seconds.

=== using built-in functions ===
More info on Built-In functions can be found here: [[List of built-in functions]]
Following are two examples. One with just a simple notification dialog and the other with the same dialog but with using variables.
It all depends on how extended you scripts will be. Since we require all used strings to be localized (translatable) we recommend the second option.

<source lang="python">
import xbmc

xbmc.executebuiltin('Notification(Hello World,This is a simple example of notifications,5000,/script.hellow.world.png)')
</source>

<source lang="python">
import xbmc
import xbmcaddon

__addon__ = xbmcaddon.Addon()
__addonname__ = __addon__.getAddonInfo('name')
__icon__ = __addon__.getAddonInfo('icon')

line1 = "This is a simple example of notifications"
time = 5000 #in miliseconds

xbmc.executebuiltin('Notification(%s, %s, %d, %s)'%(__addonname__,line1, time, __icon__))
</source>

=== using xbmcgui module ===

This will show a OK dilaog box with the message
More info on xbmcgui functions can be found here: [ http://mirrors.xbmc.org/docs/python-docs/16.x-jarvis/xbmcgui.html#Dialog ]

<source lang="python">
import xbmcaddon
import xbmcgui

__addon__ = xbmcaddon.Addon()
__addonname__ = __addon__.getAddonInfo('name')

line1 = "This is a simple example of OK dialog"
line2 = "Showing this message using"
line3 = "XBMC python modules"

xbmcgui.Dialog().ok(__addonname__, line1, line2, line3)
</source>

== Using JSON-RPC ==

== Using xbmc modules & JSON-RPC API ==

More info on JSON-RPC API can be found here: [[JSON-RPC API]]

This JSON-RPC command send through various ways and will execute the addon code that is shown below.
<source lang="xml">
{
"jsonrpc": "2.0",
"id": 0,
"method": "Addons.ExecuteAddon",
"params": {
"addonid": "script.popup",
"params": {
"image": "D:\\heartagram.jpg",
"line1": "Hello World",
"line2": "Showing this message using",
"line3": "Combination of Kodi python modules and",
"line4": "JSON-RPC API interface",
"line5": "Have fun coding"
}
}
}
</source>

This python code will create several controls using xbmcgui module and fill these will the message send through JSON-RPC:

<source lang="python">
import xbmcgui
import sys
import urlparse

class PopupWindow(xbmcgui.WindowDialog):
def __init__(self, image, line1, line2, line3, line4, line5):
self.addControl(xbmcgui.ControlImage(x=25, y=25, width=150, height=150, filename=image[0]))
self.addControl(xbmcgui.ControlLabel(x=190, y=25, width=500, height=25, label=line1[0]))
self.addControl(xbmcgui.ControlLabel(x=190, y=50, width=500, height=25, label=line2[0]))
self.addControl(xbmcgui.ControlLabel(x=190, y=75, width=500, height=25, label=line3[0]))
self.addControl(xbmcgui.ControlLabel(x=190, y=100, width=500, height=25, label=line4[0]))
self.addControl(xbmcgui.ControlLabel(x=190, y=125, width=500, height=25, label=line5[0]))

if __name__ == '__main__':
params = urlparse.parse_qs('&'.join(sys.argv[1:]))
window = PopupWindow(**params)
window.show()
xbmc.sleep(5000)
window.close()
del window
</source>

= See also =
'''Development:'''
* [[Addon Settings]]
* [[Python development]]
* [[Skinning]]

[[Category:Add-on development]]

GUI tutorial

2020-07-04T05:37:17Z

ThumbOne: /* using build-in functions */ Fixed typo

{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}
<br />

= Introduction =

This How To will explain several ways of showing a "Hello World" popup on screen

= Examples =

== Using xbmc modules ==

Simple example using xbmc python modules showing a notification dialog that will show for 5 seconds.

=== using built-in functions ===
More info on Built-In functions can be found here: [[List of built-in functions]]
We will two examples. One with just a simple notification dialog and the other with the same dialog but with using variables.
It all depends on how extended you scripts will be. Since we require all used strings to be localized (translatable) we recommend the second option.

<source lang="python">
import xbmc

xbmc.executebuiltin('Notification(Hello World,This is a simple example of notifications,5000,/script.hellow.world.png)')
</source>

<source lang="python">
import xbmc
import xbmcaddon

__addon__ = xbmcaddon.Addon()
__addonname__ = __addon__.getAddonInfo('name')
__icon__ = __addon__.getAddonInfo('icon')

line1 = "This is a simple example of notifications"
time = 5000 #in miliseconds

xbmc.executebuiltin('Notification(%s, %s, %d, %s)'%(__addonname__,line1, time, __icon__))
</source>

=== using xbmcgui module ===

This will show a OK dilaog box with the message
More info on xbmcgui functions can be found here: [ http://mirrors.xbmc.org/docs/python-docs/16.x-jarvis/xbmcgui.html#Dialog ]

<source lang="python">
import xbmcaddon
import xbmcgui

__addon__ = xbmcaddon.Addon()
__addonname__ = __addon__.getAddonInfo('name')

line1 = "This is a simple example of OK dialog"
line2 = "Showing this message using"
line3 = "XBMC python modules"

xbmcgui.Dialog().ok(__addonname__, line1, line2, line3)
</source>

== Using JSON-RPC ==

== Using xbmc modules & JSON-RPC API ==

More info on JSON-RPC API can be found here: [[JSON-RPC API]]

This JSON-RPC command send through various ways and will execute the addon code that is shown below.
<source lang="xml">
{
"jsonrpc": "2.0",
"id": 0,
"method": "Addons.ExecuteAddon",
"params": {
"addonid": "script.popup",
"params": {
"image": "D:\\heartagram.jpg",
"line1": "Hello World",
"line2": "Showing this message using",
"line3": "Combination of Kodi python modules and",
"line4": "JSON-RPC API interface",
"line5": "Have fun coding"
}
}
}
</source>

This python code will create several controls using xbmcgui module and fill these will the message send through JSON-RPC:

<source lang="python">
import xbmcgui
import sys
import urlparse

class PopupWindow(xbmcgui.WindowDialog):
def __init__(self, image, line1, line2, line3, line4, line5):
self.addControl(xbmcgui.ControlImage(x=25, y=25, width=150, height=150, filename=image[0]))
self.addControl(xbmcgui.ControlLabel(x=190, y=25, width=500, height=25, label=line1[0]))
self.addControl(xbmcgui.ControlLabel(x=190, y=50, width=500, height=25, label=line2[0]))
self.addControl(xbmcgui.ControlLabel(x=190, y=75, width=500, height=25, label=line3[0]))
self.addControl(xbmcgui.ControlLabel(x=190, y=100, width=500, height=25, label=line4[0]))
self.addControl(xbmcgui.ControlLabel(x=190, y=125, width=500, height=25, label=line5[0]))

if __name__ == '__main__':
params = urlparse.parse_qs('&'.join(sys.argv[1:]))
window = PopupWindow(**params)
window.show()
xbmc.sleep(5000)
window.close()
del window
</source>

= See also =
'''Development:'''
* [[Addon Settings]]
* [[Python development]]
* [[Skinning]]

[[Category:Add-on development]]

Artwork/Cache

2020-07-04T01:03:23Z

ThumbOne: /* Advanced: How to refresh the cached image of an icon manually */ Fixing erroneous references to .xbmc (now .kodi)

{{Artwork_Contents}}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} | [[Artwork]] }}

<section begin="intro" />{{Kodi}} maintains a texture cache on local device storage for all artwork displayed in the GUI, whether from an online source or the local file system. These textures are optimized and stored locally for faster loading.

When artwork is added to the library, {{Kodi}} initially only has a URL or path to the artwork. The artwork itself is only downloaded (if from an online source) and then cached when the image is displayed in the GUI or other interface such as the Chorus web interface.<section end="intro" />

All images that {{Kodi}} loads, with the exception of textures that are provided directly by the skin, are cached to the userdata/Thumbnails folder.<br />

= Artwork for library items =
The artwork URLs associated with library items are stored in the art table inside the video or music databases. These store the original URL to the artwork (e.g. from local artwork files or from web sources such as https://themoviedb.org, https://thetvdb.com, or https://theaudiodb.com). This means that central databases store where the art is obtained from, and multiple devices then just keep a local thumbnail cache as described below.

= The caching procedure =
The caching procedure utilizes an optimized copy of the original image saved in .jpg or .png format and an SQL database that maintains the local cache.

The cache operates primarily on an "as and when needed" basis; i.e. textures are cached when they're first requested for display in a skin or web interface. In some cases textures may be cached before they're immediately needed, such as thumbnails generated from video files. In either case, the main caching procedure starts with an image URL. It caches as follows:

# {{Kodi}} generates a hash (CRC) of the URL, like "6a643bff".
# The texture is optimized (see [[#Texture optimization]]) and cached to a device-local file with the given URL hash. It is cached as a PNG if transparency is required and JPG otherwise.
# Another hash of the image is generated based on size and modified date, which can be used to check if the original image has changed.
# These details are stored in the SQL database Textures.db, along with information on when the image was cached.

= Loading textures =
When loading a texture for display in a skin or web interface, {{Kodi}} basically just has a URL to the image. Given a particular URL, it loads the texture as follows:

# If the image is provided by the skin, skip to step 5.
# If the URL is directly to a cached version of a texture in the cache, skip to step 5.
# If the URL is for an image already cached in the thumbnail cache, swap the URL to the cached version and skip to step 5.
# Cache the image as outlined in the section above.
# Load the image. If the image is provided by the skin, skip steps 6 and 7.
# The access time for this texture is saved in the texture database.
# If the image is not from a web service (HTTP/S) and at least 24 hours have passed since it was last loaded, check the hash generated in step 3 of "The caching procedure" for changes to the image. If the hash has changed, cache the new image as outlined in the section above.

= Texture optimization =
# Images are limited to a maximum pixel dimension to fit in a 16:9 box, with a default configuration of 1920x1080 for images that are 16:9 (like fanart) and larger than this, and 1280x720 for all other images. This can be changed with ''[[Advancedsettings.xml#Library artwork| advancedsettings.xml]]''.
#* If you are experiencing slow loading images or lagging GUI navigation on low powered equipment and/or your {{Kodi}} device has minimal storage available, these defaults can be lowered to noticeably reduce the cost of artwork. For higher powered equipment these settings can be increased to maintain the original artwork size. (eg 3840x2160 fanart)
# Images are re-encoded in a decoder-friendly way so that the image can be displayed as quickly as possible.

This optimized image is exported with {{Kodi}}'s [[Import-export_library|Library Export]] feature, rather than the original full-quality image, so it is best to avoid exporting artwork if at all possible.<ref>https://forum.kodi.tv/showthread.php?tid=315806&pid=2599318#pid2599318</ref>

= Advanced: How to refresh the cached image of an icon manually =
The [[Texture Cache Maintenance utility]] can do this in a safer way, but this is the manual option.
There is an image like ''/home/x/.kodi/addons/my.lovely.addon/icon.png'' . After changing that file, the old image is still visible in {{kodi}}. To solve this we need to remove the actual thumbnail file from the filesystem and its reference in the DB:

# Get the thumbnail path to remove the file from the filesystem
$ sqlite3 .kodi/userdata/Database/Textures13.db "SELECT cachedurl FROM texture WHERE url = '/home/x/.kodi/addons/my.lovely.addon/icon.png';"
6/6a643bff.png

This ''6/6a643bff.png'' is the cached image under ''/home/x/.kodi/userdata/Thumbnails''. So: you need to remove from your filesystem ''/home/x/.kodi/userdata/Thumbnails/6/6a43bff.png''

# Remove the image->cached image link in the DB
$ sqlite3 .kodi/userdata/Database/Textures13.db "DELETE FROM texture WHERE url = '/home/x/.kodi/addons/my.lovely.addon/icon.png';"

Next time Kodi needs the image, it will recreate the thumbnail.

:{{note|The <code>"Textures'''13'''.db"</code> '''[[Databases#Database_Versions|number/version can increase]]''' with later Kodi versions.}}

'''''See also: [[Databases#Database_Versions|Database Versions]]'''''

= Advanced: delete textures13.db =
This last resort procedure is one sure way to repair any image caching problem: delete the ''Textures13.db'' database and the thumbnail directory. This procedure does not affect the entries in the Video and Music libraries, so Kodi will not find more images after, this is just a brute-force solution to a caching problem. It affects the artwork database only. [[Texture Cache Maintenance utility]] can do very targeted fixes of the texture cache, so consider it before doing this.

'''Note'''
#Be aware that this should be a last resort procedure. Deleting this database file and the thumbnail directory will remove all cache entries and links, requiring remote URLs to web services to be downloaded again.
#As the URL link to the original artwork location is stored in the video or music databases, Kodi will use the existing URLs to rebuild the Texture database and thumbnail cache, rather than finding new images locally or from a scraper.
#{{red|Using this procedure, you cannot change the scraping location for artwork. ie- If you originally scraped from online sources, you cannot expect that Kodi will now scrape from your newly added local artwork and vice-versa. It will retrieve artwork from the same source as it was before, so the result will be the same image. To bulk change artwork, refer to ''[[Artwork#Importing-Scraping Artwork| Importing-Scraping Artwork]]''}}<br /><br />

You will need to perform the following for a clean start with respect to the artwork texture cache.
#Exit Kodi
#Delete ''texturesxx.db'' located in the ''\userdata\database\'' folder.
#Delete the ''Thumbnails'' directory located at ''\userdata\'' which stores all the cached images,
Once the above steps are performed
#Restart Kodi
#Kodi will automatically rebuild the Textures database and repopulate the Thumbnails cache as the images are displayed in the GUI or other Kodi interface.

= Cache manipulation tools =
* [[Texture Cache Maintenance utility]]
** {{#lst:Texture_Cache_Maintenance_utility|intro}}

= Kodi version updates =
<section begin="CacheMaxResolution" />From v18, the 1920x1080 resolution limitation has been removed. Using the following code in your advancedsettings.xml will allow caching artwork at original size. <ref>https://github.com/xbmc/xbmc/pull/13599</ref>

<syntaxhighlight lang="xml">
<imageres>9999</imageres>
<fanartres>9999</fanartres>
</syntaxhighlight>
<section end="CacheMaxResolution" />

= References =
<references />

{{Top}}

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Music library]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Add-on settings conversion

2020-07-03T11:41:54Z

ThumbOne: /* Structure */ Underscoring the need for the version="!" attribute, having just wasted an hour trying to convert an addon before discovering this hitch

{{mininav|[[Development]]|[[Add-on development]]}}
{{see also|Python development}}

=Converting addon settings=

==Preface==
As of Kodi 18 Leia it is possible to write your addon settings in the same setting format as Kodi uses.
Due to many initial issues, it is not recommended to convert your settings if your addon is in the Leia addon repo.

In Kodi 19 Matrix, those bugs have been fixed, so we recommend to convert your addon settings if you plan to submit your addon to the Matrix addon repo (or higher).

==Structure==

The structure of your settings.xml file should look like this

<syntaxhighlight lang="xml" enclose="div">
<?xml version="1.0" ?>
<settings version="1">
<section id="my.addon.id">
<category id="general" label="" help="">
<group id="1" label="">
<setting id="" type="" label="" help="">
<control type="" format=""/>
</setting>
</group>
</category>
</section>
</settings>
</syntaxhighlight>

* The '''<settings>''' tag '''must''' have a '''version="1"''' attribute (or the '''<section>''' tag will not be supported)
* your addon settings file can only have one '''<section>''' tag. the id should be the id of your addon. (the use of multiple sections is reserved for kodi's main settings.xml file)
* you can use multiple '''<category>''' tags, just like in the old addon settings format. the id of a category needs to be a string.
* the '''<group>''' tag is a replacement for the old '''sep''' and '''lsep''' types, you can define multiple groups in order to group a number of settings.

==Level==

Similar to Kodi settings, addons can now define a setting level for every setting.<br>
This will show or hide certain settings based on the settings level the user has selected (Basic, Standard, Advanced, Expert).

<syntaxhighlight lang="xml" enclose="div">
<setting id="" type="" label="" help="">
<level>0</level>
</setting>
</syntaxhighlight>

The various levels are defined as such:
* 0 - Basic
* 1 - Standard
* 2 - Advanced
* 3 - Expert
* 4 - Internal (will never be shown in the GUI)

=Setting types=

==type="text"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="text" id="test01" label="32001" default=""/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format|<syntaxhighlight lang="xml" enclose="div">
<setting id="test01" type="string" label="32001" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="edit" format="string">
<heading>32001</heading>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="text" id="test02" label="32002" default="" option="hidden"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test02" type="string" label="32002" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="edit" format="string">
<heading>32002</heading>
<hidden>true</hidden>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="text" id="test03" label="32003" default="" option="urlencoded"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test03" type="urlencodedstring" label="32003" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="edit" format="urlencoded">
<heading>32003</heading>
</control>
</setting>
</syntaxhighlight>}}

==type="ipaddress"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="ipaddress" id="test04" label="32004"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test04" type="string" label="32004" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="edit" format="ip">
<heading>32004</heading>
</control>
</setting>
</syntaxhighlight>}}

==type="number"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="number" id="test05" label="32005"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test05" type="integer" label="32005" help="">
<level>0</level>
<default>0</default>
<control type="edit" format="integer">
<heading>32005</heading>
</control>
</setting>
</syntaxhighlight>}}

==type="date"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="date" id="test06" label="32006" default="2015-03-12"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test06" type="date" label="32006" help="">
<level>0</level>
<default>2015-03-12</default>
<control type="button" format="date">
<heading>32006</heading>
</control>
</setting>
</syntaxhighlight>}}

==type="time"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="time" id="test07" label="32007" default="13:13"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test07" type="time" label="32007" help="">
<level>0</level>
<default>13:13</default>
<control type="button" format="time">
<heading>32007</heading>
</control>
</setting>
</syntaxhighlight>}}

==type="bool"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="bool" id="test08" label="32008" default="false"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test08" type="boolean" label="32008" help="">
<level>0</level>
<default>false</default>
<control type="toggle"/>
</setting>
</syntaxhighlight>}}

==type="select"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="select" id="test09" label="32009" lvalues="11|12|13|14"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test09" type="integer" label="32009" help="">
<level>0</level>
<default>0</default>
<constraints>
<options>
<option label="11">0</option>
<option label="12">1</option>
<option label="13">2</option>
<option label="14">3</option>
</options>
</constraints>
<control type="list" format="string">
<heading>32009</heading>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="select" id="test10" label="32010" values="aa|bb|cc|dd"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test10" type="string" label="32010" help="">
<level>0</level>
<default/>
<constraints>
<options>
<option>aa</option>
<option>bb</option>
<option>cc</option>
<option>dd</option>
</options>
<allowempty>true</allowempty>
</constraints>
<control type="list" format="string">
<heading>32010</heading>
</control>
</setting>
</syntaxhighlight>}}

==type="addon"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="addon" id="test11" label="32011" default="" addontype="xbmc.metadata.scraper.movies"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test11" type="addon" label="32011" help="">
<level>0</level>
<default/>
<constraints>
<addontype>xbmc.metadata.scraper.movies</addontype>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="addon">
<heading>32011</heading>
<show more="true" details="true">installed</show>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="addon" id="test12" label="32012" default="" addontype="xbmc.metadata.scraper.movies" multiselect="true"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test12" type="list[addon]" label="32012" help="">
<level>0</level>
<default/>
<constraints>
<addontype>xbmc.metadata.scraper.movies</addontype>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="addon">
<heading>32012</heading>
<show more="true" details="true">installed</show>
<multiselect>true</multiselect>
</control>
</setting>
</syntaxhighlight>}}

==type="enum"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="enum" id="test13" label="32013" lvalues="11|12|13|14"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test13" type="integer" label="32013" help="">
<level>0</level>
<default>0</default>
<constraints>
<options>
<option label="11">0</option>
<option label="12">1</option>
<option label="13">2</option>
<option label="14">3</option>
</options>
</constraints>
<control type="spinner" format="string"/>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="enum" id="test14" label="32014" values="aa|bb|cc|dd"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test14" type="integer" label="32014" help="">
<level>0</level>
<default>0</default>
<constraints>
<options>
<option label="aa">0</option>
<option label="bb">1</option>
<option label="cc">2</option>
<option label="dd">3</option>
</options>
</constraints>
<control type="spinner" format="string"/>
</setting>
</syntaxhighlight>}}

==type="labelenum"==
in case you use lvalues in a labelenum control, the saved value will now be the string id, instead of the localized string.
please adapt your python code for this.
<syntaxhighlight lang="xml" enclose="div">
<setting type="labelenum" id="test15" label="32015" lvalues="11|12|13|14"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test15" type="string" label="32015" help="">
<level>0</level>
<default/>
<constraints>
<options>
<option label="11">11</option>
<option label="12">12</option>
<option label="13">13</option>
<option label="14">14</option>
</options>
<allowempty>true</allowempty>
</constraints>
<control type="spinner" format="string"/>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="labelenum" id="test16" label="32016" values="bb|aa|dd|cc" sort="yes"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test16" type="string" label="32016" help="">
<level>0</level>
<default/>
<constraints>
<options sort="ascending">
<option label="bb">bb</option>
<option label="aa">aa</option>
<option label="dd">dd</option>
<option label="cc">cc</option>
</options>
<allowempty>true</allowempty>
</constraints>
<control type="spinner" format="string"/>
</setting>
</syntaxhighlight>}}

==type="slider"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="slider" id="test17" label="32017" default="20" range="5,5,100" option="int"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test17" type="integer" label="32017" help="">
<level>0</level>
<default>20</default>
<constraints>
<minimum>5</minimum>
<step>5</step>
<maximum>100</maximum>
</constraints>
<control type="slider" format="integer">
<popup>false</popup>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="slider" id="test18" label="32018" default="0.5" range="0.0,0.1,1.0" option="float"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test18" type="number" label="32018" help="">
<level>0</level>
<default>0.5</default>
<constraints>
<minimum>0.0</minimum>
<step>0.1</step>
<maximum>1.0</maximum>
</constraints>
<control type="slider" format="number">
<popup>false</popup>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="slider" id="test19" label="32019" default="20" range="0,1,100" option="percent"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test19" type="integer" label="32019" help="">
<level>0</level>
<default>20</default>
<constraints>
<minimum>0</minimum>
<step>1</step>
<maximum>100</maximum>
</constraints>
<control type="slider" format="percentage">
<popup>false</popup>
</control>
</setting>
</syntaxhighlight>}}

==type="file"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="file" id="test20" label="32020" default=""/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test20" type="path" label="32020" help="">
<level>0</level>
<default/>
<constraints>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="file">
<heading>32020</heading>
</control>
</setting>
</syntaxhighlight>}}

==type="audio"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="audio" id="test21" label="32021" default=""/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test21" type="path" label="32021" help="">
<level>0</level>
<default/>
<constraints>
<writable>false</writable>
<masking>audio</masking>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="file">
<heading>32021</heading>
</control>
</setting>
</syntaxhighlight>}}

==type="video"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="video" id="test22" label="32022" default=""/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test22" type="path" label="32022" help="">
<level>0</level>
<default/>
<constraints>
<writable>false</writable>
<masking>video</masking>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="file">
<heading>32022</heading>
</control>
</setting>
</syntaxhighlight>}}

==type="image"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="image" id="test23" label="32023" default=""/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test23" type="path" label="32023" help="">
<level>0</level>
<default/>
<constraints>
<writable>false</writable>
<masking>image</masking>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="image">
<heading>32023</heading>
</control>
</setting>
</syntaxhighlight>}}

==type="executable"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="executable" id="test24" label="32024" default=""/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test24" type="path" label="32024" help="">
<level>0</level>
<default/>
<constraints>
<writable>false</writable>
<masking>executable</masking>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="file">
<heading>32024</heading>
</control>
</setting>
</syntaxhighlight>}}

==type="folder"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="folder" id="test25" label="32025" default=""/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test25" type="path" label="32025" help="">
<level>0</level>
<default/>
<constraints>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="path">
<heading>32025</heading>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="folder" id="test26" label="32026" default="" option="writeable"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test26" type="path" label="32026" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="path">
<heading>32026</heading>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="folder" id="test27" label="32027" default="" source="videos"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test27" type="path" label="32027" help="">
<level>0</level>
<default/>
<constraints>
<sources>
<source>videos</source>
</sources>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="path">
<heading>32027</heading>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="folder" id="test28" label="32028" default="" source="music"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test28" type="path" label="32028" help="">
<level>0</level>
<default/>
<constraints>
<sources>
<source>music</source>
</sources>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="path">
<heading>32028</heading>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="folder" id="test29" label="32029" default="" source="pictures"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test29" type="path" label="32029" help="">
<level>0</level>
<default/>
<constraints>
<sources>
<source>pictures</source>
</sources>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="path">
<heading>32029</heading>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="folder" id="test30" label="32030" default="" source="programs"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test30" type="path" label="32030" help="">
<level>0</level>
<default/>
<constraints>
<sources>
<source>programs</source>
</sources>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="path">
<heading>32030</heading>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="folder" id="test31" label="32031" default="" source="files"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test31" type="path" label="32031" help="">
<level>0</level>
<default/>
<constraints>
<sources>
<source>files</source>
</sources>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="path">
<heading>32031</heading>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="folder" id="test32" label="32032" default="" source="local"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test32" type="path" label="32032" help="">
<level>0</level>
<default/>
<constraints>
<sources>
<source>local</source>
</sources>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="path">
<heading>32032</heading>
</control>
</setting>
</syntaxhighlight>}}

==type="action"==
<syntaxhighlight lang="xml" enclose="div">
<setting type="action" id="test33" label="32033" action="RunScript(script.globalsearch)" option="close"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test33" type="action" label="32033" help="">
<level>0</level>
<data>RunScript(script.globalsearch)</data>
<control type="button" format="action">
<close>true</close>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="action" id="test34" label="32034" action="RunScript(weather.yahoo,Location1)" default=""/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test34" type="string" label="32034" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.yahoo,Location1)</data>
</control>
</setting>
</syntaxhighlight>}}

==type="fileenum"==
fileenum type settings (which was basically a spincontrol listing all items) are no longer supported.
these settings can be converted into a file or folder browser.
<syntaxhighlight lang="xml" enclose="div">
<setting type="fileenum" id="test35" label="32035" values="resources"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test35" type="path" label="32035" help="">
<level>0</level>
<default>/home/ronie/.kodi/addons/script.settings-convert/resources</default>
<control type="button" format="file">
<heading>32035</heading>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="fileenum" id="test36" label="32036" values="resources" mask="/"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test36" type="path" label="32036" help="">
<level>0</level>
<default>/home/ronie/.kodi/addons/script.settings-convert/resources</default>
<control type="button" format="path">
<heading>32036</heading>
</control>
</setting>
</syntaxhighlight>}}

<syntaxhighlight lang="xml" enclose="div">
<setting type="fileenum" id="test37" label="32037" values="resources" mask="*.txt"/>
</syntaxhighlight>
{{hidden|style = width: 60%;|headerstyle = background: #cccccc;|contentstyle = text-align: left; border: 0px solid #AAAAAA;|New Setting Format |<syntaxhighlight lang="xml" enclose="div">
<setting id="test37" type="path" label="32037" help="">
<level>0</level>
<default>/home/ronie/.kodi/addons/script.settings-convert/resources</default>
<constraints>
<masking>*.txt</masking>
</constraints>
<control type="button" format="file">
<heading>32037</heading>
</control>
</setting>
</syntaxhighlight>}}

=Subsetting=
if you wish to define a subsetting, you can use the '''parent''' attribute with the id of the parent setting as the value.
<syntaxhighlight lang="xml" enclose="div"><setting id="test37" type="path" label="32037" help="" parent="test36"></syntaxhighlight>

=Conditions=

==visible==
if a setting should always be hidden, you can add this to the setting
<syntaxhighlight lang="xml" enclose="div"><visible>false</visible></syntaxhighlight>

if a settings should be conditionallly visible, add a dependencies section to your setting
<syntaxhighlight lang="xml" enclose="div">
<dependencies>
<dependency type="visible" setting=""></dependency>
</dependencies></syntaxhighlight>

==enable==
if a setting should always be disabled, you can add this to the setting
<syntaxhighlight lang="xml" enclose="div"><enable>false</enable></syntaxhighlight>

if a settings should be conditionally enabled, add a dependencies section to your setting
<syntaxhighlight lang="xml" enclose="div">
<dependencies>
<dependency type="enable" setting=""></dependency>
</dependencies>
</syntaxhighlight>

== eq / lt / gt ==

'''eq'''

compare to a bool value of another setting
<syntaxhighlight lang="xml" enclose="div">
<dependencies>
<dependency type="enable" setting="test01">true</dependency>
</dependencies>
</syntaxhighlight>

compare to a int value of another setting
<syntaxhighlight lang="xml" enclose="div">
<dependencies>
<dependency type="enable" setting="test01">5</dependency>
</dependencies>
</syntaxhighlight>

compare to a string value of another setting
<syntaxhighlight lang="xml" enclose="div">
<dependencies>
<dependency type="enable" setting="test01">something</dependency>
</dependencies>
</syntaxhighlight>

'''!eq'''
<syntaxhighlight lang="xml" enclose="div">
<dependencies>
<dependency type="enable" operator="!is" setting="test01">true</dependency>
</dependencies>
</syntaxhighlight>
<syntaxhighlight lang="xml" enclose="div">
<dependencies>
<dependency type="enable" operator="!is" setting="test01">0</dependency>
</dependencies>
</syntaxhighlight>
<syntaxhighlight lang="xml" enclose="div">
<dependencies>
<dependency type="enable" operator="!is" setting="test01"></dependency>
</dependencies>
</syntaxhighlight>

'''lt'''
<syntaxhighlight lang="xml" enclose="div">
<dependencies>
<dependency type="enable" operator="lt" setting="test01">5</dependency>
</dependencies>
</syntaxhighlight>

'''gt'''
<syntaxhighlight lang="xml" enclose="div">
<dependencies>
<dependency type="enable" operator="gt" setting="test01">0</dependency>
</dependencies>
</syntaxhighlight>

== and / or==
multiple dependencies can be defined as such
<syntaxhighlight lang="xml" enclose="div">
<dependencies>
<dependency type="enable">
<and>
<condition setting=""></condition>
<condition setting=""></condition>
</and>
</dependency>
</dependencies>
</syntaxhighlight>

<syntaxhighlight lang="xml" enclose="div">
<dependencies>
<dependency type="enable">
<or>
<condition setting=""></condition>
<condition setting=""></condition>
</or>
</dependency>
</dependencies>
</syntaxhighlight>

[[Category:Add-ons|*]]
[[Category:Settings]]
[[Category:Add-on development]]
[[Category:Development]]