Add-on introduction - Revision history

Ronie at 00:17, 18 August 2020

2020-08-18T00:17:00Z

← Older revision		Revision as of 00:17, 18 August 2020
Line 144:		Line 144:
	[[Category:How-to]]		[[Category:How-to]]
	[[Category:Add-on development]]		[[Category:Add-on development]]
	~~[[Category:Skin development]]~~

Gamester17 at 18:21, 26 October 2018

2018-10-26T18:21:01Z

← Older revision		Revision as of 18:21, 26 October 2018
Line 133:		Line 133:
	* [[Add-ons]]		* [[Add-ons]]
	* [[:Category:All add-ons]]		* [[:Category:All add-ons]]
	* [[~~3rd party~~ add-on repositories]]		* [[Unofficial add-on repositories]]
	'''Development:'''		'''Development:'''
	* [[Add-on development]]		* [[Add-on development]]

NedBot: Bot: Automated text replacement (- XBMC + Kodi )

2015-05-04T08:21:26Z

Bot: Automated text replacement (- XBMC + Kodi )

NedBot: Robot: Substituting template: Name

2014-06-05T20:32:56Z

Robot: Substituting template: Name

NedBot: Bot: Automated text replacement (-XBMC +{{name}})

2014-06-05T00:56:11Z

Bot: Automated text replacement (-XBMC +{{name}})

NedBot: Robot: Changing Category:Addon Development to Category:Add-on development

2014-04-23T19:10:15Z

Robot: Changing Category:Addon Development to Category:Add-on development

← Older revision		Revision as of 19:10, 23 April 2014
Line 143:		Line 143:

	[[Category:How-to]]		[[Category:How-to]]
	[[Category:~~Addon Development~~]]		[[Category:Add-on development]]
	[[Category:Skin development]]		[[Category:Skin development]]

NedBot: Robot: Changing Category:Skin Development to Category:Skin development

2014-04-23T19:00:34Z

Robot: Changing Category:Skin Development to Category:Skin development

← Older revision		Revision as of 19:00, 23 April 2014
Line 144:		Line 144:
	[[Category:How-to]]		[[Category:How-to]]
	[[Category:Addon Development]]		[[Category:Addon Development]]
	[[Category:Skin ~~Development~~]]		[[Category:Skin development]]

Ned Scott: /* See also */

2014-04-15T01:21:42Z

Ned Scott: Ned Scott moved page Add-on Introduction to Add-on introduction: caps

2013-12-10T09:13:50Z

Ned Scott moved page Add-on Introduction to Add-on introduction: caps

← Older revision	Revision as of 09:13, 10 December 2013
(No difference)

Martijn at 22:09, 31 August 2013

2013-08-31T22:09:51Z

← Older revision		Revision as of 22:09, 31 August 2013
Line 1:		Line 1:
	<br />		{{mininav\|[[Development]]\|[[Add-on development]]}}<br />

	= Introduction =		= Introduction =

← Older revision		Revision as of 08:21, 4 May 2015
Line 5:		Line 5:
	== Purpose ==		== Purpose ==

	• to provide a guide for would be ~~XBMC~~ Python plugin addon script developers		• to provide a guide for would be Kodi Python plugin addon script developers
	• to provide the skeleton frameworks to enable script developers to get up and running quickly		• to provide the skeleton frameworks to enable script developers to get up and running quickly
	• to provide links to authoritative sources of information for script developers		• to provide links to authoritative sources of information for script developers
Line 13:		Line 13:

	• This document does not try to teach you how to program in Python		• This document does not try to teach you how to program in Python
	• This document does not cover developing for the core ~~XBMC~~ system		• This document does not cover developing for the core Kodi system


Line 33:		Line 33:
	• Some knowledge of application development, particularly in a GUI environment		• Some knowledge of application development, particularly in a GUI environment
	• Knowledge of Python scripting		• Knowledge of Python scripting
	• Installed version of ~~XBMC~~ 10 (Dharma) minimum – you do not need the development		• Installed version of Kodi 10 (Dharma) minimum – you do not need the development
	source version		source version

