Add-on settings

2013-12-27T09:36:03Z

H4wkmoon: /* type="enum" or "labelenum" */

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

{{see also|Python development}}

== Description ==

settings.xml is a XML file that contains the current configuration for the addon and should be placed in the resources direcory. If your addon has
configurable items that are set by the user, put them here. This file defines what the user sees
when they click on Addon settings for your addon. You don't need to do any coding to utilise this functionality.
The format for the settings file is relatively straightforward as can be seen in the following example:

Example code:
<source lang="xml">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings>
<category label="32001">
<setting label="32011" type="text" id="username" default=""/>
<setting label="32012" type="text" id="password" option="hidden" enable="!eq(-1,)" default=""/>
<setting label="32053" type="slider" id="limit" subsetting="true" default="20" range="5,5,100" option="int" />
<setting type="sep"/>
<setting id="debug" type="bool" label="32013" default="false"/>
</category>
<category label="32010">
<setting label="32032" type="action" action="RunScript($CWD/resources/lib/viewer.py, downloadreport)"/>
</category>
</settings>
</source>

You need to supply at least one category element.
The label attribute of both categories and settings should be the id of a language string in your language files or the one of the main XBMC language file.

== Different types ==

'''Setting type and additional attributes can be one in the following table:'''

{| class="wikitable" border="1"
! Type !! Description !! Value attribute (value="") !! Notes
|-
| music || || ||
|-
| video || || ||
|-
| pictures || || ||
|-
| programs || || ||
|-
| local || || ||
|-
|}

'''Settings can have additional attributes:'''
{| class="wikitable" border="0"
|-
| source="" || "video", "music", "pictures", "programs", "files", "local" or blank." if source is blank it will use the type for shares if it is a valid share if not a valid share it will use, both local and network drives.
|-
| visible="" || "true", "false" or conditional." Determines if the setting is displayed in the settings dialog (default = 'true')" You can also use a conditional statement: visible="System.HasAddon(plugin.video.youtube)"
|-
| enable="" || Allows you to determine whether this setting should be shown based on the value of another setting. 3 comparators are available:"
* eq() Equal to
* gt() Greater than
* lt() Less than

You can AND the comparators using the + symbol and negate it using the ! symbol (e.g. !eq() ). Each comparator takes 2 operands:
* Relative position of setting to compare
* Value to compare against

Thus if we place settings in our file in this order:
: myFirst setting
: mySecondSetting
: myThirdSetting

for the third setting we might add the option: 
enable="gt(-2,3) + lt(-2,10)" 
You can also use a conditional statement: enable="System.HasAddon(plugin.video.youtube)"
|}

== Elements ==

=== Line separators ===
Line separators add a horizontal separating line between other element. They are purely user-interface elements that do not allow user input and therefore have no meaningful value as a setting.

==== type="sep" ====
Shows a horizontal line.

Example code:
<source lang="xml">
<setting type="sep"/>
</source>

==== type="lsep" ====
Shows a horizontal line with a text.

Attributes:
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.

Example code:
<source lang="xml">
<setting label="32032" type="lsep"/>
</source>

=== Text input ===
Text input elements allow a user to input text in various formats. The "label" attribute must contain an id from the language file that indicates which text to display for the input field.

==== type="text" ====
Allow a user to enter one line of text.

Attributes:
* '''id="''string''"''' (required) - the name of the setting.
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* option="hidden"|"urlencoded" (optional)
:if set to "hidden", each characters entered by the user will be obfuscated with an asterisks ("*"), as is usual for entering passwords.
:if set to "urlencoded", each non-alphanumeric characters entered by the user will be "escaped" using %XX encoding.
* default="''value''" (optional) - the default value.

Example code:
<source lang="xml">
<setting label="32033" type="text" id="username" />
</source>

The value entered by the user is saved as a string value on disk:
<source lang="xml">
<setting id="username" value="john.doe" />
</source>
{{Note|Security consideration: when using <nowiki>option="hidden"</nowiki>, the value entered by the user is still saved as an unencrypted string value on disk.}}

==== type="ipaddress" ====
Allow a user to enter an ip address as text.

Attributes:
* '''id="''string''"''' (required) - the name of the setting.
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* default="''value''" (optional) - the default value.

Example code:
<source lang="xml">
<setting label="32035" type="ipaddress" id="ipaddress"/>
</source>

The value entered by the user is saved as a string value on disk:
<source lang="xml">
<setting id="ipaddress" value="127.0.0.1" />
</source>

=== Numeric input ===
Numeric input elements allow a user to enter a number. The "label" attribute must contain an id from the language file that indicates which text to display for the input field.

==== type="number" ====
Allows the user to enter an integer using up/down buttons.

Attributes:
* '''id="''string''"''' (required) - the name of the setting.
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* default="''value''" (optional) - the default value.

Example code:
<source lang="xml">
<setting label="32036" type="number" id="code"/>
</source>

The value entered by the user is saved as a string value on disk:
<source lang="xml">
<setting id="code" value="127000" />
</source>

