Add-on settings conversion: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
(14 intermediate revisions by the same user not shown)
Line 17: Line 17:
<?xml version="1.0" ?>
<?xml version="1.0" ?>
<settings version="1">
<settings version="1">
<section id="addon">
<section id="my.addon.id">
<category id="1" label="" help="">
<category id="general" label="" help="">
<group id="1" label="">
<group id="1" label="">
<setting id="" type="" label="" help="">
<setting id="" type="" label="" help="">
Line 29: Line 29:
</syntaxhighlight>
</syntaxhighlight>


* your addon settings file can only have one '''<section>''' tag. (the use of multiple sections is reserved for kodi's main settings.xml file)
* 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.
* 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.
* 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=
=Setting types=
Line 43: Line 61:
<level>0</level>
<level>0</level>
<default/>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="edit" format="string">
<control type="edit" format="string">
<heading>32001</heading>
<heading>32001</heading>
Line 57: Line 78:
<level>0</level>
<level>0</level>
<default/>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="edit" format="string">
<control type="edit" format="string">
<heading>32002</heading>
<heading>32002</heading>
Line 72: Line 96:
<level>0</level>
<level>0</level>
<default/>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="edit" format="urlencoded">
<control type="edit" format="urlencoded">
<heading>32003</heading>
<heading>32003</heading>
Line 105: Line 132:
<level>0</level>
<level>0</level>
<default>0</default>
<default>0</default>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="edit" format="integer">
<control type="edit" format="integer">
<heading>32005</heading>
<heading>32005</heading>
Line 113: Line 137:
</setting>
</setting>
</syntaxhighlight>}}
</syntaxhighlight>}}


==type="date"==
==type="date"==
Line 173: Line 196:
<option label="14">3</option>
<option label="14">3</option>
</options>
</options>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="list" format="string">
<control type="list" format="string">
Line 182: Line 204:




==type="select"==
<syntaxhighlight lang="xml" enclose="div">
<syntaxhighlight lang="xml" enclose="div">
<setting type="select" id="test10" label="32010" values="aa|bb|cc|dd"/>
<setting type="select" id="test10" label="32010" values="aa|bb|cc|dd"/>
Line 216: Line 237:
<constraints>
<constraints>
<addontype>xbmc.metadata.scraper.movies</addontype>
<addontype>xbmc.metadata.scraper.movies</addontype>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="addon">
<control type="button" format="addon">
Line 234: Line 256:
<constraints>
<constraints>
<addontype>xbmc.metadata.scraper.movies</addontype>
<addontype>xbmc.metadata.scraper.movies</addontype>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="addon">
<control type="button" format="addon">
Line 259: Line 282:
<option label="14">3</option>
<option label="14">3</option>
</options>
</options>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="spinner" format="string"/>
<control type="spinner" format="string"/>
Line 280: Line 302:
<option label="dd">3</option>
<option label="dd">3</option>
</options>
</options>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="spinner" format="string"/>
<control type="spinner" format="string"/>
</setting>
</setting>
</syntaxhighlight>}}
</syntaxhighlight>}}


==type="labelenum"==
==type="labelenum"==
Line 399: Line 419:
<constraints>
<constraints>
<writable>false</writable>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="file">
<control type="button" format="file">
Line 418: Line 439:
<writable>false</writable>
<writable>false</writable>
<masking>audio</masking>
<masking>audio</masking>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="file">
<control type="button" format="file">
Line 437: Line 459:
<writable>false</writable>
<writable>false</writable>
<masking>video</masking>
<masking>video</masking>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="file">
<control type="button" format="file">
Line 456: Line 479:
<writable>false</writable>
<writable>false</writable>
<masking>image</masking>
<masking>image</masking>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="image">
<control type="button" format="image">
Line 475: Line 499:
<writable>false</writable>
<writable>false</writable>
<masking>executable</masking>
<masking>executable</masking>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="file">
<control type="button" format="file">
Line 493: Line 518:
<constraints>
<constraints>
<writable>false</writable>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="path">
<control type="button" format="path">
Line 508: Line 534:
<level>0</level>
<level>0</level>
<default/>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="path">
<control type="button" format="path">
<heading>32026</heading>
<heading>32026</heading>
Line 527: Line 556:
</sources>
</sources>
<writable>false</writable>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="path">
<control type="button" format="path">
Line 547: Line 577:
</sources>
</sources>
<writable>false</writable>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="path">
<control type="button" format="path">
Line 567: Line 598:
</sources>
</sources>
<writable>false</writable>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="path">
<control type="button" format="path">
Line 587: Line 619:
</sources>
</sources>
<writable>false</writable>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="path">
<control type="button" format="path">
Line 607: Line 640:
</sources>
</sources>
<writable>false</writable>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="path">
<control type="button" format="path">
Line 627: Line 661:
</sources>
</sources>
<writable>false</writable>
<writable>false</writable>
<allowempty>true</allowempty>
</constraints>
</constraints>
<control type="button" format="path">
<control type="button" format="path">
Line 643: Line 678:
<level>0</level>
<level>0</level>
<data>RunScript(script.globalsearch)</data>
<data>RunScript(script.globalsearch)</data>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<control type="button" format="action">
<close>true</close>
<close>true</close>
Line 654: Line 686:


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


==type="fileenum"==
==type="fileenum"==
Line 679: Line 711:
<level>0</level>
<level>0</level>
<default>/home/ronie/.kodi/addons/script.settings-convert/resources</default>
<default>/home/ronie/.kodi/addons/script.settings-convert/resources</default>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="file">
<control type="button" format="file">
<heading>32035</heading>
<heading>32035</heading>
Line 696: Line 725:
<level>0</level>
<level>0</level>
<default>/home/ronie/.kodi/addons/script.settings-convert/resources</default>
<default>/home/ronie/.kodi/addons/script.settings-convert/resources</default>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="path">
<control type="button" format="path">
<heading>32036</heading>
<heading>32036</heading>
Line 714: Line 740:
<default>/home/ronie/.kodi/addons/script.settings-convert/resources</default>
<default>/home/ronie/.kodi/addons/script.settings-convert/resources</default>
<constraints>
<constraints>
<allowempty>true</allowempty>
<masking>*.txt</masking>
<masking>*.txt</masking>
</constraints>
</constraints>

Revision as of 17:05, 4 January 2020

Home icon grey.png   ▶ Development ▶ Add-on development ▶ Add-on settings conversion

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

<?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>
  • 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.
This will show or hide certain settings based on the settings level the user has selected (Basic, Standard, Advanced, Expert).

<setting id="" type="" label="" help="">
	<level>0</level>
</setting>

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"

<setting type="text" id="test01" label="32001" default=""/>


<setting type="text" id="test02" label="32002" default="" option="hidden"/>


<setting type="text" id="test03" label="32003" default="" option="urlencoded"/>


type="ipaddress"

<setting type="ipaddress" id="test04" label="32004"/>


type="number"

<setting type="number" id="test05" label="32005"/>

type="date"

<setting type="date" id="test06" label="32006" default="2015-03-12"/>


type="time"

<setting type="time" id="test07" label="32007" default="13:13"/>


type="bool"

<setting type="bool" id="test08" label="32008" default="false"/>


type="select"

<setting type="select" id="test09" label="32009" lvalues="11|12|13|14"/>


<setting type="select" id="test10" label="32010" values="aa|bb|cc|dd"/>


type="addon"

<setting type="addon" id="test11" label="32011" default="" addontype="xbmc.metadata.scraper.movies"/>


<setting type="addon" id="test12" label="32012" default="" addontype="xbmc.metadata.scraper.movies" multiselect="true"/>


type="enum"

<setting type="enum" id="test13" label="32013" lvalues="11|12|13|14"/>


<setting type="enum" id="test14" label="32014" values="aa|bb|cc|dd"/>

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.

<setting type="labelenum" id="test15" label="32015" lvalues="11|12|13|14"/>


<setting type="labelenum" id="test16" label="32016" values="bb|aa|dd|cc" sort="yes"/>

type="slider"

<setting type="slider" id="test17" label="32017" default="20" range="5,5,100" option="int"/>


<setting type="slider" id="test18" label="32018" default="0.5" range="0.0,0.1,1.0" option="float"/>


<setting type="slider" id="test19" label="32019" default="20" range="0,1,100" option="percent"/>


type="file"

<setting type="file" id="test20" label="32020" default=""/>


type="audio"

<setting type="audio" id="test21" label="32021" default=""/>


type="video"

<setting type="video" id="test22" label="32022" default=""/>


type="image"

<setting type="image" id="test23" label="32023" default=""/>


type="executable"

<setting type="executable" id="test24" label="32024" default=""/>


type="folder"

<setting type="folder" id="test25" label="32025" default=""/>


<setting type="folder" id="test26" label="32026" default="" option="writeable"/>


<setting type="folder" id="test27" label="32027" default="" source="videos"/>


<setting type="folder" id="test28" label="32028" default="" source="music"/>


<setting type="folder" id="test29" label="32029" default="" source="pictures"/>


<setting type="folder" id="test30" label="32030" default="" source="programs"/>


<setting type="folder" id="test31" label="32031" default="" source="files"/>


<setting type="folder" id="test32" label="32032" default="" source="local"/>


type="action"

<setting type="action" id="test33" label="32033" action="RunScript(script.globalsearch)" option="close"/>


<setting type="action" id="test34" label="32034" action="RunScript(weather.yahoo,Location1)" default=""/>

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.

<setting type="fileenum" id="test35" label="32035" values="resources"/>


<setting type="fileenum" id="test36" label="32036" values="resources" mask="/"/>


<setting type="fileenum" id="test37" label="32037" values="resources" mask="*.txt"/>

Subsetting

if you wish to define a subsetting, you can use the parent attribute with the id of the parent setting as the value.

<setting id="test37" type="path" label="32037" help="" parent="test36">


Conditions

visible

if a setting should always be hidden, you can add this to the setting

<visible>false</visible>

if a settings should be conditionallly visible, add a dependency tag to your setting

<dependency type="visible" setting=""></dependency>


enable

if a settings should be conditionallly enabled, add a dependency tag to your setting

<dependency type="enable" setting=""></dependency>


eq / lt / gt

eq

compare to a bool value of another setting

<dependency type="enable" setting="test01">true</dependency>

compare to a int value of another setting

<dependency type="enable" setting="test01">5</dependency>

compare to a string value of another setting

<dependency type="enable" setting="test01">something</dependency>

!eq

<dependency type="enable" operator="!is" setting="test01">true</dependency>
<dependency type="enable" operator="!is" setting="test01">0</dependency>
<dependency type="enable" operator="!is" setting="test01"></dependency>

lt

<dependency type="enable" operator="lt" setting="test01">5</dependency>

gt

<dependency type="enable" operator="gt" setting="test01">0</dependency>

and / or

multiple dependencies can be defined as such

<dependency type="enable">
	<and>
		<condition setting=""></condition>
		<condition setting=""></condition>
	</and>
</dependency>
<dependency type="enable">
	<or>
		<condition setting=""></condition>
		<condition setting=""></condition>
	</or>
</dependency>