Line 40:		Line 40:

	The development user		The development user
	This document assumes for the purposes of illustration, that the user that you installed ~~XBMC~~ with		This document assumes for the purposes of illustration, that the user that you installed Kodi with
	is 'xbmc' and that that user has all rights to the /home/xbmc directory. Please bear this in mind if		is 'xbmc' and that that user has all rights to the /home/xbmc directory. Please bear this in mind if
	you installed under a different user name on your box.		you installed under a different user name on your box.
	In addition you may want to set up another user on the ~~XBMC~~ server that you will use to login as		In addition you may want to set up another user on the Kodi server that you will use to login as
	the developer. This user should have sudo rights on a Linux based system. This is your		the developer. This user should have sudo rights on a Linux based system. This is your
	development user.		development user.
Line 54:		Line 54:

	Using a separate development environment is by far the easiest and preferred method of		Using a separate development environment is by far the easiest and preferred method of
	development. You will need to install ~~XBMC~~ on your local machine and run it there. In some		development. You will need to install Kodi on your local machine and run it there. In some
	senses this is not a bad idea as you can install a plain vanilla ~~XBMC~~ and concentrate on		senses this is not a bad idea as you can install a plain vanilla Kodi and concentrate on
	developing and testing your addon in isolation, moving it to your 'production' machine for final		developing and testing your addon in isolation, moving it to your 'production' machine for final
	integration testing and thence on into the wild. In this case you can install XBMC1 as your		integration testing and thence on into the wild. In this case you can install XBMC1 as your
Line 64:		Line 64:


	== Local working on the ~~XBMC~~ server ==		== Local working on the Kodi server ==

	This scenario is similar to working on a local machine except that you will need to install a		This scenario is similar to working on a local machine except that you will need to install a
	window manager (Linux machines), run ~~XBMC~~ in a window and connect a keyboard and mouse		window manager (Linux machines), run Kodi in a window and connect a keyboard and mouse
	to the machine (there are some nice wireless keyboards with touchpads about, Toshiba among		to the machine (there are some nice wireless keyboards with touchpads about, Toshiba among
	others do one.) Otherwise the set-up is the same as for a local PC installation.		others do one.) Otherwise the set-up is the same as for a local PC installation.


	== Remote working to an ~~XBMC~~ server ==		== Remote working to an Kodi server ==
	In this scenario you are going to use your ~~XBMC~~ server to run your code on, but use another		In this scenario you are going to use your Kodi server to run your code on, but use another
	machine to do the coding from. You need to be able to access the server from the local machine.		machine to do the coding from. You need to be able to access the server from the local machine.
	Running ~~XBMC~~ under windows?		Running Kodi under windows?
	- share the xbmc user directory and set permissions for your development user to read and write		- share the xbmc user directory and set permissions for your development user to read and write
	to the directory and its subdirectories		to the directory and its subdirectories
	Running ~~XBMC~~ under Linux?		Running Kodi under Linux?
	- Perhaps the easiest way to do this is to set the file permissions on /home/xbmc to allow the		- Perhaps the easiest way to do this is to set the file permissions on /home/xbmc to allow the
	group to read and write, enrol your development user name in the xbmc group. Set the sticky		group to read and write, enrol your development user name in the xbmc group. Set the sticky
Line 88:		Line 88:
	sudo useradd -G xbmc your_dev_user_name		sudo useradd -G xbmc your_dev_user_name
	Then logon via ssh (or sftp) from your working machine. Alternatively, install Samba and set up		Then logon via ssh (or sftp) from your working machine. Alternatively, install Samba and set up
	the shares so that you can access your ~~XBMC~~ installation as any user. Ref to Samba docs		the shares so that you can access your Kodi installation as any user. Ref to Samba docs
	In either OS, set up permanent mappings from your working machine to the ~~XBMC~~ server so		In either OS, set up permanent mappings from your working machine to the Kodi server so
	that your editors etc, can see the files		that your editors etc, can see the files

