Add-on structure - Revision history

Karellen: point to language portal

2022-04-10T01:17:46Z

point to language portal

← Older revision		Revision as of 01:17, 10 April 2022
Line 276:		Line 276:

	'''Translation tools:'''		'''Translation tools:'''
	* [[Language ~~support]]~~		* [[Language portal\|Languages & Translations]]
	* [[Translations]]
	* Convert .xml to .po: [https://github.com/alanwww1/xbmc-xml2po xbmc-xml2po]		* Convert .xml to .po: [https://github.com/alanwww1/xbmc-xml2po xbmc-xml2po]
	* Check for .po files: [https://github.com/alanwww1/xbmc-checkpo xbmc-checkpo]		* Check for .po files: [https://github.com/alanwww1/xbmc-checkpo xbmc-checkpo]

Gade: /* resources/language/ */

2021-07-16T07:24:49Z

resources/language/

← Older revision		Revision as of 07:24, 16 July 2021
Line 280:		Line 280:
	* Convert .xml to .po: [https://github.com/alanwww1/xbmc-xml2po xbmc-xml2po]		* Convert .xml to .po: [https://github.com/alanwww1/xbmc-xml2po xbmc-xml2po]
	* Check for .po files: [https://github.com/alanwww1/xbmc-checkpo xbmc-checkpo]		* Check for .po files: [https://github.com/alanwww1/xbmc-checkpo xbmc-checkpo]
	* ~~Utility for keeping Kodi upstream language files~~ and ~~the~~ language files ~~hosted on transifex~~.com ~~in sync~~: [https://github.com/~~alanwww1~~/~~xbmc~~-~~txupdate xbmc~~-~~txupdate~~]		* Script to sync metadata (description, summary and disclaimer) between addon.xml and language files: [https://github.com/xbmc/sync_addon_metadata_translations sync_addon_metadata_translations]
			* Script to bump addon.xml versions and add news/changelog entry, when Weblate pull requests are merged: [https://github.com/xbmc/weblate-supplementary-scripts weblate-supplementary-scripts]

	'''String ID range:'''		'''String ID range:'''
			* strings 30000 thru 30999 reserved for plugins and plugin settings
	* strings 31000 thru 31999 reserved for skins		* 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

	'''strings.po'''		'''strings.po'''

	{{~~note~~\|~~strings~~.xml ~~will possibly be deprecated after~~ the ~~release of Frodo/Gotham~~. ~~Frodo and Gotham will still be backwards compatible with~~ .~~xml~~}}		{{warning\|1=Strings.xml support was completely removed from v19 Matrix. Addons should update and comply to the strings.po file from now on.}}

	==== resources/lib/ ====		==== resources/lib/ ====

Karellen at 07:11, 16 July 2021

2021-07-16T07:11:44Z

← Older revision		Revision as of 07:11, 16 July 2021
Line 277:		Line 277:
	'''Translation tools:'''		'''Translation tools:'''
	* [[Language support]]		* [[Language support]]
	* [[~~Translation System~~]]		* [[Translations]]
	* Convert .xml to .po: [https://github.com/alanwww1/xbmc-xml2po xbmc-xml2po]		* Convert .xml to .po: [https://github.com/alanwww1/xbmc-xml2po xbmc-xml2po]
	* Check for .po files: [https://github.com/alanwww1/xbmc-checkpo xbmc-checkpo]		* Check for .po files: [https://github.com/alanwww1/xbmc-checkpo xbmc-checkpo]

Ronie: /* Directory Name */

2020-08-03T16:09:56Z

Directory Name

← Older revision		Revision as of 16:09, 3 August 2020
Line 39:		Line 39:
	\|-		\|-
	\|<code>resource</code>		\|<code>resource</code>
	\|An addon that will provide additional files (language files, images, [[sounds.xml\|uisounds]]).		\|An addon that will provide additional files (language files, images, fonts, [[sounds.xml\|uisounds]]).
	\|No		\|No
	\|}		\|}

Enen92: Relax requirements for screenshots and banners

2020-04-09T14:52:28Z

Relax requirements for screenshots and banners

← Older revision		Revision as of 14:52, 9 April 2020
Line 246:		Line 246:
	'''''Specifications''''' {{anchor\|screenshot_specifications}}		'''''Specifications''''' {{anchor\|screenshot_specifications}}

	* Image must be in the jpeg formats sized 1280x720 or 1920x1080		* Image must be in the jpeg or png formats sized 1280x720 or 1920x1080
	* Image must be 750KB or less		* Image must be 750KB or less
	* Image must have '''no transparency'''		* Image must have '''no transparency'''
Line 259:		Line 259:
	'''''Specifications''''' {{anchor\|banner_specifications}}		'''''Specifications''''' {{anchor\|banner_specifications}}

	* Images must be in jpeg image ~~format~~ sized '''1000x185''' pixels, no exceptions		* Images must be in jpeg or png image formats sized '''1000x185''' pixels, no exceptions

	==== resources/clearlogo.png (optional) {{anchor\|clearlogo_element}} ====		==== resources/clearlogo.png (optional) {{anchor\|clearlogo_element}} ====

Anxdpanic at 14:33, 27 March 2020

2020-03-27T14:33:25Z

← Older revision		Revision as of 14:33, 27 March 2020
Line 234:		Line 234:
	* It is intended for the background, so should be simple and without text where reasonable.		* It is intended for the background, so should be simple and without text where reasonable.
	* Image must be 1MB or less		* Image must be 1MB or less
	* Image must be jpeg or png¹. ¹PNG can only be used with Krypton ~~or greater~~		* Image must be jpeg or png¹. ¹PNG can only be used with Krypton and later
	* Image must be 1280x720, 1920x1080 or 3840x2160		* Image must be 1280x720, 1920x1080 or 3840x2160
	* We recommend a 1280x720 image. It should certainly be no larger than 3840x2160.		* We recommend a 1280x720 image. It should certainly be no larger than 3840x2160.

Anxdpanic: Update fanart.jpg and screenshot-x.jpg requirements

2020-03-27T12:16:38Z

Update fanart.jpg and screenshot-x.jpg requirements

← Older revision		Revision as of 12:16, 27 March 2020
Line 233:		Line 233:
	* It should be 16:9 aspect ratio		* It should be 16:9 aspect ratio
	* It is intended for the background, so should be simple and without text where reasonable.		* It is intended for the background, so should be simple and without text where reasonable.
	* We recommend a 1280x720 ~~JPEG~~ image. It should certainly be no larger than ~~1920x1080~~.		* Image must be 1MB or less
			* Image must be jpeg or png¹. ¹PNG can only be used with Krypton or greater
			* Image must be 1280x720, 1920x1080 or 3840x2160
			* We recommend a 1280x720 image. It should certainly be no larger than 3840x2160.
	* We recommend keeping it as small as is reasonable with respect to file-size. Remember that hundreds of thousands of users are going to be downloading this.		* We recommend keeping it as small as is reasonable with respect to file-size. Remember that hundreds of thousands of users are going to be downloading this.

Line 244:		Line 247:

	* Image must be in the jpeg formats sized 1280x720 or 1920x1080		* Image must be in the jpeg formats sized 1280x720 or 1920x1080
			* Image must be 750KB or less
	* Image must have '''no transparency'''		* Image must have '''no transparency'''
	* Addons can include a maximum of 10 screenshots		* Addons can include a maximum of 10 screenshots

Karellen: /* fanart.jpg */

2020-03-08T22:39:58Z

fanart.jpg

← Older revision		Revision as of 22:39, 8 March 2020
Line 185:		Line 185:
	=== fanart.jpg ===		=== fanart.jpg ===

	{{warning\|1='''Only addons for versions of Kodi below v17 Krypton must contain the fanart.jpg file in the root of the addon directory.''' Kodi 17 Krypton and above is able to use any other directory in the addon structure (preference for '''[[Add-on_structure#<resources~~/fanart~~.jpg>\|resources/fanart.jpg]]''') and be listed in '''[[Addon.xml#<assets>\|addon.xml assets]]'''}}		{{warning\|1='''Only addons for versions of Kodi below v17 Krypton must contain the fanart.jpg file in the root of the addon directory.''' Kodi 17 Krypton and above is able to use any other directory in the addon structure (preference for '''[[Add-on_structure#resources.2Ffanart.jpg\|resources/fanart.jpg]]''') and be listed in '''[[Addon.xml#<assets>\|addon.xml assets]]'''}}

	This helps to keep Kodi graphically rich when browsing and using add-ons. See the [[#fanart_specifications\|fanart.jpg specifications]].		This helps to keep Kodi graphically rich when browsing and using add-ons. See the [[#fanart_specifications\|fanart.jpg specifications]].

Karellen: /* icon.png */

2020-03-08T22:37:11Z

icon.png

← Older revision		Revision as of 22:37, 8 March 2020
Line 179:		Line 179:
	=== icon.png ===		=== icon.png ===

	{{warning\|1='''Only addons for versions of Kodi below v17 Krypton must contain the icon.png file in the root of the addon directory.''' Kodi 17 Krypton and above is able to use any other directory in the addon structure (preference for '''[[Add-on_structure#<resources~~/icon~~.png>\|resources/icon.png]]''') and be listed in '''[[Addon.xml#<assets>\|addon.xml assets]]''' }}		{{warning\|1='''Only addons for versions of Kodi below v17 Krypton must contain the icon.png file in the root of the addon directory.''' Kodi 17 Krypton and above is able to use any other directory in the addon structure (preference for '''[[Add-on_structure#resources.2Ficon.png\|resources/icon.png]]''') and be listed in '''[[Addon.xml#<assets>\|addon.xml assets]]''' }}

	This is an icon used to represent your add-on in various parts of Kodi. See the [[#icon_specifications\|icon.png specifications]].		This is an icon used to represent your add-on in various parts of Kodi. See the [[#icon_specifications\|icon.png specifications]].

Enen92: Change screenshot anchor

2020-03-08T21:40:03Z

Change screenshot anchor

← Older revision		Revision as of 21:40, 8 March 2020
Line 241:		Line 241:
	This '''optional art type''' helps to keep Kodi graphically rich when using the addon browser or the addon website. Addons can define up to 10 screenshots (4 is advised). This is accomplished through the repetition of the <code><screenshot></code> element of '''[[Addon.xml#<assets>\|addon.xml assets]]''' each pointing to a different image. Screenshot images can be placed anywhere in the addon directory (and have any arbitrary name) as long as they point to an existing file in '''[[Addon.xml#<assets>\|addon.xml assets]]'''. screenshot-x.png is just an example naming convention.		This '''optional art type''' helps to keep Kodi graphically rich when using the addon browser or the addon website. Addons can define up to 10 screenshots (4 is advised). This is accomplished through the repetition of the <code><screenshot></code> element of '''[[Addon.xml#<assets>\|addon.xml assets]]''' each pointing to a different image. Screenshot images can be placed anywhere in the addon directory (and have any arbitrary name) as long as they point to an existing file in '''[[Addon.xml#<assets>\|addon.xml assets]]'''. screenshot-x.png is just an example naming convention.

	'''''Specifications''''' {{anchor\|~~screen_specifications~~}}		'''''Specifications''''' {{anchor\|screenshot_specifications}}

	* Image must be in the jpeg formats sized 1280x720 or 1920x1080		* Image must be in the jpeg formats sized 1280x720 or 1920x1080