HOW-TO:Script addon - Revision history

NahsiN: tutorial link points to python3 which is now default in kodi

2024-01-17T13:21:59Z

tutorial link points to python3 which is now default in kodi

← Older revision		Revision as of 13:21, 17 January 2024
Line 2:		Line 2:

	This page will outline the basics of creating your first Python script for Kodi. It assumes you're at least familiar with the basics of Python.<br />		This page will outline the basics of creating your first Python script for Kodi. It assumes you're at least familiar with the basics of Python.<br />
	If not, we recommend visiting the [~~http~~://docs.python.org/2/tutorial/ Python tutorial] first, and then returning here.		If not, we recommend visiting the [https://docs.python.org/3/tutorial/index.html Python tutorial] first, and then returning here.

	While a python script can do many things, this tutorial is aimed at creating a window in Kodi.		While a python script can do many things, this tutorial is aimed at creating a window in Kodi.

Ronie: /* Other options */

2020-05-25T11:43:10Z

Other options

← Older revision		Revision as of 11:43, 25 May 2020
Line 211:		Line 211:

	if (__name__ == '__main__'):		if (__name__ == '__main__'):
	# ~~[kodi 18]~~ media windows ~~use~~ the built-in container ~~by default~~, so do not set the fifth argument (it defaults to False) ~~as we are not going to use it~~		# media windows only have one builtin list and we need two, therefor we're not using the built-in container, so do not set the fifth argument (it defaults to False)
	ui = GUI('script-testwindow.xml', CWD, 'default', '1080p')		ui = GUI('script-testwindow.xml', CWD, 'default', '1080p')
	ui.doModal()		ui.doModal()
Line 232:		Line 232:
	</window>		</window>
	</syntaxhighlight>		</syntaxhighlight>


	= Download =		= Download =

Ronie: /* Your default.py file */

2020-05-25T11:41:01Z

Your default.py file

Ronie at 20:54, 14 October 2019

2019-10-14T20:54:09Z

← Older revision		Revision as of 20:54, 14 October 2019
Line 233:		Line 233:
	</window>		</window>
	</syntaxhighlight>		</syntaxhighlight>


			= Download =

			You can download this test addon here: <br />
			[https://gitlab.com/ronie/script.testwindow script.testwindow]

Ronie: /* Your default.py file */

2019-10-14T20:44:39Z

Your default.py file

← Older revision		Revision as of 20:44, 14 October 2019
Line 62:		Line 62:
	# get the full path to your addon, decode it to unicode to handle special (non-ascii) characters in the path		# get the full path to your addon, decode it to unicode to handle special (non-ascii) characters in the path
	CWD = ADDON.getAddonInfo('path').decode('utf-8')		CWD = ADDON.getAddonInfo('path').decode('utf-8')
			#CWD = ADDON.getAddonInfo('path') # for kodi 19 and up..

	# add a class to create your xml based window		# add a class to create your xml based window

Davu at 12:37, 10 July 2018

2018-07-10T12:37:28Z

← Older revision		Revision as of 12:37, 10 July 2018
Line 26:		Line 26:

	This is what your addon.xml will need to look like (the bare minimum):		This is what your addon.xml will need to look like (the bare minimum):
	<syntaxhighlight lang="xml" enclose="div">		<syntaxhighlight lang=xml enclose="div">
	<?xml version="1.0" encoding="UTF-8" standalone="yes"?>		<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<addon id="script.testwindow" name="test window" version="0.0.1" provider-name="me">		<addon id="script.testwindow" name="test window" version="0.0.1" provider-name="me">
Line 51:		Line 51:
	Remember these are just the bare basics to get you started, many more options are available to enhance your window.		Remember these are just the bare basics to get you started, many more options are available to enhance your window.

	<syntaxhighlight lang="python" enclose="div">		<syntaxhighlight lang=python enclose="div">
	# import the kodi python modules we are going to use		# import the kodi python modules we are going to use
	# see the kodi api docs to find out what functionality each module provides		# see the kodi api docs to find out what functionality each module provides
Line 121:		Line 121:
	The subject of skinning is outside of the scope of this tutorial, so please refer for the kodi skinning manual for details.		The subject of skinning is outside of the scope of this tutorial, so please refer for the kodi skinning manual for details.

	<syntaxhighlight lang="xml" enclose="div">		<syntaxhighlight lang=xml enclose="div">
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<window>		<window>
Line 176:		Line 176:
	Here's is an example of a window with two custom containers (only commenting on the differences to the example above):		Here's is an example of a window with two custom containers (only commenting on the differences to the example above):

	<syntaxhighlight lang="python" enclose="div">		<syntaxhighlight lang=python enclose="div">
	import xbmc		import xbmc
	import xbmcgui		import xbmcgui
Line 219:		Line 219:

	The xml code you need for two containers looks like this:		The xml code you need for two containers looks like this:
	<syntaxhighlight lang="xml" enclose="div">		<syntaxhighlight lang=xml enclose="div">
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<window>		<window>

Ronie at 21:28, 28 May 2018

2018-05-28T21:28:27Z

← Older revision		Revision as of 21:28, 28 May 2018
Line 72:		Line 72:
	# until now we have a blank window, the onInit function will parse your xml file		# until now we have a blank window, the onInit function will parse your xml file
	def onInit(self):		def onInit(self):
			# select a view mode, '50' in our case, as defined in the skin file
			xbmc.executebuiltin('Container.SetViewMode(50)')
	# define a temporary list where we are going to add all the listitems to		# define a temporary list where we are going to add all the listitems to
	listitems = []		listitems = []

Ronie: /* Your default.py file */

2018-03-22T09:10:06Z

Your default.py file

← Older revision		Revision as of 09:10, 22 March 2018
Line 105:		Line 105:
	# now open your window. the window will be shown until you close your addon		# now open your window. the window will be shown until you close your addon
	ui.doModal()		ui.doModal()
	# window closed, now cleanup a bit: delete your window before the fully ~~script~~ exits		# window closed, now cleanup a bit: delete your window before the script fully exits
	del ui		del ui

Ronie: /* Other options */

2018-01-27T16:53:18Z

Other options

← Older revision		Revision as of 16:53, 27 January 2018
Line 209:		Line 209:

	if (__name__ == '__main__'):		if (__name__ == '__main__'):
	# media windows use the built-in container by default, so set ~~that~~ argument to False as we are not going to use it		# [kodi 18] media windows use the built-in container by default, so do not set the fifth argument (it defaults to False) as we are not going to use it
	~~# (you can also omit it, as it is defaults to False)~~		ui = GUI('script-testwindow.xml', CWD, 'default', '1080p')
	ui = GUI('script-testwindow.xml', CWD, 'default', '1080p'~~, False~~)
	ui.doModal()		ui.doModal()
	del ui		del ui

Ronie: /* Your default.py file */

2018-01-27T16:52:58Z

Your default.py file

← Older revision		Revision as of 16:52, 27 January 2018
Line 98:		Line 98:
	# 3 'the name of the folder that contains the skin',		# 3 'the name of the folder that contains the skin',
	# 4 'the name of the folder that contains the skin xml files'		# 4 'the name of the folder that contains the skin xml files'
	# 5 [kodi 18] 'set to True for a media window (a window that will list music / videos / pictures), set to False otherwise		# 5 [kodi 18] set to True for a media window (a window that will list music / videos / pictures), set to False otherwise
	# 6 [optional] if you need to pass additional data to your window, simply add them to the list		# 6 [optional] if you need to pass additional data to your window, simply add them to the list
	# you'll have to add them as key=value pairs: key1=value1, key2=value2, etc...		# you'll have to add them as key=value pairs: key1=value1, key2=value2, etc...

← Older revision		Revision as of 11:41, 25 May 2020
Line 96:		Line 96:
	# this is the entry point of your addon, execution of your script will start here		# this is the entry point of your addon, execution of your script will start here
	if (__name__ == '__main__'):		if (__name__ == '__main__'):
	# define your xml window and pass these ~~four (kodi 17) or~~ five ~~(kodi 18)~~ arguments (more optional items can be passed as well):		# define your xml window and pass these five arguments (more optional items can be passed as well):
	# 1 'the name of the xml file for this window',		# 1 'the name of the xml file for this window',
	# 2 'the path to your addon',		# 2 'the path to your addon',
	# 3 'the name of the folder that contains the skin',		# 3 'the name of the folder that contains the skin',
	# 4 'the name of the folder that contains the skin xml files'		# 4 'the name of the folder that contains the skin xml files'
	# 5 ~~[kodi 18]~~ set to True for a media window (a window that will list music / videos / pictures), set to False otherwise		# 5 set to True for a media window (a single list window that will list music / videos / pictures), set to False otherwise
	# 6 [optional] if you need to pass additional data to your window, simply add them to the list		# 6 [optional] if you need to pass additional data to your window, simply add them to the list
	# you'll have to add them as key=value pairs: key1=value1, key2=value2, etc...		# you'll have to add them as key=value pairs: key1=value1, key2=value2, etc...
	ui = GUI('script-testwindow.xml', CWD, 'default', '1080i', True, optional1='some data') ~~# for kodi 18 and up..~~		ui = GUI('script-testwindow.xml', CWD, 'default', '1080i', True, optional1='some data')
	~~# ui = GUI('script-testwindow.xml', CWD, 'default', '1080i', optional1='some data') # use this line instead for kodi 17 and earlier~~
	# now open your window. the window will be shown until you close your addon		# now open your window. the window will be shown until you close your addon
	ui.doModal()		ui.doModal()