← Older revision		Revision as of 20:32, 5 June 2014
Line 5:		Line 5:
	== Purpose ==		== Purpose ==

	• to provide a guide for would be ~~{{name}}~~ Python plugin addon script developers		• to provide a guide for would be XBMC Python plugin addon script developers
	• to provide the skeleton frameworks to enable script developers to get up and running quickly		• to provide the skeleton frameworks to enable script developers to get up and running quickly
	• to provide links to authoritative sources of information for script developers		• to provide links to authoritative sources of information for script developers
Line 13:		Line 13:

	• This document does not try to teach you how to program in Python		• This document does not try to teach you how to program in Python
	• This document does not cover developing for the core ~~{{name}}~~ system		• This document does not cover developing for the core XBMC system


Line 33:		Line 33:
	• Some knowledge of application development, particularly in a GUI environment		• Some knowledge of application development, particularly in a GUI environment
	• Knowledge of Python scripting		• Knowledge of Python scripting
	• Installed version of ~~{{name}}~~ 10 (Dharma) minimum – you do not need the development		• Installed version of XBMC 10 (Dharma) minimum – you do not need the development
	source version		source version

Line 40:		Line 40:

	The development user		The development user
	This document assumes for the purposes of illustration, that the user that you installed ~~{{name}}~~ with		This document assumes for the purposes of illustration, that the user that you installed XBMC with
	is 'xbmc' and that that user has all rights to the /home/xbmc directory. Please bear this in mind if		is 'xbmc' and that that user has all rights to the /home/xbmc directory. Please bear this in mind if
	you installed under a different user name on your box.		you installed under a different user name on your box.
	In addition you may want to set up another user on the ~~{{name}}~~ server that you will use to login as		In addition you may want to set up another user on the XBMC server that you will use to login as
	the developer. This user should have sudo rights on a Linux based system. This is your		the developer. This user should have sudo rights on a Linux based system. This is your
	development user.		development user.
Line 54:		Line 54:

	Using a separate development environment is by far the easiest and preferred method of		Using a separate development environment is by far the easiest and preferred method of
	development. You will need to install ~~{{name}}~~ on your local machine and run it there. In some		development. You will need to install XBMC on your local machine and run it there. In some
	senses this is not a bad idea as you can install a plain vanilla ~~{{name}}~~ and concentrate on		senses this is not a bad idea as you can install a plain vanilla XBMC and concentrate on
	developing and testing your addon in isolation, moving it to your 'production' machine for final		developing and testing your addon in isolation, moving it to your 'production' machine for final
	integration testing and thence on into the wild. In this case you can install ~~{{name}}1~~ as your		integration testing and thence on into the wild. In this case you can install XBMC1 as your
	normal logged on user and you shouldn't need to worry about file permissions etc. You can run		normal logged on user and you shouldn't need to worry about file permissions etc. You can run
	~~{{name}}~~ in a window to see the results of your work. (Go to System Settings - System Settings –		XBMC in a window to see the results of your work. (Go to System Settings - System Settings –
	Video Output and set Display Mode to Windowed.) Having a dual screen set-up can be very		Video Output and set Display Mode to Windowed.) Having a dual screen set-up can be very
	beneficial in this scenario.		beneficial in this scenario.


	== Local working on the ~~{{name}}~~ server ==		== Local working on the XBMC server ==

	This scenario is similar to working on a local machine except that you will need to install a		This scenario is similar to working on a local machine except that you will need to install a
	window manager (Linux machines), run ~~{{name}}~~ in a window and connect a keyboard and mouse		window manager (Linux machines), run XBMC in a window and connect a keyboard and mouse
	to the machine (there are some nice wireless keyboards with touchpads about, Toshiba among		to the machine (there are some nice wireless keyboards with touchpads about, Toshiba among
	others do one.) Otherwise the set-up is the same as for a local PC installation.		others do one.) Otherwise the set-up is the same as for a local PC installation.


	== Remote working to an ~~{{name}}~~ server ==		== Remote working to an XBMC server ==
	In this scenario you are going to use your ~~{{name}}~~ server to run your code on, but use another		In this scenario you are going to use your XBMC server to run your code on, but use another
	machine to do the coding from. You need to be able to access the server from the local machine.		machine to do the coding from. You need to be able to access the server from the local machine.
	Running ~~{{name}}~~ under windows?		Running XBMC under windows?
	- share the xbmc user directory and set permissions for your development user to read and write		- share the xbmc user directory and set permissions for your development user to read and write
	to the directory and its subdirectories		to the directory and its subdirectories
	Running ~~{{name}}~~ under Linux?		Running XBMC under Linux?
	- Perhaps the easiest way to do this is to set the file permissions on /home/xbmc to allow the		- Perhaps the easiest way to do this is to set the file permissions on /home/xbmc to allow the
	group to read and write, enrol your development user name in the xbmc group. Set the sticky		group to read and write, enrol your development user name in the xbmc group. Set the sticky
Line 88:		Line 88:
	sudo useradd -G xbmc your_dev_user_name		sudo useradd -G xbmc your_dev_user_name
	Then logon via ssh (or sftp) from your working machine. Alternatively, install Samba and set up		Then logon via ssh (or sftp) from your working machine. Alternatively, install Samba and set up
	the shares so that you can access your ~~{{name}}~~ installation as any user. Ref to Samba docs		the shares so that you can access your XBMC installation as any user. Ref to Samba docs
	In either OS, set up permanent mappings from your working machine to the ~~{{name}}~~ server so		In either OS, set up permanent mappings from your working machine to the XBMC server so
	that your editors etc, can see the files		that your editors etc, can see the files

← Older revision		Revision as of 00:56, 5 June 2014
Line 5:		Line 5:
	== Purpose ==		== Purpose ==

	• to provide a guide for would be ~~XBMC~~ Python plugin addon script developers		• to provide a guide for would be {{name}} Python plugin addon script developers
	• to provide the skeleton frameworks to enable script developers to get up and running quickly		• to provide the skeleton frameworks to enable script developers to get up and running quickly
	• to provide links to authoritative sources of information for script developers		• to provide links to authoritative sources of information for script developers
Line 13:		Line 13:

	• This document does not try to teach you how to program in Python		• This document does not try to teach you how to program in Python
	• This document does not cover developing for the core ~~XBMC~~ system		• This document does not cover developing for the core {{name}} system


Line 33:		Line 33:
	• Some knowledge of application development, particularly in a GUI environment		• Some knowledge of application development, particularly in a GUI environment
	• Knowledge of Python scripting		• Knowledge of Python scripting
	• Installed version of ~~XBMC~~ 10 (Dharma) minimum – you do not need the development		• Installed version of {{name}} 10 (Dharma) minimum – you do not need the development
	source version		source version

Line 40:		Line 40:

	The development user		The development user
	This document assumes for the purposes of illustration, that the user that you installed ~~XBMC~~ with		This document assumes for the purposes of illustration, that the user that you installed {{name}} with
	is 'xbmc' and that that user has all rights to the /home/xbmc directory. Please bear this in mind if		is 'xbmc' and that that user has all rights to the /home/xbmc directory. Please bear this in mind if
	you installed under a different user name on your box.		you installed under a different user name on your box.
	In addition you may want to set up another user on the ~~XBMC~~ server that you will use to login as		In addition you may want to set up another user on the {{name}} server that you will use to login as
	the developer. This user should have sudo rights on a Linux based system. This is your		the developer. This user should have sudo rights on a Linux based system. This is your
	development user.		development user.
Line 54:		Line 54:

	Using a separate development environment is by far the easiest and preferred method of		Using a separate development environment is by far the easiest and preferred method of
	development. You will need to install ~~XBMC~~ on your local machine and run it there. In some		development. You will need to install {{name}} on your local machine and run it there. In some
	senses this is not a bad idea as you can install a plain vanilla ~~XBMC~~ and concentrate on		senses this is not a bad idea as you can install a plain vanilla {{name}} and concentrate on
	developing and testing your addon in isolation, moving it to your 'production' machine for final		developing and testing your addon in isolation, moving it to your 'production' machine for final
	integration testing and thence on into the wild. In this case you can install ~~XBMC1~~ as your		integration testing and thence on into the wild. In this case you can install {{name}}1 as your
	normal logged on user and you shouldn't need to worry about file permissions etc. You can run		normal logged on user and you shouldn't need to worry about file permissions etc. You can run
	~~XBMC~~ in a window to see the results of your work. (Go to System Settings - System Settings –		{{name}} in a window to see the results of your work. (Go to System Settings - System Settings –
	Video Output and set Display Mode to Windowed.) Having a dual screen set-up can be very		Video Output and set Display Mode to Windowed.) Having a dual screen set-up can be very
	beneficial in this scenario.		beneficial in this scenario.


	== Local working on the ~~XBMC~~ server ==		== Local working on the {{name}} server ==

	This scenario is similar to working on a local machine except that you will need to install a		This scenario is similar to working on a local machine except that you will need to install a
	window manager (Linux machines), run ~~XBMC~~ in a window and connect a keyboard and mouse		window manager (Linux machines), run {{name}} in a window and connect a keyboard and mouse
	to the machine (there are some nice wireless keyboards with touchpads about, Toshiba among		to the machine (there are some nice wireless keyboards with touchpads about, Toshiba among
	others do one.) Otherwise the set-up is the same as for a local PC installation.		others do one.) Otherwise the set-up is the same as for a local PC installation.


	== Remote working to an ~~XBMC~~ server ==		== Remote working to an {{name}} server ==
	In this scenario you are going to use your ~~XBMC~~ server to run your code on, but use another		In this scenario you are going to use your {{name}} server to run your code on, but use another
	machine to do the coding from. You need to be able to access the server from the local machine.		machine to do the coding from. You need to be able to access the server from the local machine.
	Running ~~XBMC~~ under windows?		Running {{name}} under windows?
	- share the xbmc user directory and set permissions for your development user to read and write		- share the xbmc user directory and set permissions for your development user to read and write
	to the directory and its subdirectories		to the directory and its subdirectories
	Running ~~XBMC~~ under Linux?		Running {{name}} under Linux?
	- Perhaps the easiest way to do this is to set the file permissions on /home/xbmc to allow the		- Perhaps the easiest way to do this is to set the file permissions on /home/xbmc to allow the
	group to read and write, enrol your development user name in the xbmc group. Set the sticky		group to read and write, enrol your development user name in the xbmc group. Set the sticky
Line 88:		Line 88:
	sudo useradd -G xbmc your_dev_user_name		sudo useradd -G xbmc your_dev_user_name
	Then logon via ssh (or sftp) from your working machine. Alternatively, install Samba and set up		Then logon via ssh (or sftp) from your working machine. Alternatively, install Samba and set up
	the shares so that you can access your ~~XBMC~~ installation as any user. Ref to Samba docs		the shares so that you can access your {{name}} installation as any user. Ref to Samba docs
	In either OS, set up permanent mappings from your working machine to the ~~XBMC~~ server so		In either OS, set up permanent mappings from your working machine to the {{name}} server so
	that your editors etc, can see the files		that your editors etc, can see the files

← Older revision		Revision as of 01:21, 15 April 2014
Line 143:		Line 143:

	[[Category:How-to]]		[[Category:How-to]]
	~~[[Category:Settings]]~~
	~~[[Category:Add-ons]]~~
	[[Category:Addon Development]]		[[Category:Addon Development]]
	[[Category:Skin Development]]		[[Category:Skin Development]]
	~~[[Category:Development]]~~