{{Note|In Python, calling xbmcplugin.getSetting will return the number as a string value, which must be converted to an integer value if needed}}

==== type="slider" ====
Allows the user to enter a number using a horizontal sliding bar.

Example:
<source lang="xml">
<setting label="32053" type="slider" id="limit" default="20" range="5,5,100" option="int" />
<setting label="32053" type="slider" id="limit" default="20" range="0,100"/>
</source>

Attributes:
* '''id="''string''"''' (required) - the name of the setting.
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* '''range="''min''[,''step''],''max''"''' (required) - specify the range of valid values.
* '''option="int"|"float"|"percent"''' (required) - specifies whether to allow the user to choose between integers, floating point numbers or a percentage.
* default="''value''" (optional) - the default value.

The value entered by the user is saved as a string representation of a floating point value on disk:
<source lang="xml">
<setting id="limit" value="5.000000" />
</source>

{{Note|In Python, calling xbmcplugin.getSetting will return a string, which must be converted to an int, float or percentage value if needed}}

=== Boolean input ===
Boolean input elements allow a user to switch a setting on or off.

==== type="bool" ====
Attributes:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* default="true"|"false" (optional) - the default value.

Example code:
<source lang="xml">
<setting label="32033" type="bool" id="background" default="false"/>
</source>

{{Note|"true" and "false" are case sensitive!}}

The value entered by the user is saved as a string "true" or "false":
<source lang="xml">
<setting id="background" value="false" />
</source>

{{Note|In Python, calling xbmcplugin.getSetting will return a string "true" or "false", which must be converted to a boolean value if needed}}

=== Rotary selector ===
A rotary selector allows the user to selected from a list of predefined values.

==== type="enum" or "labelenum" ====
Both element types work the same except that the "enum" type will use the index of the chosen value, wheras the "labelenum" will use the actual value.

Arguments:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* '''values="''value1''[|''value2''[...]]" - or -
* '''lvalues="''id1''[|''id2''[...]]" (required):
: A list of values or language file ids from which the user can choose.

Example code:
<source lang="xml">
<setting label="32018" type="enum" id="service1" values="One|Two|Three|Four"/>
<setting label="32019" type="labelenum" id="service2" values="One|Two|Three|Four"/>
<setting label="32020" type="labelenum" id="service3" lvalues="32021|32022|32023|32024"/>
</source>

* Selecting the value "One" will return the int value "0", selecting the value "Two" will return the int value "1", etc.

The value entered by the user is saved as a string. For "enum"-type settings the index of the value is saved, starting at 0 for the first value. For "labelenum"-type settings the value is saved or, in case the lvalues attribute is used, the label translated in the language of the user.
<source lang="xml">
<setting id="service1" value="0" />
<setting id="service2" value="One" />
<setting id="service3" value="SomethingTranslated" />
</source>

=== File and folder browsing ===
File and folder browsing elements allow a user to select a file or folder by browsing the local disks or network. You can specify a media type to show only files of the chosen type to the user. The "label" attribute must contain an id from the language file that indicates which text to display for the input field.

==== type="file", "audio", "video", "image" or "executable" ====
Allow the user to browse for and select a file. When using type="audio", "video", "image" or "executable", only files of those types are displayed to the user.

Attributes:
* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* value="''value''" (optional) - the default value.

Example code:
<source lang="xml">
<setting label="32033" type="file" id="file" value="path_to_files"/>
</source>

The full path to the file selected by the user is saved as a string value on disk:
<source lang="xml">
<setting id="file" value="smb://path_to_files/file.ext" />
</source>

==== type="folder" ====
Allow the user to browse for and select a folder.

* '''id="''string''"''' (required) - the name of the setting
* '''label="''id''"''' (required) - an id from the language file that indicates which text to display.
* source="auto"|"images"|... (optional, default="auto") - select a starting folder for the browse dialog.
* value="''value''" (optional, default="") - the default value.
* option="writeable" (optional, default="") - the user can be allowed to create and select new folders by setting this argument.

Example code:
<source lang="xml">
<setting label="32033" type="folder" id="folder" source="auto" option="writeable"/>
</source>

The full path to the folder selected by the user is saved as a string value on disk:
<source lang="xml">
<setting id="folder" value="smb://path_to_files/"/>
</source>

=== Selection ===

Selector gives you a control from which you can selected predefined values.
Below are some possible applications.

Attributes:
* mask="" (????????????????)
* option="" (????????????????)


=== Execute action ===

Separator adds a label as separator between other element

Example code:
<source lang="xml">
<setting label="32032" type="action" action="RunScript($CWD/resources/lib/viewer.py, downloadreport)"/>
</source>

List of actions that can be used:
* [[List of built-in functions]]

Attributes:
* option="close" (close the settings dialog before executing the action)

[[Category:Add-ons|*]]
[[Category:Settings]]
[[Category:Addon Development]]
[[Category:Skin Development]]
[[Category:Development]]

Official Kodi Wiki - User contributions [en]

Add-on settings