Difference between revisions of "Script lyrics"

From Official Kodi Wiki
Jump to: navigation, search
m (Text replacement - "xbmcaddon module" to "xbmcaddon module")
 
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
==What XBMC requires for your add-on==
+
{{mininav|[[Development]]|[[Add-on development]]}}
For XBMC to know what to do with your add-on, we require your script, and an addon.xml file. See [[Add-ons for XBMC (Developement)|here]] for more information on addon.xml, including how you add descriptions to your addon for users. A plugin source extends XBMC via the xbmc.python.lyrics extension point. The layout of the XML describing this extension point is as follows:
+
==What Kodi requires for your add-on==
 +
For XBMC to know what to do with your add-on, we require your script, and an addon.xml file. See [[Add-on development|here]] for more information on addon.xml, including how you add descriptions to your addon for users. A plugin source extends XBMC via the xbmc.python.lyrics extension point. The layout of the XML describing this extension point is as follows:
  
<source lang="xml">
+
<syntaxhighlight lang="xml" enclose="div">
 
   <extension point="xbmc.python.lyrics"
 
   <extension point="xbmc.python.lyrics"
 
             library="default.py" />
 
             library="default.py" />
</source>
+
</syntaxhighlight>
  
 
list of extension points and their explanation:
 
list of extension points and their explanation:
Line 20: Line 21:
  
 
Example of "xbmc.python.lyrics":
 
Example of "xbmc.python.lyrics":
<source lang="xml">
+
<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.cu.lyrics"
 
<addon id="script.cu.lyrics"
Line 37: Line 38:
 
   </extension>
 
   </extension>
 
</addon>
 
</addon>
</source>
+
</syntaxhighlight>
  
==Interacting with XBMC==
+
== Interacting with XBMC ==
Given that your script can return information to the user, you may wish to allow some (or all) of the information you provide to be translatable. You do this by providing a strings.xml file (in resources/language/<name_of_language>/strings.xml) which associates integer id's with each label. XBMC then handles loading these string files and ensuring that the users' locale information is taken into account. To display strings you use the '''getString''' function in the [[xbmcaddon module|xbmcaddon module]].
+
Given that your script can return information to the user, you may wish to allow some (or all) of the information you provide to be translatable. You do this by providing a strings.xml file (in resources/language/<name_of_language>/strings.xml) which associates integer id's with each label. XBMC then handles loading these string files and ensuring that the users' locale information is taken into account. To display strings you use the '''getString''' function in the xbmcaddon module.
  
[[Category:Add-ons]]
+
== See also ==
[[Category:Development]]
+
* [[Add-ons]]
 +
* [[Unofficial add-on repositories]]
 +
'''Development:'''
 +
* [[Add-on development]]
 +
* [[Addon Settings]]
 +
* [[Add-on repositories]]
 +
* [[Official add-on repository]]
 +
 
 +
 
 +
[[Category:Python]]
 +
[[Category:Add-on development]]

Latest revision as of 01:00, 22 July 2020

Home icon grey.png   ▶ Development ▶ Add-on development ▶ Script lyrics

1 What Kodi requires for your add-on

For XBMC to know what to do with your add-on, we require your script, and an addon.xml file. See here for more information on addon.xml, including how you add descriptions to your addon for users. A plugin source extends XBMC via the xbmc.python.lyrics extension point. The layout of the XML describing this extension point is as follows:

  <extension point="xbmc.python.lyrics"
             library="default.py" />

list of extension points and their explanation:

  "xbmc.python.script"          This is the standard Script extension point

below listed extensions will not appear in the Scripts/Programs window and can only be run via skin shortcuts

  "xbmc.python.weather"        Used for weather scripts
  "xbmc.python.subtitles"      Used for subtitle scripts
  "xbmc.python.lyrics"         Used for lyrics scripts
  "xbmc.python.library"        Used for skin dependent scripts (e.g. recently added script)


Example of "xbmc.python.lyrics":

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="script.cu.lyrics"
       name="CU Lyrics"
       version="0.8.6"
       provider-name="Amet">
  <requires>
    <import addon="xbmc.python" version="1.0"/>
  </requires>
  <extension point="xbmc.python.lyrics"
             library="default.py" />
  <extension point="xbmc.addon.metadata">
    <summary lang="en">CU Lyrics</summary>
    <description lang="en">Search, download and display lyrics from LyricWIKI.org. Downloaded lyrics will be saved in userdata/addon_data.Lyrics button on OSD needs to be activated and path set to CU Lyrics under Settings-> Skin-> Scripts </description>
    <platform>all</platform>
  </extension>
</addon>

2 Interacting with XBMC

Given that your script can return information to the user, you may wish to allow some (or all) of the information you provide to be translatable. You do this by providing a strings.xml file (in resources/language/<name_of_language>/strings.xml) which associates integer id's with each label. XBMC then handles loading these string files and ensuring that the users' locale information is taken into account. To display strings you use the getString function in the xbmcaddon module.

3 See also

Development: