Official Kodi Wiki - User contributions [en]

User talk:Kibtest2

2019-11-06T19:16:13Z

Kibje: Welcome!

'''Welcome to ''Official Kodi Wiki''!'''
We hope you will contribute much and well.
You will probably want to read the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents help pages].
Again, welcome and have fun! [[User:Kibje|Kibje]] ([[User talk:Kibje|talk]]) 19:16, 6 November 2019 (UTC)

User talk:Kibtest

2019-11-06T18:49:18Z

Kibje: Welcome!

DevCon

2019-10-11T07:19:23Z

Kibje: /* Currently happening: 2019 (Serbia) */

{{mininav|[[Team Kodi]]|[[Events]]}}

The Kodi developers conference is where Team Kodi members gather to discuss and handle various Kodi related business. It is one of the few times where Team members meet up in real life.
{{-}}
__NONUMBEREDHEADINGS__
<div class="nonumtoc">__TOC__</div>
{{-}}
== 2019 (Serbia) - currently underway ==
'''Location:''' Belgrade, Serbia

'''Date:''' October 11-13

{{-}}

== 2018 (Bulgaria) ==
[[File:Devcon 20180930 Sofia Bulgaria.jpg|600px|thumb|right]]

'''Location:''' Sofia, Bulgaria

'''Date:''' September 28-30

* https://kodi.tv/article/devcon-2018-sofia-part-i
* https://kodi.tv/article/devcon-2018-sofia-part-ii
* https://kodi.tv/article/devcon-2018-sofia-part-iii

{{-}}

== 2017 (Czech Republic) ==
[[File:DevCon2017IITeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Prague, Czech Republic

'''Date:''' October 27-29

* https://kodi.tv/article/devcon-2017-part-ii-day-one
* https://kodi.tv/article/devcon-2017-part-ii-day-two
* https://kodi.tv/article/devcon-2017-part-ii-day-three

{{-}}

== 2017 (Portugal) ==
[[File:DevCon2017TeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Porto, Portugal

'''Date:''' May 5th - 7th

* https://kodi.tv/article/devcon-2017-day-one
* https://kodi.tv/article/devcon-2017-day-two
* https://kodi.tv/article/devcon-2017-day-three
* https://kodi.tv/article/kodis-2017-developers-conference
* http://forum.kodi.tv/showthread.php?tid=311585

{{-}}

== 2016 (Hungary) ==
[[File:DevCon2016Teamfoto2.jpg|600px|right|thumb]]

'''Location:''' Budapest, Hungary

'''Date:''' October 10th - 12th

* https://kodi.tv/article/kodi-devcon-2016-live-blog

{{-}}

== 2015 (Czech Republic) ==
[[File:Devcon2015.jpg|600px|right|thumb|<section begin="2016 photo"/>Top: alwinus, jjd-uk, keith, razze, ksoo, zag<br/>Middle: ruuk, koying, montellese, mkortstiege, , phil65, martijn<br/>Bottom: natethomas, paxxi, garbear, ansii, wisler, negge, hitcher, bignoid, fkoch, kib<section end="2016 photo"/>]]
'''Location:''' Prague, Czech Republic

'''Date:''' October 7th - 9th

* https://kodi.tv/article/devcon-2015-liveblog

{{-}}

== 2014 (Portugal) ==
[[File:DevCon2014.jpg|500px|right|thumb]]

'''Location:''' Lisbon, Portugal

'''Date:''' October 10th - 12th

* http://kodi.tv/kodi-devcon-2014-live-blog/

{{-}}

== 2013 (Germany) ==
[[File:2013 DevCon.jpg|600px|right|thumb|<section begin="2013 photo"/>The team in Munich<section end="2012 photo"/>]]
'''Location:''' Munich, Germany

'''Date:''' October 11th - 13th

* http://kodi.tv/xbmc-devcon-2013/

{{-}}

== 2012 (Austria) ==
[[File:Devcon2012.JPG|right|600px|thumb|<section begin="2012 photo"/>From left to right: topfs2, da-anda, Martijn, fneufneu, sraue, benjee , Memphiz, Wiso, Montellese, chadoe, Davilla, jfcarrol, cptspiff, amet, vdrfan, olympia, anssi, alanwww1, jmarshall, TheUni, Clumsy, Freezy, natethomas<section end="2012 photo"/>]]
Vienna, sponsored by at-visions
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://xbmc.us/njbetzen/2012/08/30/xbmc-devcon-liveblog/
* http://kodi.tv/devcon-2012-user-meetup/
* http://www.at-visions.com/XBMC-conference-in-Vienna.html

Photos and videos:
* http://www.flickr.com/photos/23449328@N05/sets/72157631428716214/
* http://www.youtube.com/watch?v=jJBhe7arBlk

{{-}}

== 2010 (Austria) ==
[[File:XBMC-DevCon-2010-Attendees-resized.png|right|600px|thumb|<section begin="2010devcon"/>From left to right: Amet (Zeljko), Andy (at-visions), freezy (Nico), clumsy (Thomas), topfs2 (Tobias), chadoe (Martin), jmarshall (Jonathan) (TOP)/unknown (BOTTOM), elupus (Joakim), vdrfan (Matthias), prae5 (Paul), davilla (Scott), WiSo (Winfried), malloc (Sean), Malard (Martin), TheUni (Cory), Michael (at-visions), Olympia (Bence), Ronen (at-visions CEO) (TOP)/lcapriotti (Luigi) (BOTTOM), spiff (Dr. Arne), Lucas (at-visions)<section end="2010devcon"/>]]
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://kodi.tv/devcon-2010/
* http://kodi.tv/xbmc-devcon-2010-summary/
{{-}}

== 2009 (Germany) ==
[[File:2009 DevCon.jpg|right|600px|thumb|From left to right: Erez, Pike, Yuvalt, WiSo, vulkanr, vdrfan, elupus, blittan, chadoe, MaestroDD]]
Berlin
* http://kodi.tv/results-of-xbmc-developers-conference/
{{-}}

== 2008 (Netherlands) ==
[[File:2008 DevCon.jpg|right|600px|thumb|]]
'''Location:''' Amsterdam, The Netherlands

'''Sponsored by:''' Boxee

* http://blip.tv/play/AcbtFgA
* http://www.bunniestudios.com/blog/?p=251
* https://www.flickr.com/photos/27660056@N07/sets/72157605632155509/
{{-}}

[[Category:Events]]

DevCon

2019-10-11T07:19:00Z

Kibje: /* UPCOMING: 2019 (Serbia) */

{{mininav|[[Team Kodi]]|[[Events]]}}

The Kodi developers conference is where Team Kodi members gather to discuss and handle various Kodi related business. It is one of the few times where Team members meet up in real life.
{{-}}
__NONUMBEREDHEADINGS__
<div class="nonumtoc">__TOC__</div>
{{-}}
== Currently happening: 2019 (Serbia) ==
'''Location:''' Belgrade, Serbia

'''Date:''' October 11-13

{{-}}

== 2018 (Bulgaria) ==
[[File:Devcon 20180930 Sofia Bulgaria.jpg|600px|thumb|right]]

'''Location:''' Sofia, Bulgaria

'''Date:''' September 28-30

* https://kodi.tv/article/devcon-2018-sofia-part-i
* https://kodi.tv/article/devcon-2018-sofia-part-ii
* https://kodi.tv/article/devcon-2018-sofia-part-iii

{{-}}

== 2017 (Czech Republic) ==
[[File:DevCon2017IITeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Prague, Czech Republic

'''Date:''' October 27-29

* https://kodi.tv/article/devcon-2017-part-ii-day-one
* https://kodi.tv/article/devcon-2017-part-ii-day-two
* https://kodi.tv/article/devcon-2017-part-ii-day-three

{{-}}

== 2017 (Portugal) ==
[[File:DevCon2017TeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Porto, Portugal

'''Date:''' May 5th - 7th

* https://kodi.tv/article/devcon-2017-day-one
* https://kodi.tv/article/devcon-2017-day-two
* https://kodi.tv/article/devcon-2017-day-three
* https://kodi.tv/article/kodis-2017-developers-conference
* http://forum.kodi.tv/showthread.php?tid=311585

{{-}}

== 2016 (Hungary) ==
[[File:DevCon2016Teamfoto2.jpg|600px|right|thumb]]

'''Location:''' Budapest, Hungary

'''Date:''' October 10th - 12th

* https://kodi.tv/article/kodi-devcon-2016-live-blog

{{-}}

== 2015 (Czech Republic) ==
[[File:Devcon2015.jpg|600px|right|thumb|<section begin="2016 photo"/>Top: alwinus, jjd-uk, keith, razze, ksoo, zag<br/>Middle: ruuk, koying, montellese, mkortstiege, , phil65, martijn<br/>Bottom: natethomas, paxxi, garbear, ansii, wisler, negge, hitcher, bignoid, fkoch, kib<section end="2016 photo"/>]]
'''Location:''' Prague, Czech Republic

'''Date:''' October 7th - 9th

* https://kodi.tv/article/devcon-2015-liveblog

{{-}}

== 2014 (Portugal) ==
[[File:DevCon2014.jpg|500px|right|thumb]]

'''Location:''' Lisbon, Portugal

'''Date:''' October 10th - 12th

* http://kodi.tv/kodi-devcon-2014-live-blog/

{{-}}

== 2013 (Germany) ==
[[File:2013 DevCon.jpg|600px|right|thumb|<section begin="2013 photo"/>The team in Munich<section end="2012 photo"/>]]
'''Location:''' Munich, Germany

'''Date:''' October 11th - 13th

* http://kodi.tv/xbmc-devcon-2013/

{{-}}

== 2012 (Austria) ==
[[File:Devcon2012.JPG|right|600px|thumb|<section begin="2012 photo"/>From left to right: topfs2, da-anda, Martijn, fneufneu, sraue, benjee , Memphiz, Wiso, Montellese, chadoe, Davilla, jfcarrol, cptspiff, amet, vdrfan, olympia, anssi, alanwww1, jmarshall, TheUni, Clumsy, Freezy, natethomas<section end="2012 photo"/>]]
Vienna, sponsored by at-visions
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://xbmc.us/njbetzen/2012/08/30/xbmc-devcon-liveblog/
* http://kodi.tv/devcon-2012-user-meetup/
* http://www.at-visions.com/XBMC-conference-in-Vienna.html

Photos and videos:
* http://www.flickr.com/photos/23449328@N05/sets/72157631428716214/
* http://www.youtube.com/watch?v=jJBhe7arBlk

{{-}}

== 2010 (Austria) ==
[[File:XBMC-DevCon-2010-Attendees-resized.png|right|600px|thumb|<section begin="2010devcon"/>From left to right: Amet (Zeljko), Andy (at-visions), freezy (Nico), clumsy (Thomas), topfs2 (Tobias), chadoe (Martin), jmarshall (Jonathan) (TOP)/unknown (BOTTOM), elupus (Joakim), vdrfan (Matthias), prae5 (Paul), davilla (Scott), WiSo (Winfried), malloc (Sean), Malard (Martin), TheUni (Cory), Michael (at-visions), Olympia (Bence), Ronen (at-visions CEO) (TOP)/lcapriotti (Luigi) (BOTTOM), spiff (Dr. Arne), Lucas (at-visions)<section end="2010devcon"/>]]
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://kodi.tv/devcon-2010/
* http://kodi.tv/xbmc-devcon-2010-summary/
{{-}}

== 2009 (Germany) ==
[[File:2009 DevCon.jpg|right|600px|thumb|From left to right: Erez, Pike, Yuvalt, WiSo, vulkanr, vdrfan, elupus, blittan, chadoe, MaestroDD]]
Berlin
* http://kodi.tv/results-of-xbmc-developers-conference/
{{-}}

== 2008 (Netherlands) ==
[[File:2008 DevCon.jpg|right|600px|thumb|]]
'''Location:''' Amsterdam, The Netherlands

'''Sponsored by:''' Boxee

* http://blip.tv/play/AcbtFgA
* http://www.bunniestudios.com/blog/?p=251
* https://www.flickr.com/photos/27660056@N07/sets/72157605632155509/
{{-}}

[[Category:Events]]

DevCon

2019-09-04T20:23:08Z

Kibje: added note about next DevCon

{{mininav|[[Team Kodi]]|[[Events]]}}

The Kodi developers conference is where Team Kodi members gather to discuss and handle various Kodi related business. It is one of the few times where Team members meet up in real life.
{{-}}
__NONUMBEREDHEADINGS__
<div class="nonumtoc">__TOC__</div>
{{-}}
== UPCOMING: 2019 (Serbia) ==
'''Location:''' Belgrade, Serbia

'''Date:''' October 11-13

{{-}}
== 2018 (Bulgaria) ==
[[File:Devcon 20180930 Sofia Bulgaria.jpg|600px|thumb|right]]

'''Location:''' Sofia, Bulgaria

'''Date:''' September 28-30

* https://kodi.tv/article/devcon-2018-sofia-part-i
* https://kodi.tv/article/devcon-2018-sofia-part-ii
* https://kodi.tv/article/devcon-2018-sofia-part-iii

{{-}}

== 2017 (Czech Republic) ==
[[File:DevCon2017IITeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Prague, Czech Republic

'''Date:''' October 27-29

* https://kodi.tv/article/devcon-2017-part-ii-day-one
* https://kodi.tv/article/devcon-2017-part-ii-day-two
* https://kodi.tv/article/devcon-2017-part-ii-day-three

{{-}}

== 2017 (Portugal) ==
[[File:DevCon2017TeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Porto, Portugal

'''Date:''' May 5th - 7th

* https://kodi.tv/article/devcon-2017-day-one
* https://kodi.tv/article/devcon-2017-day-two
* https://kodi.tv/article/devcon-2017-day-three
* https://kodi.tv/article/kodis-2017-developers-conference
* http://forum.kodi.tv/showthread.php?tid=311585

{{-}}

== 2016 (Hungary) ==
[[File:DevCon2016Teamfoto2.jpg|600px|right|thumb]]

'''Location:''' Budapest, Hungary

'''Date:''' October 10th - 12th

* https://kodi.tv/article/kodi-devcon-2016-live-blog

{{-}}

== 2015 (Czech Republic) ==
[[File:Devcon2015.jpg|600px|right|thumb|<section begin="2016 photo"/>Top: alwinus, jjd-uk, keith, razze, ksoo, zag<br/>Middle: ruuk, koying, montellese, mkortstiege, , phil65, martijn<br/>Bottom: natethomas, paxxi, garbear, ansii, wisler, negge, hitcher, bignoid, fkoch, kib<section end="2016 photo"/>]]
'''Location:''' Prague, Czech Republic

'''Date:''' October 7th - 9th

* https://kodi.tv/article/devcon-2015-liveblog

{{-}}

== 2014 (Portugal) ==
[[File:DevCon2014.jpg|500px|right|thumb]]

'''Location:''' Lisbon, Portugal

'''Date:''' October 10th - 12th

* http://kodi.tv/kodi-devcon-2014-live-blog/

{{-}}

== 2013 (Germany) ==
[[File:2013 DevCon.jpg|600px|right|thumb|<section begin="2013 photo"/>The team in Munich<section end="2012 photo"/>]]
'''Location:''' Munich, Germany

'''Date:''' October 11th - 13th

* http://kodi.tv/xbmc-devcon-2013/

{{-}}

== 2012 (Austria) ==
[[File:Devcon2012.JPG|right|600px|thumb|<section begin="2012 photo"/>From left to right: topfs2, da-anda, Martijn, fneufneu, sraue, benjee , Memphiz, Wiso, Montellese, chadoe, Davilla, jfcarrol, cptspiff, amet, vdrfan, olympia, anssi, alanwww1, jmarshall, TheUni, Clumsy, Freezy, natethomas<section end="2012 photo"/>]]
Vienna, sponsored by at-visions
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://xbmc.us/njbetzen/2012/08/30/xbmc-devcon-liveblog/
* http://kodi.tv/devcon-2012-user-meetup/
* http://www.at-visions.com/XBMC-conference-in-Vienna.html

Photos and videos:
* http://www.flickr.com/photos/23449328@N05/sets/72157631428716214/
* http://www.youtube.com/watch?v=jJBhe7arBlk

{{-}}

== 2010 (Austria) ==
[[File:XBMC-DevCon-2010-Attendees-resized.png|right|600px|thumb|<section begin="2010devcon"/>From left to right: Amet (Zeljko), Andy (at-visions), freezy (Nico), clumsy (Thomas), topfs2 (Tobias), chadoe (Martin), jmarshall (Jonathan) (TOP)/unknown (BOTTOM), elupus (Joakim), vdrfan (Matthias), prae5 (Paul), davilla (Scott), WiSo (Winfried), malloc (Sean), Malard (Martin), TheUni (Cory), Michael (at-visions), Olympia (Bence), Ronen (at-visions CEO) (TOP)/lcapriotti (Luigi) (BOTTOM), spiff (Dr. Arne), Lucas (at-visions)<section end="2010devcon"/>]]
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://kodi.tv/devcon-2010/
* http://kodi.tv/xbmc-devcon-2010-summary/
{{-}}

== 2009 (Germany) ==
[[File:2009 DevCon.jpg|right|600px|thumb|From left to right: Erez, Pike, Yuvalt, WiSo, vulkanr, vdrfan, elupus, blittan, chadoe, MaestroDD]]
Berlin
* http://kodi.tv/results-of-xbmc-developers-conference/
{{-}}

== 2008 (Netherlands) ==
[[File:2008 DevCon.jpg|right|600px|thumb|]]
'''Location:''' Amsterdam, The Netherlands

'''Sponsored by:''' Boxee

* http://blip.tv/play/AcbtFgA
* http://www.bunniestudios.com/blog/?p=251
* https://www.flickr.com/photos/27660056@N07/sets/72157605632155509/
{{-}}

[[Category:Events]]

Leia

2019-09-04T20:18:11Z

Kibje:

Leia is the codename the v18 release of Kodi.
For more information please check the pages below.

* [[Kodi v18 (Leia) FAQ]]
* [[Kodi v18 (Leia) changelog]]
* [[Leia API changes]]

[[Category:Leia|*]]

Kodi Foundation

2019-06-17T22:41:42Z

Kibje: removed autogenerated 'similar page names' that were not similar

{{mininav}}
<section begin=intro />The "'''XBMC Foundation'''" is the non-profit organization that oversees the [[Kodi|{{kodi}}]] project and is registered in the US.<section end=intro />

== Members ==
Membership of the XBMC Foundation is typically taken from members of [[Team Kodi]], but may include non Team members.
* [[/Member list]]

== Board of Directors ==
{| class="infobox"
|-
|
<section begin=Foundation members />
* '''Keith Herrington (keith)''' - Board member - ''Term: 11/2016 - 11/2020''
* '''Martijn Kaijser (Martijn)''' - Board member - ''Term: 11/2013 - 11/2019''
* '''Ejal de Klerk (Kib)''' - Board member - ''Term: 11/2017 - 11/2019''
* '''Lukas Rusak (lrusak)''' - Board member - ''Term: 11/2018 - 11/2020''
* '''Darren Hill (DarrenHill)''' - Board member - ''Term: 11/2018 - 11/2020''
<section end=Foundation members />
|}
The XBMC Board of Directors are Foundation members that manages the XBMC Foundation. The Board consists of five seats that are chosen by vote from the XBMC Foundation members. The Board's responsibilities include management of funds, publicity, and all business related issues (taxes, communication with other businesses, maintaining non-profit status etc.)
{{-}}

== Board of Directors meetings ==
The Board meets about once a month (in addition to any special meetings as required) to discuss any business that needs to be handled by the foundation. Meetings are typically conducted via teleconference using a service such as Skype.

== Board of Directors elections ==
;Who can be an XBMC Board member?
:Any existing member of the foundation, as voted by the remaining members.

;How long does a board member hold office?
:Terms last for two years. We endeavor to have a staggered cycle so that not all board members are turned over at a single election. There are no term restrictions, so Board members may even run for consecutive terms. However, in the interests of sharing the load, any and all members are encouraged to participate.

;What is expected of an XBMC Board member?
:Board members are expected to attend all meetings or will otherwise be diligent in letting the other board members know if they won't be around. Further, they'll be expected to make decisions (as a group) in the best interests of the foundation. The Board accountable to the members, so should consider recommendations made by members during the decision making process, Though they ultimately must make the final decisions. Any and all discussion should be frankly communicated to members within a reasonable time frame.

;Who elects the officers (President, Secretary, Treasurer etc?)
:The board elects the officers. In doing so, they may choose to take advice from the membership, but the decision is theirs. The President must be from within the board itself, though Secretary, Treasurer, and any other officers the board wishes to appoint may be from outside the board (or outside the membership).

=== Election process ===

Board elections occur as follows:
# A member is nominated by the Board to oversee the election.
# Nominations for the open positions are taken from within the existing membership via email and/or via a forum thread. This lasts a minimum of 10 days.
# Confirmed nominees are placed on the ballot.
# A vote of the membership is then taken using a trusted internet voting service using a ranking system. (usually via the Condorcet Internet Voting Service, http://www.cs.cornell.edu/w8/~andru/civs ) and the candidates with the highest ranks take office. This lasts about two weeks.
#: ''In the event of a tie, it will be resolved with the existing board members discussing with the tied nominees. Tied nominees that do not go on the board may be nominated as officers of the Foundation, for example.''

=== Previous elections ===
* [[/Elections/2017|2017]]
* [[/Elections/2016|2016]]
* [[/Elections/2014|2014]]
* [[/Elections/2013|2013]]
* [[/Elections/2012|2012]]

== Foundation Bylaws and other important documents ==
* [[Media:ByLaws.pdf]]
* [[Media:Delaware Incorporation Notice.pdf]]
* [[Media:Delaware Notice Of Good Standing.pdf]]
* [[Media:KodiFoundationIncorporationNotice.pdf]]
* [[Media:Kodi_Foundation_exempt.jpg]]

== Trademarks ==
{{see|Official:Trademark Policy index}}

== Financial information ==

=== Financial status ===

* Form 990 2016 - http://www.guidestar.org/FinDocuments/2016/474/565/2016-474565769-0e36f6e3-9.pdf
* Income and expenses 2015 - https://drive.google.com/file/d/0BwsEEPRqIzELOVpUa0p4endrRWc/view?usp=sharing
* Income and expenses 2014 - https://drive.google.com/file/d/0BwsEEPRqIzELVW9rMkpPUWZRSHM/view?usp=sharing
* Income and expenses 2013 - https://docs.google.com/spreadsheet/ccc?key=0AtlJ3dnHcw46dHpmeXlIV0hGaC13Z3I3b25hZWhWRGc#gid=8

''note'': 2014 and 2015 expenses are US Foundation account only.

=== Account details ===

'''Europe bank account'''

* Bank: ING Netherlands
* Beneficiary: Kodi Foundation
* IBAN account: NL39 INGB 0006 6296 56
* BIC: INGBNL2A

'''Unites States account'''

* Bank: Wells Fargo
* Beneficiary: Kodi Foundation

== Legal representation ==
The XBMC Foundation is legally represented by the [[w:Software Freedom Law Center|SFLC (Software Freedom Law Center)]].

In addition the XBMC Foundation is member of [[w:Open_Invention_Network|OIN (Open Invention Network)]] since 9 July 2010. OIN is a defensive patent pool and community of patent non-aggression which enables freedom of action in Linux.

== Contact ==
For contact information, please see http://kodi.tv/about/contact/

[[Category:Team Kodi]]
[[Category:Team Kodi specific notes]]
[[Category:XBMC Foundation|*]]

DevCon

2018-10-02T18:59:09Z

Kibje: Czech Republic according to wikipedia

{{mininav|[[Team Kodi]]|[[Events]]}}

The Kodi developers conference is where Team Kodi members gather to discuss and handle various Kodi related business. It is one of the few times where Team members meet up in real life.
{{-}}
__NONUMBEREDHEADINGS__
<div class="nonumtoc">__TOC__</div>
{{-}}
== 2018 (Bulgaria) ==
[[File:Devcon 20180930 Sofia Bulgaria.jpg|600px|thumb|right]]

'''Location:''' Sofia, Bulgaria

'''Date:''' September 28-30

* https://kodi.tv/article/devcon-2018-sofia-part-i
* https://kodi.tv/article/devcon-2018-sofia-part-ii
* https://kodi.tv/article/devcon-2018-sofia-part-iii

{{-}}

== 2017 (Czech Republic) ==
[[File:DevCon2017IITeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Prague, Czech Republic

'''Date:''' October 27-29

* https://kodi.tv/article/devcon-2017-part-ii-day-one
* https://kodi.tv/article/devcon-2017-part-ii-day-two
* https://kodi.tv/article/devcon-2017-part-ii-day-three

{{-}}

== 2017 (Portugal) ==
[[File:DevCon2017TeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Porto, Portugal

'''Date:''' May 5th - 7th

* https://kodi.tv/article/devcon-2017-day-one
* https://kodi.tv/article/devcon-2017-day-two
* https://kodi.tv/article/devcon-2017-day-three
* https://kodi.tv/article/kodis-2017-developers-conference
* http://forum.kodi.tv/showthread.php?tid=311585

{{-}}

== 2016 (Hungary) ==
[[File:DevCon2016Teamfoto2.jpg|600px|right|thumb]]

'''Location:''' Budapest, Hungary

'''Date:''' October 10th - 12th

* https://kodi.tv/article/kodi-devcon-2016-live-blog

{{-}}

== 2015 (Czech Republic) ==
[[File:Devcon2015.jpg|600px|right|thumb|<section begin="2016 photo"/>Top: alwinus, jjd-uk, keith, razze, ksoo, zag<br/>Middle: ruuk, koying, montellese, mkortstiege, , phil65, martijn<br/>Bottom: natethomas, paxxi, garbear, ansii, wisler, negge, hitcher, bignoid, fkoch, kib<section end="2016 photo"/>]]
'''Location:''' Prague, Czech Republic

'''Date:''' October 7th - 9th

* https://kodi.tv/article/devcon-2015-liveblog

{{-}}

== 2014 (Portugal) ==
[[File:DevCon2014.jpg|500px|right|thumb]]

'''Location:''' Lisbon, Portugal

'''Date:''' October 10th - 12th

* http://kodi.tv/kodi-devcon-2014-live-blog/

{{-}}

== 2013 (Germany) ==
[[File:2013 DevCon.jpg|600px|right|thumb|<section begin="2013 photo"/>The team in Munich<section end="2012 photo"/>]]
'''Location:''' Munich, Germany

'''Date:''' October 11th - 13th

* http://kodi.tv/xbmc-devcon-2013/

{{-}}

== 2012 (Austria) ==
[[File:Devcon2012.JPG|right|600px|thumb|<section begin="2012 photo"/>From left to right: topfs2, da-anda, Martijn, fneufneu, sraue, benjee , Memphiz, Wiso, Montellese, chadoe, Davilla, jfcarrol, cptspiff, amet, vdrfan, olympia, anssi, alanwww1, jmarshall, TheUni, Clumsy, Freezy, natethomas<section end="2012 photo"/>]]
Vienna, sponsored by at-visions
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://xbmc.us/njbetzen/2012/08/30/xbmc-devcon-liveblog/
* http://kodi.tv/devcon-2012-user-meetup/
* http://www.at-visions.com/XBMC-conference-in-Vienna.html

Photos and videos:
* http://www.flickr.com/photos/23449328@N05/sets/72157631428716214/
* http://www.youtube.com/watch?v=jJBhe7arBlk

{{-}}

== 2010 (Austria) ==
[[File:XBMC-DevCon-2010-Attendees-resized.png|right|600px|thumb|<section begin="2010devcon"/>From left to right: Amet (Zeljko), Andy (at-visions), freezy (Nico), clumsy (Thomas), topfs2 (Tobias), chadoe (Martin), jmarshall (Jonathan) (TOP)/unknown (BOTTOM), elupus (Joakim), vdrfan (Matthias), prae5 (Paul), davilla (Scott), WiSo (Winfried), malloc (Sean), Malard (Martin), TheUni (Cory), Michael (at-visions), Olympia (Bence), Ronen (at-visions CEO) (TOP)/lcapriotti (Luigi) (BOTTOM), spiff (Dr. Arne), Lucas (at-visions)<section end="2010devcon"/>]]
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://kodi.tv/devcon-2010/
* http://kodi.tv/xbmc-devcon-2010-summary/
{{-}}

== 2009 (Germany) ==
[[File:2009 DevCon.jpg|right|600px|thumb|From left to right: Erez, Pike, Yuvalt, WiSo, vulkanr, vdrfan, elupus, blittan, chadoe, MaestroDD]]
Berlin
* http://kodi.tv/results-of-xbmc-developers-conference/
{{-}}

== 2008 (Netherlands) ==
[[File:2008 DevCon.jpg|right|600px|thumb|]]
'''Location:''' Amsterdam, The Netherlands

'''Sponsored by:''' Boxee

* http://blip.tv/play/AcbtFgA
* http://www.bunniestudios.com/blog/?p=251
* https://www.flickr.com/photos/27660056@N07/sets/72157605632155509/
{{-}}

[[Category:Events]]

DevCon

2018-10-02T18:55:41Z

Kibje: fixes picture

{{mininav|[[Team Kodi]]|[[Events]]}}

The Kodi developers conference is where Team Kodi members gather to discuss and handle various Kodi related business. It is one of the few times where Team members meet up in real life.
{{-}}
__NONUMBEREDHEADINGS__
<div class="nonumtoc">__TOC__</div>
{{-}}
== 2018 (Bulgaria) ==
[[File:Devcon 20180930 Sofia Bulgaria.jpg|600px|thumb|right]]

'''Location:''' Sofia, Bulgaria

'''Date:''' September 28-30

* https://kodi.tv/article/devcon-2018-sofia-part-i
* https://kodi.tv/article/devcon-2018-sofia-part-ii
* https://kodi.tv/article/devcon-2018-sofia-part-iii

{{-}}

== 2017 (Czech) ==
[[File:DevCon2017IITeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Prague, Czech

'''Date:''' October 27-29

* https://kodi.tv/article/devcon-2017-part-ii-day-one
* https://kodi.tv/article/devcon-2017-part-ii-day-two
* https://kodi.tv/article/devcon-2017-part-ii-day-three

{{-}}

== 2017 (Portugal) ==
[[File:DevCon2017TeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Porto, Portugal

'''Date:''' May 5th - 7th

* https://kodi.tv/article/devcon-2017-day-one
* https://kodi.tv/article/devcon-2017-day-two
* https://kodi.tv/article/devcon-2017-day-three
* https://kodi.tv/article/kodis-2017-developers-conference
* http://forum.kodi.tv/showthread.php?tid=311585

{{-}}

== 2016 (Hungary) ==
[[File:DevCon2016Teamfoto2.jpg|600px|right|thumb]]

'''Location:''' Budapest, Hungary

'''Date:''' October 10th - 12th

* https://kodi.tv/article/kodi-devcon-2016-live-blog

{{-}}

== 2015 (Czech) ==
[[File:Devcon2015.jpg|600px|right|thumb|<section begin="2016 photo"/>Top: alwinus, jjd-uk, keith, razze, ksoo, zag<br/>Middle: ruuk, koying, montellese, mkortstiege, , phil65, martijn<br/>Bottom: natethomas, paxxi, garbear, ansii, wisler, negge, hitcher, bignoid, fkoch, kib<section end="2016 photo"/>]]
'''Location:''' Prague, Czech

'''Date:''' October 7th - 9th

* https://kodi.tv/article/devcon-2015-liveblog

{{-}}

== 2014 (Portugal) ==
[[File:DevCon2014.jpg|500px|right|thumb]]

'''Location:''' Lisbon, Portugal

'''Date:''' October 10th - 12th

* http://kodi.tv/kodi-devcon-2014-live-blog/

{{-}}

== 2013 (Germany) ==
[[File:2013 DevCon.jpg|600px|right|thumb|<section begin="2013 photo"/>The team in Munich<section end="2012 photo"/>]]
'''Location:''' Munich, Germany

'''Date:''' October 11th - 13th

* http://kodi.tv/xbmc-devcon-2013/

{{-}}

== 2012 (Austria) ==
[[File:Devcon2012.JPG|right|600px|thumb|<section begin="2012 photo"/>From left to right: topfs2, da-anda, Martijn, fneufneu, sraue, benjee , Memphiz, Wiso, Montellese, chadoe, Davilla, jfcarrol, cptspiff, amet, vdrfan, olympia, anssi, alanwww1, jmarshall, TheUni, Clumsy, Freezy, natethomas<section end="2012 photo"/>]]
Vienna, sponsored by at-visions
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://xbmc.us/njbetzen/2012/08/30/xbmc-devcon-liveblog/
* http://kodi.tv/devcon-2012-user-meetup/
* http://www.at-visions.com/XBMC-conference-in-Vienna.html

Photos and videos:
* http://www.flickr.com/photos/23449328@N05/sets/72157631428716214/
* http://www.youtube.com/watch?v=jJBhe7arBlk

{{-}}

== 2010 (Austria) ==
[[File:XBMC-DevCon-2010-Attendees-resized.png|right|600px|thumb|<section begin="2010devcon"/>From left to right: Amet (Zeljko), Andy (at-visions), freezy (Nico), clumsy (Thomas), topfs2 (Tobias), chadoe (Martin), jmarshall (Jonathan) (TOP)/unknown (BOTTOM), elupus (Joakim), vdrfan (Matthias), prae5 (Paul), davilla (Scott), WiSo (Winfried), malloc (Sean), Malard (Martin), TheUni (Cory), Michael (at-visions), Olympia (Bence), Ronen (at-visions CEO) (TOP)/lcapriotti (Luigi) (BOTTOM), spiff (Dr. Arne), Lucas (at-visions)<section end="2010devcon"/>]]
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://kodi.tv/devcon-2010/
* http://kodi.tv/xbmc-devcon-2010-summary/
{{-}}

== 2009 (Germany) ==
[[File:2009 DevCon.jpg|right|600px|thumb|From left to right: Erez, Pike, Yuvalt, WiSo, vulkanr, vdrfan, elupus, blittan, chadoe, MaestroDD]]
Berlin
* http://kodi.tv/results-of-xbmc-developers-conference/
{{-}}

== 2008 (Netherlands) ==
[[File:2008 DevCon.jpg|right|600px|thumb|]]
'''Location:''' Amsterdam, The Netherlands

'''Sponsored by:''' Boxee

* http://blip.tv/play/AcbtFgA
* http://www.bunniestudios.com/blog/?p=251
* https://www.flickr.com/photos/27660056@N07/sets/72157605632155509/
{{-}}

[[Category:Events]]

DevCon

2018-10-02T18:55:09Z

Kibje: Added DevCon 2018 information

{{mininav|[[Team Kodi]]|[[Events]]}}

The Kodi developers conference is where Team Kodi members gather to discuss and handle various Kodi related business. It is one of the few times where Team members meet up in real life.
{{-}}
__NONUMBEREDHEADINGS__
<div class="nonumtoc">__TOC__</div>
{{-}}
== 2018 (Bulgaria) ==
[[File:Devcon 20180930 Sofia Bulgaria.jpg|600px|thumb|right]]

'''Location:''' Sofia, Bulgaria

'''Date:''' September 28-30

* https://kodi.tv/article/devcon-2018-sofia-part-i
* https://kodi.tv/article/devcon-2018-sofia-part-ii
* https://kodi.tv/article/devcon-2018-sofia-part-iii

== 2017 (Czech) ==
[[File:DevCon2017IITeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Prague, Czech

'''Date:''' October 27-29

* https://kodi.tv/article/devcon-2017-part-ii-day-one
* https://kodi.tv/article/devcon-2017-part-ii-day-two
* https://kodi.tv/article/devcon-2017-part-ii-day-three

{{-}}

== 2017 (Portugal) ==
[[File:DevCon2017TeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Porto, Portugal

'''Date:''' May 5th - 7th

* https://kodi.tv/article/devcon-2017-day-one
* https://kodi.tv/article/devcon-2017-day-two
* https://kodi.tv/article/devcon-2017-day-three
* https://kodi.tv/article/kodis-2017-developers-conference
* http://forum.kodi.tv/showthread.php?tid=311585

{{-}}

== 2016 (Hungary) ==
[[File:DevCon2016Teamfoto2.jpg|600px|right|thumb]]

'''Location:''' Budapest, Hungary

'''Date:''' October 10th - 12th

* https://kodi.tv/article/kodi-devcon-2016-live-blog

{{-}}

== 2015 (Czech) ==
[[File:Devcon2015.jpg|600px|right|thumb|<section begin="2016 photo"/>Top: alwinus, jjd-uk, keith, razze, ksoo, zag<br/>Middle: ruuk, koying, montellese, mkortstiege, , phil65, martijn<br/>Bottom: natethomas, paxxi, garbear, ansii, wisler, negge, hitcher, bignoid, fkoch, kib<section end="2016 photo"/>]]
'''Location:''' Prague, Czech

'''Date:''' October 7th - 9th

* https://kodi.tv/article/devcon-2015-liveblog

{{-}}

== 2014 (Portugal) ==
[[File:DevCon2014.jpg|500px|right|thumb]]

'''Location:''' Lisbon, Portugal

'''Date:''' October 10th - 12th

* http://kodi.tv/kodi-devcon-2014-live-blog/

{{-}}

== 2013 (Germany) ==
[[File:2013 DevCon.jpg|600px|right|thumb|<section begin="2013 photo"/>The team in Munich<section end="2012 photo"/>]]
'''Location:''' Munich, Germany

'''Date:''' October 11th - 13th

* http://kodi.tv/xbmc-devcon-2013/

{{-}}

== 2012 (Austria) ==
[[File:Devcon2012.JPG|right|600px|thumb|<section begin="2012 photo"/>From left to right: topfs2, da-anda, Martijn, fneufneu, sraue, benjee , Memphiz, Wiso, Montellese, chadoe, Davilla, jfcarrol, cptspiff, amet, vdrfan, olympia, anssi, alanwww1, jmarshall, TheUni, Clumsy, Freezy, natethomas<section end="2012 photo"/>]]
Vienna, sponsored by at-visions
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://xbmc.us/njbetzen/2012/08/30/xbmc-devcon-liveblog/
* http://kodi.tv/devcon-2012-user-meetup/
* http://www.at-visions.com/XBMC-conference-in-Vienna.html

Photos and videos:
* http://www.flickr.com/photos/23449328@N05/sets/72157631428716214/
* http://www.youtube.com/watch?v=jJBhe7arBlk

{{-}}

== 2010 (Austria) ==
[[File:XBMC-DevCon-2010-Attendees-resized.png|right|600px|thumb|<section begin="2010devcon"/>From left to right: Amet (Zeljko), Andy (at-visions), freezy (Nico), clumsy (Thomas), topfs2 (Tobias), chadoe (Martin), jmarshall (Jonathan) (TOP)/unknown (BOTTOM), elupus (Joakim), vdrfan (Matthias), prae5 (Paul), davilla (Scott), WiSo (Winfried), malloc (Sean), Malard (Martin), TheUni (Cory), Michael (at-visions), Olympia (Bence), Ronen (at-visions CEO) (TOP)/lcapriotti (Luigi) (BOTTOM), spiff (Dr. Arne), Lucas (at-visions)<section end="2010devcon"/>]]
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://kodi.tv/devcon-2010/
* http://kodi.tv/xbmc-devcon-2010-summary/
{{-}}

== 2009 (Germany) ==
[[File:2009 DevCon.jpg|right|600px|thumb|From left to right: Erez, Pike, Yuvalt, WiSo, vulkanr, vdrfan, elupus, blittan, chadoe, MaestroDD]]
Berlin
* http://kodi.tv/results-of-xbmc-developers-conference/
{{-}}

== 2008 (Netherlands) ==
[[File:2008 DevCon.jpg|right|600px|thumb|]]
'''Location:''' Amsterdam, The Netherlands

'''Sponsored by:''' Boxee

* http://blip.tv/play/AcbtFgA
* http://www.bunniestudios.com/blog/?p=251
* https://www.flickr.com/photos/27660056@N07/sets/72157605632155509/
{{-}}

[[Category:Events]]

File:Devcon 20180930 Sofia Bulgaria.jpg

2018-10-02T18:54:07Z

Kibje:

The Kodi team at DevCon 2018

Help:Main page

2018-08-14T10:00:46Z

Kibje: irrellevant now

{{Wiki help navigation}}
{{divbox|orange||To edit the Kodi Wiki Manual just register for an account. Editing of certain pages may require an account that is a few days old and has made a hand full of edits. If you have any questions about editing or access to the Kodi Wiki, please leave a message on the [[forumtopic:35|Kodi help forum for website issues]], [[Talk:Main Page]], or drop by [irc://irc.freenode.net/kodi #kodi on freenode]}}

{{See also|Help:Notes for admins}}

This is for help with editing the Kodi Wiki Manual. For help with Kodi, please see the '''[[Main page]]'''.

==Wiki editing 101==
Here's some wiki editing 101 links from MediaWiki.org and Wikipedia. Most things that work on Wikipedia should also work on the Kodi Wiki Manual. If you see a feature or template on Wikipedia that you would like to use here then let us know on the '''[[forumtopic:35|Kodi help forum for website issues]]''' or '''[[Talk:Main Page]]'''.
*[[mw:Help:Editing pages]]
*[[w:Help:Contents/Editing Wikipedia]]
*[[w:Wikipedia:FAQ/Editing]]
*[[w:Wikipedia:Cheatsheet]]
*[[mw:Help:Starting a new page]]
*[[mw:Help:Images]]

==Tools==
*'''[[:Category:Templates]]-''' formatting and message templates that you can use on pages for various things.
*'''Gadgets-''' Go to the top of any page and click on "My preferences -> Gadgets" and check out some of the additional editing tools there, especially the '''wikEd''' option
*'''[[Special:SpecialPages]]''' contains a number of tools and reports to help with editing.
*Some additional functions on this wiki are documented via links at '''[[Special:Version]]'''.
*'''YouTube-''' To embed youtube videos (Kodi related videos only!) use <code><nowiki>{{</nowiki>[[Template:youtube|youtube]]|ID}}</code> where id= is the YouTube ID from the URL. For example, <code><nowiki>{{youtube|4NR57ELY28s}}</nowiki></code>. You can also define |height= and |width= (default is 569x320).
*'''Like/PlusOne-''' Add a Facebook '''Like''' or a Google '''PlusOne''' to a specific wiki page, ether in reference to the page itself or the topic the page is about. The tags are: {{tl|Like}}, {{tl|Recommend}}, {{tl|PlusOne}}. Click on their links for more info.

==Types of pages==
:''Think of this as a basic idea/guideline and not really anything strict''
*'''General topics (main namespace)'''- Anything that is a general overview of a topic. This can be main manual pages, a page for a remote control, a page for a specific hardware part, a supplemental tool/program, or just about anything Kodi related. Some pages might be a manual-type page explaining something in Kodi, or it could be something just Kodi-related and just serving as a basic info page + bookmarks.
*'''Manual'''- Core Kodi manual/help pages. Can be in several namespaces. See [[:Category:Manual]]
*'''FAQs'''- Question/common topic and answers. See [[:Category:FAQ]] and [[Template:FAQ]]
*'''HOW-TO:'''- How-tos some manual pages will simply be both general pages and a how-to page, or be paired with a how-to page. Pages in the ''HOW-TO:'' namespace should be just just for step-by-step how tos. For how-tos within a general topic page, just use the main namespace. Some how-tos are apart of the main manual, and others are more specific. We welcome any how-tos that people feel would be useful. See [[:Category:How-to]].
*'''[[Help:Add-on page|Add-ons:]]'''- Add-ons, skins, etc. Great for Add-on developers and users alike. See [[:Category:All add-ons]]. '''Examples of good add-on pages include: [[Add-on:YouTube]], [[Add-on:BlipTV]], [[Add-on:iPlayer]], [[Add-on:Common plugin cache]]'''. Subpages (if needed) can be made with a slash ('''/''') in the name.
*'''Development'''- Pages for developers or really advanced topics. Includes Skin and Add-on development. Can be in several namespaces. See [[:Category:Development]]
*'''User:'''- Username space for user pages. All editors get their own User page and can make additional subpages by adding a slash ('''/'''). Great for putting down notes on what you are working on for the Kodi Wiki, you can even use your userpage to document your own Kodi set ups, list helpful links for your own reference, or whatever as long as it is Kodi related.

== Style guidelines ==
{{main|Help:Style guidelines}}
{{#lst:Help:Style guidelines|notes}}

==Where we need help==
''everywhere, but here's some specific ideas:''
*Improve/update/add to all of the FAQs, see [[:Category:FAQ]]
*Update screen shots on various pages: Click on an image. If it expands then click on the file name below the image. Then click on "upload new version".
*Screen shots uploaded for all skins in [[:Category:Skins]]
**Any other kind of manual/help info specific to skins
*Expanding Add-on pages. Great for Add-on developers and users alike. See [[:Category:All add-ons]].

: '''Examples of good add-on pages include:
:* [[Add-on:BlipTV]]
:* [[Add-on:iPlayer]]
:* [[Add-on:PleXBMC]]
:* [[Add-on:Common plugin cache]]
:* [[Add-on:Artwork Downloader]]
: Subpages (if needed) can be made with a slash ('''/''') in the name.
*Pages/writeups for:
**[[Troubleshooting]]
*Spell checking (everywhere)
*Useful keymaps. See [[:Category:Custom keymaps]]
*Spam/vandalism patrolling of '''[http://kodi.wiki/index.php?title=Special:RecentChanges&hidepatrolled=1 unpatrolled edits]'''. See spam? Remove it! You can use the Undo feature or find a spam-free version in the "View history" tab (click on a past version, then click on Edit, then save, to restore an older version of a page).
*Pages needing updating/cleaning up: [[:Category:Cleanup]]
*Pages needing expanding: [[:Category:Incomplete]]
*Kodi Wiki help pages (including this very page). Need expanding, how-to's, etc, on how to edit and use the Kodi Wiki.

[[Category:Wiki]]

DevCon

2018-08-09T19:40:23Z

Kibje: /* 2018 (Bulgaria) */

{{mininav|[[Team Kodi]]|[[Events]]}}

The Kodi developers conference is where Team Kodi members gather to discuss and handle various Kodi related business. It is one of the few times where Team members meet up in real life.
{{-}}
__NONUMBEREDHEADINGS__
<div class="nonumtoc">__TOC__</div>
{{-}}
== 2018 (Bulgaria) ==
This DevCon has not been held yet !

'''Location:''' Sofia, Bulgaria

'''Date:''' September 28-30

== 2017 (Czech) ==
[[File:DevCon2017IITeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Prague, Czech

'''Date:''' October 27-29

* https://kodi.tv/article/devcon-2017-part-ii-day-one
* https://kodi.tv/article/devcon-2017-part-ii-day-two
* https://kodi.tv/article/devcon-2017-part-ii-day-three

{{-}}

== 2017 (Portugal) ==
[[File:DevCon2017TeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Porto, Portugal

'''Date:''' May 5th - 7th

* https://kodi.tv/article/devcon-2017-day-one
* https://kodi.tv/article/devcon-2017-day-two
* https://kodi.tv/article/devcon-2017-day-three
* https://kodi.tv/article/kodis-2017-developers-conference
* http://forum.kodi.tv/showthread.php?tid=311585

{{-}}

== 2016 (Hungary) ==
[[File:DevCon2016Teamfoto2.jpg|600px|right|thumb]]

'''Location:''' Budapest, Hungary

'''Date:''' October 10th - 12th

* https://kodi.tv/article/kodi-devcon-2016-live-blog

{{-}}

== 2015 (Czech) ==
[[File:Devcon2015.jpg|600px|right|thumb|<section begin="2016 photo"/>Top: alwinus, jjd-uk, keith, razze, ksoo, zag<br/>Middle: ruuk, koying, montellese, mkortstiege, , phil65, martijn<br/>Bottom: natethomas, paxxi, garbear, ansii, wisler, negge, hitcher, bignoid, fkoch, kib<section end="2016 photo"/>]]
'''Location:''' Prague, Czech

'''Date:''' October 7th - 9th

* https://kodi.tv/article/devcon-2015-liveblog

{{-}}

== 2014 (Portugal) ==
[[File:DevCon2014.jpg|500px|right|thumb]]

'''Location:''' Lisbon, Portugal

'''Date:''' October 10th - 12th

* http://kodi.tv/kodi-devcon-2014-live-blog/

{{-}}

== 2013 (Germany) ==
[[File:2013 DevCon.jpg|600px|right|thumb|<section begin="2013 photo"/>The team in Munich<section end="2012 photo"/>]]
'''Location:''' Munich, Germany

'''Date:''' October 11th - 13th

* http://kodi.tv/xbmc-devcon-2013/

{{-}}

== 2012 (Austria) ==
[[File:Devcon2012.JPG|right|600px|thumb|<section begin="2012 photo"/>From left to right: topfs2, da-anda, Martijn, fneufneu, sraue, benjee , Memphiz, Wiso, Montellese, chadoe, Davilla, jfcarrol, cptspiff, amet, vdrfan, olympia, anssi, alanwww1, jmarshall, TheUni, Clumsy, Freezy, natethomas<section end="2012 photo"/>]]
Vienna, sponsored by at-visions
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://xbmc.us/njbetzen/2012/08/30/xbmc-devcon-liveblog/
* http://kodi.tv/devcon-2012-user-meetup/
* http://www.at-visions.com/XBMC-conference-in-Vienna.html

Photos and videos:
* http://www.flickr.com/photos/23449328@N05/sets/72157631428716214/
* http://www.youtube.com/watch?v=jJBhe7arBlk

{{-}}

== 2010 (Austria) ==
[[File:XBMC-DevCon-2010-Attendees-resized.png|right|600px|thumb|<section begin="2010devcon"/>From left to right: Amet (Zeljko), Andy (at-visions), freezy (Nico), clumsy (Thomas), topfs2 (Tobias), chadoe (Martin), jmarshall (Jonathan) (TOP)/unknown (BOTTOM), elupus (Joakim), vdrfan (Matthias), prae5 (Paul), davilla (Scott), WiSo (Winfried), malloc (Sean), Malard (Martin), TheUni (Cory), Michael (at-visions), Olympia (Bence), Ronen (at-visions CEO) (TOP)/lcapriotti (Luigi) (BOTTOM), spiff (Dr. Arne), Lucas (at-visions)<section end="2010devcon"/>]]
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://kodi.tv/devcon-2010/
* http://kodi.tv/xbmc-devcon-2010-summary/
{{-}}

== 2009 (Germany) ==
[[File:2009 DevCon.jpg|right|600px|thumb|From left to right: Erez, Pike, Yuvalt, WiSo, vulkanr, vdrfan, elupus, blittan, chadoe, MaestroDD]]
Berlin
* http://kodi.tv/results-of-xbmc-developers-conference/
{{-}}

== 2008 (Netherlands) ==
[[File:2008 DevCon.jpg|right|600px|thumb|]]
'''Location:''' Amsterdam, The Netherlands

'''Sponsored by:''' Boxee

* http://blip.tv/play/AcbtFgA
* http://www.bunniestudios.com/blog/?p=251
* https://www.flickr.com/photos/27660056@N07/sets/72157605632155509/
{{-}}

[[Category:Events]]

DevCon

2018-08-09T19:40:15Z

Kibje: modification to DevCon overview page

{{mininav|[[Team Kodi]]|[[Events]]}}

The Kodi developers conference is where Team Kodi members gather to discuss and handle various Kodi related business. It is one of the few times where Team members meet up in real life.
{{-}}
__NONUMBEREDHEADINGS__
<div class="nonumtoc">__TOC__</div>
{{-}}
== 2018 (Bulgaria) ==
This DevCon has not been held yet !
'''Location:''' Sofia, Bulgaria

'''Date:''' September 28-30

== 2017 (Czech) ==
[[File:DevCon2017IITeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Prague, Czech

'''Date:''' October 27-29

* https://kodi.tv/article/devcon-2017-part-ii-day-one
* https://kodi.tv/article/devcon-2017-part-ii-day-two
* https://kodi.tv/article/devcon-2017-part-ii-day-three

{{-}}

== 2017 (Portugal) ==
[[File:DevCon2017TeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Porto, Portugal

'''Date:''' May 5th - 7th

* https://kodi.tv/article/devcon-2017-day-one
* https://kodi.tv/article/devcon-2017-day-two
* https://kodi.tv/article/devcon-2017-day-three
* https://kodi.tv/article/kodis-2017-developers-conference
* http://forum.kodi.tv/showthread.php?tid=311585

{{-}}

== 2016 (Hungary) ==
[[File:DevCon2016Teamfoto2.jpg|600px|right|thumb]]

'''Location:''' Budapest, Hungary

'''Date:''' October 10th - 12th

* https://kodi.tv/article/kodi-devcon-2016-live-blog

{{-}}

== 2015 (Czech) ==
[[File:Devcon2015.jpg|600px|right|thumb|<section begin="2016 photo"/>Top: alwinus, jjd-uk, keith, razze, ksoo, zag<br/>Middle: ruuk, koying, montellese, mkortstiege, , phil65, martijn<br/>Bottom: natethomas, paxxi, garbear, ansii, wisler, negge, hitcher, bignoid, fkoch, kib<section end="2016 photo"/>]]
'''Location:''' Prague, Czech

'''Date:''' October 7th - 9th

* https://kodi.tv/article/devcon-2015-liveblog

{{-}}

== 2014 (Portugal) ==
[[File:DevCon2014.jpg|500px|right|thumb]]

'''Location:''' Lisbon, Portugal

'''Date:''' October 10th - 12th

* http://kodi.tv/kodi-devcon-2014-live-blog/

{{-}}

== 2013 (Germany) ==
[[File:2013 DevCon.jpg|600px|right|thumb|<section begin="2013 photo"/>The team in Munich<section end="2012 photo"/>]]
'''Location:''' Munich, Germany

'''Date:''' October 11th - 13th

* http://kodi.tv/xbmc-devcon-2013/

{{-}}

== 2012 (Austria) ==
[[File:Devcon2012.JPG|right|600px|thumb|<section begin="2012 photo"/>From left to right: topfs2, da-anda, Martijn, fneufneu, sraue, benjee , Memphiz, Wiso, Montellese, chadoe, Davilla, jfcarrol, cptspiff, amet, vdrfan, olympia, anssi, alanwww1, jmarshall, TheUni, Clumsy, Freezy, natethomas<section end="2012 photo"/>]]
Vienna, sponsored by at-visions
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://xbmc.us/njbetzen/2012/08/30/xbmc-devcon-liveblog/
* http://kodi.tv/devcon-2012-user-meetup/
* http://www.at-visions.com/XBMC-conference-in-Vienna.html

Photos and videos:
* http://www.flickr.com/photos/23449328@N05/sets/72157631428716214/
* http://www.youtube.com/watch?v=jJBhe7arBlk

{{-}}

== 2010 (Austria) ==
[[File:XBMC-DevCon-2010-Attendees-resized.png|right|600px|thumb|<section begin="2010devcon"/>From left to right: Amet (Zeljko), Andy (at-visions), freezy (Nico), clumsy (Thomas), topfs2 (Tobias), chadoe (Martin), jmarshall (Jonathan) (TOP)/unknown (BOTTOM), elupus (Joakim), vdrfan (Matthias), prae5 (Paul), davilla (Scott), WiSo (Winfried), malloc (Sean), Malard (Martin), TheUni (Cory), Michael (at-visions), Olympia (Bence), Ronen (at-visions CEO) (TOP)/lcapriotti (Luigi) (BOTTOM), spiff (Dr. Arne), Lucas (at-visions)<section end="2010devcon"/>]]
'''Location:''' Vienna, Austria

'''Sponsored by:''' At-Visions

* http://kodi.tv/devcon-2010/
* http://kodi.tv/xbmc-devcon-2010-summary/
{{-}}

== 2009 (Germany) ==
[[File:2009 DevCon.jpg|right|600px|thumb|From left to right: Erez, Pike, Yuvalt, WiSo, vulkanr, vdrfan, elupus, blittan, chadoe, MaestroDD]]
Berlin
* http://kodi.tv/results-of-xbmc-developers-conference/
{{-}}

== 2008 (Netherlands) ==
[[File:2008 DevCon.jpg|right|600px|thumb|]]
'''Location:''' Amsterdam, The Netherlands

'''Sponsored by:''' Boxee

* http://blip.tv/play/AcbtFgA
* http://www.bunniestudios.com/blog/?p=251
* https://www.flickr.com/photos/27660056@N07/sets/72157605632155509/
{{-}}

[[Category:Events]]

DevCon

2018-08-09T19:31:22Z

Kibje: Initial area for Devcon 2018

{{mininav|[[Team Kodi]]|[[Events]]}}

The Kodi developers conference is where Team Kodi members gather to discuss and handle various Kodi related business. It is one of the few times where Team members meet up in real life.
{{-}}
__NONUMBEREDHEADINGS__
<div class="nonumtoc">__TOC__</div>
{{-}}
== 2018 ==

'''Location:''' Sofia, Bulgaria

'''Date:''' September 28-30

== 2017 II ==
[[File:DevCon2017IITeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Prague, Czech

'''Date:''' October 27-29

* https://kodi.tv/article/devcon-2017-part-ii-day-one
* https://kodi.tv/article/devcon-2017-part-ii-day-two
* https://kodi.tv/article/devcon-2017-part-ii-day-three

{{-}}

== 2017 I ==
[[File:DevCon2017TeamPhoto.jpg|600px|right|thumb]]

'''Location:''' Porto, Portugal

'''Date:''' May 5th - 7th

* https://kodi.tv/article/devcon-2017-day-one
* https://kodi.tv/article/devcon-2017-day-two
* https://kodi.tv/article/devcon-2017-day-three
* https://kodi.tv/article/kodis-2017-developers-conference
* http://forum.kodi.tv/showthread.php?tid=311585

{{-}}

== 2016 ==
[[File:DevCon2016Teamfoto2.jpg|600px|right|thumb]]

'''Location:''' Budapest, Hungary

'''Date:''' October 10th - 12th

* https://kodi.tv/article/kodi-devcon-2016-live-blog

{{-}}

== 2015 ==
[[File:Devcon2015.jpg|600px|right|thumb|<section begin="2016 photo"/>Top: alwinus, jjd-uk, keith, razze, ksoo, zag<br/>Middle: ruuk, koying, montellese, mkortstiege, , phil65, martijn<br/>Bottom: natethomas, paxxi, garbear, ansii, wisler, negge, hitcher, bignoid, fkoch, kib<section end="2016 photo"/>]]
'''Location:''' Prague, Czech

'''Date:''' October 7th - 9th

* https://kodi.tv/article/devcon-2015-liveblog

{{-}}

== 2014 ==
[[File:DevCon2014.jpg|500px|right|thumb]]

'''Location:''' Lisbon, Portugal

'''Date:''' October 10th - 12th

* http://kodi.tv/kodi-devcon-2014-live-blog/

{{-}}

== 2013 ==
[[File:2013 DevCon.jpg|600px|right|thumb|<section begin="2013 photo"/>The team in Munich<section end="2012 photo"/>]]
'''Location:''' Munich, Germany

'''Date:''' October 11th - 13th

* http://kodi.tv/xbmc-devcon-2013/

{{-}}

== 2012 ==
[[File:Devcon2012.JPG|right|600px|thumb|<section begin="2012 photo"/>From left to right: topfs2, da-anda, Martijn, fneufneu, sraue, benjee , Memphiz, Wiso, Montellese, chadoe, Davilla, jfcarrol, cptspiff, amet, vdrfan, olympia, anssi, alanwww1, jmarshall, TheUni, Clumsy, Freezy, natethomas<section end="2012 photo"/>]]
Vienna, sponsored by at-visions

* http://xbmc.us/njbetzen/2012/08/30/xbmc-devcon-liveblog/
* http://kodi.tv/devcon-2012-user-meetup/
* http://www.at-visions.com/XBMC-conference-in-Vienna.html

Photos and videos:
* http://www.flickr.com/photos/23449328@N05/sets/72157631428716214/
* http://www.youtube.com/watch?v=jJBhe7arBlk

{{-}}

== 2010 ==
[[File:XBMC-DevCon-2010-Attendees-resized.png|right|600px|thumb|<section begin="2010devcon"/>From left to right: Amet (Zeljko), Andy (at-visions), freezy (Nico), clumsy (Thomas), topfs2 (Tobias), chadoe (Martin), jmarshall (Jonathan) (TOP)/unknown (BOTTOM), elupus (Joakim), vdrfan (Matthias), prae5 (Paul), davilla (Scott), WiSo (Winfried), malloc (Sean), Malard (Martin), TheUni (Cory), Michael (at-visions), Olympia (Bence), Ronen (at-visions CEO) (TOP)/lcapriotti (Luigi) (BOTTOM), spiff (Dr. Arne), Lucas (at-visions)<section end="2010devcon"/>]]

Vienna, sponsored by at-visions
* http://kodi.tv/devcon-2010/
* http://kodi.tv/xbmc-devcon-2010-summary/
{{-}}

== 2009 ==
[[File:2009 DevCon.jpg|right|600px|thumb|From left to right: Erez, Pike, Yuvalt, WiSo, vulkanr, vdrfan, elupus, blittan, chadoe, MaestroDD]]
Berlin
* http://kodi.tv/results-of-xbmc-developers-conference/
{{-}}

== 2008 ==
[[File:2008 DevCon.jpg|right|600px|thumb|]]
Amsterdam, sponsored by Boxee
* http://blip.tv/play/AcbtFgA
* http://www.bunniestudios.com/blog/?p=251
* https://www.flickr.com/photos/27660056@N07/sets/72157605632155509/
{{-}}

[[Category:Events]]

Artist information folder

2018-08-07T17:52:57Z

Kibje: /* FAQ */ typo

{{mininav|[[:Category:Music_library| Music Library Index]] }}

<section begin="intro" />In v18 the concept of the Artist Information Folder is introduced as a new way to handle providing local artist artwork and information via nfo files. The Artist Information Folder is a user nominated folder that {{kodi}} will look in first for artwork or NFO files for ''any'' artist. <br>
This topic is of interest to those users that want to provide local artwork for artists, or capture their current artist art and additional data for transfer to another installation of {{kodi}}<section end="intro" />

= History =
In v17 and prior releases of {{kodi}} the ability to automatically fetch local art and information from NFO files depended upon the music files being in a strict '''Artist > Album > Songs''' folder structure.
{{kodi}} populated the basic library by using data embedded in the music files. It did not use the folder structure or filenames to populate the library, but it would try to identify a unique folder for each (album) artist and a unique folder for each album from the location of the related music files, and look there for art and additional information for the artist and album respectively.

Unfortunately not all music fits neatly under such a strict layout. For example:
*Collaboration albums with more than one album artist (very common in Classical music with composer, conductor and orchestra credited, but happens in pop when two artists in there own right make an album together).
*All the albums by an artist had to be on the same music source which made it difficult to organise libraries to suit personal preferences.
Art and additional information could only be provided for album artists, not those artists that only feature as a guest on some songs on an album by another artist or on a compilation album, nor the other musicians and professionals that contribute to the production.

The way {{kodi}} tried to identify folders from their contents, combined with a slightly inaccurate music file arrangement, produced some unexpected art results that were often difficult to pin down. <ref>https://github.com/xbmc/xbmc/pull/12891</ref>

<section begin="intro" />From v18 the Artist Information Folder can be used to resolve many issues with providing local art and additional information for Artists. Local artist art and nfo files can be provided without requiring a specific folder for music files, and artist NFO files can be kept separately from the music rather than jumbled with it. <section end="intro" />
= FAQ =
{|
{{FAQ|
| BGcolor=WhiteSmoke
| Question= Do I need to have an Artist Information Folder?
| Answer= No, {{kodi}} will continue to be backwards compatible and pick up artist art and NFO files from the same places it does for v17. Of course, if you choose not to use the Artist Information Folder you will still encounter the same limitations described above. Also if you do not have any local artist artwork or want to use NFO files then there is no need for one either.
}}
{{FAQ|
| BGcolor=
| Question= Why would I want to nominate a folder?
| Answer=*So that you can provide local art and NFO files for artists that are:
** involved in collaboration albums
** only song artists (no albums, only guests or on compilations)
** musicians or other contributors
* To keep artist art and data separate from music files.
* To handle having music from one artist spilt across many music sources.
If you have ever had the wrong local art appear in an odd place then you probably need it.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= How do I setup the Artist Information Folder?
| Answer= See Section 3- Recommended Setup
The folder can be named in whatever way suits you and located with, or away from, your music files. We recommend away from your music files.
Once a folder has been created on your file system, set it as the Artist Information Folder in either one of two ways:
* In the settings page here... '''''See: [[Settings/Media/Music#Library|Artist Information Folder Setting]]''''', or
* Via the Settings button on the Add to Library dialog that is displayed when you add a new music source. '''''See: [[Adding_music_to_the_library#Adding_Music_to_Library| Adding Sources]]'''''
}}
{{FAQ|
| BGcolor=
| Question= How is the individual artist information organised and populated?
| Answer= Any artist can have a subfolder within the Artist Information Folder which is named same as the artist name. Within that folder can be artwork and additional artist information as XML metadata in an '''''[[NFO_files/Music| NFO file]]''''' called ''artist.nfo''.

The artist folders can be created manually, however it is easiest to create the initial artist folders and contents using the export facility. See 4- Using Export. That way folders are created with the correct names, as slight differences in naming could prevent {{kodi}} from locating the artist. The artwork and NFO files can then be manually edited and the library refreshed.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= How does {{kodi}} use the contents?
| Answer= The artwork and NFO files in the Artist Information Folder are read by Kodi as part of scanning and scraping process.
If you have made changes to the NFO Files for Artists already in your library, then these changes need to be '''Refreshed''' into the library.
'''''See: [[Update_Music_Library#Refresh_Artist|Refresh Artists]]'''''<br>
'''''See: [[Update_Music_Library#Refresh_Album|Refresh Albums]]'''''
To change existing artwork or to add missing artwork, either use the Refresh method above or manually change the artwork
'''''See: [[Music_artwork#Manually_Add_Artwork| Manually Add Artwork]]'''''

Note that the music library import facility does not make use of separate nfo files at all. Import only works on the single xml files that can be created via export. '''''See: [[Import-export_library#Import_2| Music Library Import]]'''''
}}
{{FAQ|
| BGcolor=
| Question= Does the Artist Information Folder have to be separate from my music files?
| Answer= No, it is the user's choice but it will be less confusing if it is separate. Also note that using the export facility to populate the Artist Information Folder can result in thousands of artist folders. Decide if you want all these folders, containing just art and nfo files, mixed in with your other folders that contain music files.
Finally if you find the explanation in the next question confusing then just don’t do it, make it a separate folder somewhere else.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= What happens if I make the Artist Information Folder the same as my main music source?
| Answer=Say you have a folder called "mymusic" that contains all your music files under an '''Artist > Album > Songs''' folder structure, and you choose to make that the Artist Information Folder, then {{kodi}} will look first for artist artwork and nfo in folders in mymusic\<artistname> where <artistname> is the exact artist name. The names of your existing folders for each artist may match, or may not (remember {{kodi}} does not care how music folders are named). What you read as the same name may not be exactly the same. Say they match, then the art and NFO files in them will be found and used. But if all you want is to use your existing artist art and nfo files already in your music folder layout then setting the Artist Information Folder the same as a music source is unnecessary, {{kodi}} will look there anyway.<br>
For art and NFO for extra artists you can create (or let export create for you) additional artist folders along side your existing folders, however you will end up with some that have music and some that don't. Some of the artwork addons people have used already do this mixing of music and art only folders, so it may be familiar and if the artist folders are correctly named Kodi will start to pick up the art on scanning rather than have the addon set it. However for others being able to use the Artist Information Folder to separate art and music will be a relief.
}}
{{FAQ|
| BGcolor=
| Question= What happens when I have a separate Artist Information Folder but also leave artist NFO and artwork files above my music files?
| Answer= {{kodi}} will look first for the artist under the Artist Information Folder and use that artwork and NFO file. If it does not find a folder for the artist there, then for album artists only it falls back to looking for a suitable artist folder in an '''Artist > Album > Songs''' folder structure as it did for v17. <br>
There are a few more safety checks in v18 to try and avoid some of the cases of mistaken identity, but in doing that it may also not show such art in the one place it is wanted.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= Does this affect Album artwork and NFO Files?
| Answer= No, this does not apply to albums. Local album artwork and NFO files still be looked in the folder common to all the music files for that album (if such a unique folder exists).<br>
If album related folders and files are located within the artist folders of the Artist Information Folder then they generally have no effect, unless the Artist Information Folder is the same as the music source and the music files are also located there.
}}
{{FAQ|
| BGcolor=
| Question= When using File View mode will I see the artwork from the Artist Information Folder?
| Answer= No, the Artist Information Folder is only a music library feature. In file view you only see the artwork found in the folder you are browsing.
}}
{{FAQ|
| BGcolor=WhiteSmoke
| Question= Why won't the scan pick up my artwork?
| Answer= There could be many different reasons for that, only some relate to the Artist Information Folder.
'''''See: [[Music_artwork|Music Artwork Missing]]'''''
}}
|}

= Recommended Setup =
A frequent question from users is ''what do you recommend?'', in the case of the Artist Information Folder the answer is simple: unless you have local artwork for artists, or want to enter artist information via NFO files there is nothing to do. For a first time {{kodi}} user the recommendation is to tag your music files accurately, scan them into the library and allow the scrapers to fetch additional artist and album information and artwork for you.

With v18 you can arrange your music files however you like and still have access to local art and NFO files. We would recommend that all the music files from an album are kept in a unique folder, perhaps with subfolders for each part of a multi-part set. Perhaps you choose to arrange those in artist folders of some kind, but that does not have to be strictly adhered too. You could divide a large music collection by genre (with an artist having albums in more than one), or by decade, or some broader music category e.g. Xmas music. Use an '''Artist > Album > Songs''' structure if it is convenient for you.

Once you start to extend your use of {{kodi}} then a number of situations can arise:
*you have artists that the scraper was unable to find information or art for
*you want to manually edit some of the information
*having selected particular art from the many choices the scraper has found you want to backup that choice
*you want to transfer your current library to another installation of {{kodi}}

Then it is time to setup an Artist Information Folder.
# Create the Artist Information Folder outside the folders which hold your music files
# Name that folder in whatever way suits you
# Once the folder is created set this folder in the ''Artist Information Folder'' setting here... '''''See: [[Settings/Media/Music#Library|Artist Information Folder Setting]]'''''
# Use the export facility to populate the Artist Information Folder
A typical folder structure type is displayed below:

<syntaxhighlight lang="xml">
f:\ .......................................(Drive root)
|
|__ArtistInfo ............................(Artist Information Folder)
| |
|
|
|__MyMusic ...............................(Source)
|_____Pop Music .......................(Source)
| |__ Madonna ........................(Artist folder)
| | |__ Beautiful Stranger (1999) ..(Album folder)
| | | |__ Songs
|
|_____Compilations .......................(Source)
| |__ Essential Eighties .............(Album folder)
| | |__ Songs
|
|_____Classical ..........................(Source)
| |
|
|_____Soundtracks ........................(Source)
| |
</syntaxhighlight>

= Using Export With The Artist Information Folder =
The export facility is the easy way to create artist folders in the Artist Information Folder, and populate them with the current artwork and additional artist information that has been already been scraped (or create empty files as templates that can be manually edited).

To do this directly '''''[[Import-export_library#Music_Library_Export_.2F_Import|export the music library]]''''', choosing '''To library folders''' as the kind of export output. Choose in the items to export which artists to do this for:
* album artists
* song artists
* other artists - the musicians and other people involved in production

However if you are concerned about what is going to be created you can choose '''Separate files for each item''' as the kind of export output. This will create the artist folders (and album folders for each artist) in a destination of your choice. Use this as a harmless test to see what is going to be produced without impacting your music files or Artist Information Folder.

The various music export options are described in more detail here.

= References =
<references />
{{top}}
{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Music library]]
[[Category:Advanced topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

Category:Karellen

2018-07-14T13:20:00Z

Kibje: Hide category from displaying at the bottom of pages (still viewable by logged-in users)

For ease of reference, a listing of pages I have substantially changed
__HIDDENCAT__

Add-on:Artist Slideshow

2018-07-10T13:06:43Z

Kibje: syntaxhighlighting added

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.2
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?t=124880
|Website=http://wiki.xbmc.org/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
** option to display notification during download of first image for an artist with option to provide a local image (or images) to use instead of default Kodi notification
** option to display notification when downloads are complete (or no images found for download)
** ability to exclude images from being downloaded (see Tips and Tricks below)
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo ([https://github.com/pkscout/repository.skins.pkscout/raw/gotham/repository.skins.pkscout-1.0.1.zip Gotham] or [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Confluence Skin ===
Depending on the version of Kodi you have and the operating system on which you are running it, the files you need to modify will be in different locations. If you don't know where skin files are stored, then this is not the option for you. Please see the section above for information on downloading and installing a skin that supports Artist Slideshow.

''Change Default Skin Files''

This is probably the easiest way, but anytime you upgrade or reinstall XBMC you will have to redo these modifications. Go to the Kodi installation root folder (see this wiki page under special://xbmc for the path for your operating system). Then go to addons --> skin.confluence. Quit Kodi, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

''Create Custom Skin''

This is a bit more complicated but will keep your modifications intact across upgrades. Go to the Kodi installation folder, enter the addon directory and find the skin.confluence folder. Make a copy of it and move it to your user addon directory. Rename the directory to skin.confluence.mod. In that directory open the file called addon.xml. Change the third line to read id="skin.confluence.mod" and then launch (or relaunch Kodi). Go to SYSTEM --> APPEARANCE --> SKIN and switch to the modified skin. When you do that you will lose all your current skin settings, so you might want to write them down before changing. Quit Kodi again, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

=== Changes to MusicVisualisation.xml ===
To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

To add a multiimage conrol:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
</control>
</syntaxhighlight>

== Addon settings ==

=== Slideshow ===
''Local artist folder:'' (default none)<br />
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first)<br />
three options: remote first, local first, both<br />
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow<br />
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow<br />
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false)<br />
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false)<br />
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both)<br />
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false)<br />
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false)<br />
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty)<br />
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false)<br />
Tells Kodi to use this folder of images if no artwork is found for the playing artist<br />
'''Fallback slideshow folder:''' (default none)<br />
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false)<br />
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded.<br />
'''Override slideshow folder:''' (default none)<br />
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false)<br />
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Client API key''' (default empty)<br />
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ <br />
'''Download all images regardless of resolution:''' (default false)<br />
Downloads images even if they are not in 16x9 aspect ratio.<br />
'''I donate to this service:''' (default false)<br />
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false)<br />
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Download all images regardless of resolution:''' (default false)<br />
Downloads images even if they are not in 16x9 aspect ratio.<br />
'''I donate to this service:''' (default false)<br />
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false)<br />
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Download album info fromlast.fm'' (default false)<br />
Downloads the artist's discography from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English)<br />
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages).<br />
''Get artist bio from Kodi:'' (default: true)<br />
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Get artist bio from theaudiodb.com'' (default: false)<br />
If selected, AS will download the artist bio matching the selected language from theaudiodb.com.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Get artist bio fromlast.fm'' (default: false)<br />
If selected, AS will download the artist bio matching the selected language from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false)<br />
If selected, AS will download a list of similar artists from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Advanced ===
''Download notification type:'' (default none)<br />
three options: none, text notifications, custom images<br />
'''none''' will surpress all notifications<br />
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete)<br />
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''')<br />
'''Progress images folder:''' (default empty)<br />
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder.<br />
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings.<br />
'''Replace illegal path characters in artist name with''' (default _)<br />
This character replaces any illegal characters noted above.<br />
'''Replace trailing period in artist name with:''' (default BLANK)<br />
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false)<br />
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted.<br />
'''Maximum cache size (in megabytes):''' (default 1024)<br />
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false)<br />
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>
</syntaxhighlight>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

<syntaxhighlight lang=python>
def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()
</syntaxhighlight>

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

<syntaxhighlight lang=python>
#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)
</syntaxhighlight>

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: http://forum.kodi.tv/showthread.php?t=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Commands

2018-07-10T13:04:52Z

Kibje: this page does not use syntaxhighlight at all now

{{Addon
|Name=Commands
|provider-name=AddonScriptorDE
|ID=script.commands
|latest-version=1.0.3
|extension point=xbmc.python.pluginsource
|provides=executable
|Summary=Map multiple XBMC commands to one remote button. All availabe commands: http://wiki.xbmc.org/?title=List_of_Built_In_Functions
|Description=Map multiple XBMC commands to one remote button. All availabe commands: http://wiki.xbmc.org/?title=List_of_Built_In_Functions
|Platform=
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?tid=134129
|Website=
|Source=https://github.com/AddonScriptorDE/script.commands
|Email=AddonScriptorDE at yahoo dot de
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.commands/icon.png}}

== Instructions ==
To use this just use a '''[[keymap]]''' to map a button to perform the action:

RunPlugin(plugin://script.commands)

[[Category:Pages with syntax highlighting errors]]
[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2018-07-10T13:03:14Z

Kibje: /* Override nfo file formats */ syntaxhighlights

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.2
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?t=124880
|Website=http://wiki.xbmc.org/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
** option to display notification during download of first image for an artist with option to provide a local image (or images) to use instead of default Kodi notification
** option to display notification when downloads are complete (or no images found for download)
** ability to exclude images from being downloaded (see Tips and Tricks below)
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo ([https://github.com/pkscout/repository.skins.pkscout/raw/gotham/repository.skins.pkscout-1.0.1.zip Gotham] or [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Confluence Skin ===
Depending on the version of Kodi you have and the operating system on which you are running it, the files you need to modify will be in different locations. If you don't know where skin files are stored, then this is not the option for you. Please see the section above for information on downloading and installing a skin that supports Artist Slideshow.

''Change Default Skin Files''

This is probably the easiest way, but anytime you upgrade or reinstall XBMC you will have to redo these modifications. Go to the Kodi installation root folder (see this wiki page under special://xbmc for the path for your operating system). Then go to addons --> skin.confluence. Quit Kodi, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

''Create Custom Skin''

This is a bit more complicated but will keep your modifications intact across upgrades. Go to the Kodi installation folder, enter the addon directory and find the skin.confluence folder. Make a copy of it and move it to your user addon directory. Rename the directory to skin.confluence.mod. In that directory open the file called addon.xml. Change the third line to read id="skin.confluence.mod" and then launch (or relaunch Kodi). Go to SYSTEM --> APPEARANCE --> SKIN and switch to the modified skin. When you do that you will lose all your current skin settings, so you might want to write them down before changing. Quit Kodi again, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

=== Changes to MusicVisualisation.xml ===
To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

To add a multiimage conrol:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
</control>
</syntaxhighlight>

== Addon settings ==

=== Slideshow ===
''Local artist folder:'' (default none)<br />
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first)<br />
three options: remote first, local first, both<br />
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow<br />
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow<br />
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false)<br />
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false)<br />
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both)<br />
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false)<br />
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false)<br />
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty)<br />
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false)<br />
Tells Kodi to use this folder of images if no artwork is found for the playing artist<br />
'''Fallback slideshow folder:''' (default none)<br />
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false)<br />
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded.<br />
'''Override slideshow folder:''' (default none)<br />
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false)<br />
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Client API key''' (default empty)<br />
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ <br />
'''Download all images regardless of resolution:''' (default false)<br />
Downloads images even if they are not in 16x9 aspect ratio.<br />
'''I donate to this service:''' (default false)<br />
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false)<br />
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Download all images regardless of resolution:''' (default false)<br />
Downloads images even if they are not in 16x9 aspect ratio.<br />
'''I donate to this service:''' (default false)<br />
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false)<br />
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Download album info fromlast.fm'' (default false)<br />
Downloads the artist's discography from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English)<br />
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages).<br />
''Get artist bio from Kodi:'' (default: true)<br />
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Get artist bio from theaudiodb.com'' (default: false)<br />
If selected, AS will download the artist bio matching the selected language from theaudiodb.com.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Get artist bio fromlast.fm'' (default: false)<br />
If selected, AS will download the artist bio matching the selected language from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false)<br />
If selected, AS will download a list of similar artists from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Advanced ===
''Download notification type:'' (default none)<br />
three options: none, text notifications, custom images<br />
'''none''' will surpress all notifications<br />
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete)<br />
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''')<br />
'''Progress images folder:''' (default empty)<br />
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder.<br />
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings.<br />
'''Replace illegal path characters in artist name with''' (default _)<br />
This character replaces any illegal characters noted above.<br />
'''Replace trailing period in artist name with:''' (default BLANK)<br />
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false)<br />
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted.<br />
'''Maximum cache size (in megabytes):''' (default 1024)<br />
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false)<br />
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>
</syntaxhighlight>

Example artistsalbum.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>
</syntaxhighlight>

Example artistsimilar.nfo
<syntaxhighlight lang=xml>
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>
</syntaxhighlight>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: http://forum.kodi.tv/showthread.php?t=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2018-07-10T13:02:32Z

Kibje: /* Directory Structure */ syntaxhighlight addition

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.2
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?t=124880
|Website=http://wiki.xbmc.org/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
** option to display notification during download of first image for an artist with option to provide a local image (or images) to use instead of default Kodi notification
** option to display notification when downloads are complete (or no images found for download)
** ability to exclude images from being downloaded (see Tips and Tricks below)
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo ([https://github.com/pkscout/repository.skins.pkscout/raw/gotham/repository.skins.pkscout-1.0.1.zip Gotham] or [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Confluence Skin ===
Depending on the version of Kodi you have and the operating system on which you are running it, the files you need to modify will be in different locations. If you don't know where skin files are stored, then this is not the option for you. Please see the section above for information on downloading and installing a skin that supports Artist Slideshow.

''Change Default Skin Files''

This is probably the easiest way, but anytime you upgrade or reinstall XBMC you will have to redo these modifications. Go to the Kodi installation root folder (see this wiki page under special://xbmc for the path for your operating system). Then go to addons --> skin.confluence. Quit Kodi, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

''Create Custom Skin''

This is a bit more complicated but will keep your modifications intact across upgrades. Go to the Kodi installation folder, enter the addon directory and find the skin.confluence folder. Make a copy of it and move it to your user addon directory. Rename the directory to skin.confluence.mod. In that directory open the file called addon.xml. Change the third line to read id="skin.confluence.mod" and then launch (or relaunch Kodi). Go to SYSTEM --> APPEARANCE --> SKIN and switch to the modified skin. When you do that you will lose all your current skin settings, so you might want to write them down before changing. Quit Kodi again, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

=== Changes to MusicVisualisation.xml ===
To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

To add a multiimage conrol:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
</control>
</syntaxhighlight>

== Addon settings ==

=== Slideshow ===
''Local artist folder:'' (default none)<br />
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first)<br />
three options: remote first, local first, both<br />
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow<br />
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow<br />
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false)<br />
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false)<br />
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both)<br />
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false)<br />
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false)<br />
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty)<br />
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false)<br />
Tells Kodi to use this folder of images if no artwork is found for the playing artist<br />
'''Fallback slideshow folder:''' (default none)<br />
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false)<br />
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded.<br />
'''Override slideshow folder:''' (default none)<br />
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false)<br />
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Client API key''' (default empty)<br />
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ <br />
'''Download all images regardless of resolution:''' (default false)<br />
Downloads images even if they are not in 16x9 aspect ratio.<br />
'''I donate to this service:''' (default false)<br />
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false)<br />
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Download all images regardless of resolution:''' (default false)<br />
Downloads images even if they are not in 16x9 aspect ratio.<br />
'''I donate to this service:''' (default false)<br />
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false)<br />
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Download album info fromlast.fm'' (default false)<br />
Downloads the artist's discography from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English)<br />
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages).<br />
''Get artist bio from Kodi:'' (default: true)<br />
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Get artist bio from theaudiodb.com'' (default: false)<br />
If selected, AS will download the artist bio matching the selected language from theaudiodb.com.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Get artist bio fromlast.fm'' (default: false)<br />
If selected, AS will download the artist bio matching the selected language from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false)<br />
If selected, AS will download a list of similar artists from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Advanced ===
''Download notification type:'' (default none)<br />
three options: none, text notifications, custom images<br />
'''none''' will surpress all notifications<br />
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete)<br />
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''')<br />
'''Progress images folder:''' (default empty)<br />
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder.<br />
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings.<br />
'''Replace illegal path characters in artist name with''' (default _)<br />
This character replaces any illegal characters noted above.<br />
'''Replace trailing period in artist name with:''' (default BLANK)<br />
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false)<br />
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted.<br />
'''Maximum cache size (in megabytes):''' (default 1024)<br />
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false)<br />
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=text>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>

Example artistsalbum.nfo
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>

Example artistsimilar.nfo
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: http://forum.kodi.tv/showthread.php?t=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2018-07-10T13:01:59Z

Kibje: syntaxhighlight fix

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.2
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?t=124880
|Website=http://wiki.xbmc.org/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
** option to display notification during download of first image for an artist with option to provide a local image (or images) to use instead of default Kodi notification
** option to display notification when downloads are complete (or no images found for download)
** ability to exclude images from being downloaded (see Tips and Tricks below)
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo ([https://github.com/pkscout/repository.skins.pkscout/raw/gotham/repository.skins.pkscout-1.0.1.zip Gotham] or [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Confluence Skin ===
Depending on the version of Kodi you have and the operating system on which you are running it, the files you need to modify will be in different locations. If you don't know where skin files are stored, then this is not the option for you. Please see the section above for information on downloading and installing a skin that supports Artist Slideshow.

''Change Default Skin Files''

This is probably the easiest way, but anytime you upgrade or reinstall XBMC you will have to redo these modifications. Go to the Kodi installation root folder (see this wiki page under special://xbmc for the path for your operating system). Then go to addons --> skin.confluence. Quit Kodi, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

''Create Custom Skin''

This is a bit more complicated but will keep your modifications intact across upgrades. Go to the Kodi installation folder, enter the addon directory and find the skin.confluence folder. Make a copy of it and move it to your user addon directory. Rename the directory to skin.confluence.mod. In that directory open the file called addon.xml. Change the third line to read id="skin.confluence.mod" and then launch (or relaunch Kodi). Go to SYSTEM --> APPEARANCE --> SKIN and switch to the modified skin. When you do that you will lose all your current skin settings, so you might want to write them down before changing. Quit Kodi again, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

=== Changes to MusicVisualisation.xml ===
To run the script:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlight>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlight lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlight>

To add a multiimage conrol:
<syntaxhighlight lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
</control>
</syntaxhighlight>

== Addon settings ==

=== Slideshow ===
''Local artist folder:'' (default none)<br />
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first)<br />
three options: remote first, local first, both<br />
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow<br />
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow<br />
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false)<br />
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false)<br />
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both)<br />
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false)<br />
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false)<br />
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty)<br />
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false)<br />
Tells Kodi to use this folder of images if no artwork is found for the playing artist<br />
'''Fallback slideshow folder:''' (default none)<br />
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false)<br />
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded.<br />
'''Override slideshow folder:''' (default none)<br />
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false)<br />
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Client API key''' (default empty)<br />
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ <br />
'''Download all images regardless of resolution:''' (default false)<br />
Downloads images even if they are not in 16x9 aspect ratio.<br />
'''I donate to this service:''' (default false)<br />
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false)<br />
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Download all images regardless of resolution:''' (default false)<br />
Downloads images even if they are not in 16x9 aspect ratio.<br />
'''I donate to this service:''' (default false)<br />
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false)<br />
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Download album info fromlast.fm'' (default false)<br />
Downloads the artist's discography from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English)<br />
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages).<br />
''Get artist bio from Kodi:'' (default: true)<br />
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Get artist bio from theaudiodb.com'' (default: false)<br />
If selected, AS will download the artist bio matching the selected language from theaudiodb.com.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Get artist bio fromlast.fm'' (default: false)<br />
If selected, AS will download the artist bio matching the selected language from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false)<br />
If selected, AS will download a list of similar artists from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Advanced ===
''Download notification type:'' (default none)<br />
three options: none, text notifications, custom images<br />
'''none''' will surpress all notifications<br />
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete)<br />
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''')<br />
'''Progress images folder:''' (default empty)<br />
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder.<br />
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings.<br />
'''Replace illegal path characters in artist name with''' (default _)<br />
This character replaces any illegal characters noted above.<br />
'''Replace trailing period in artist name with:''' (default BLANK)<br />
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false)<br />
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted.<br />
'''Maximum cache size (in megabytes):''' (default 1024)<br />
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false)<br />
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<syntaxhighlight lang=xml>
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg
</syntaxhighlight>

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>

Example artistsalbum.nfo
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>

Example artistsimilar.nfo
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: http://forum.kodi.tv/showthread.php?t=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Artist Slideshow

2018-07-10T13:01:05Z

Kibje: /* Changes to MusicVisualisation.xml */ syntaxhighligher addition

{{Addon
|Name=Artist Slideshow
|provider-name=pkscout,ronie
|ID=script.artistslideshow
|latest-version=2.1.2
|extension point=xbmc.python.script
|provides=executable
|Summary=Download images and additional info of the currently playing artist
|Description=Addon to download images and additional information from fanart.tv and theaudiodb.com of the currently playing artist. The images, along with local artists' images, and info can be used by the skin to create a slideshow for the artist being listened to.
|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?t=124880
|Website=http://wiki.xbmc.org/index.php?title=Add-on:Artist_Slideshow
|Source=https://github.com/pkscout/script.artistslideshow
|Email=artistslideshow.xbmc@gmail.com
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.artistslideshow/icon.png}}
== Donations ==
Donations are '''not''' accepted for Artist Slideshow. If you find this addon useful, please consider instead supporting the services that make Artist Slideshow possible.
* fanart.tv: https://fanart.tv/contribute/
* theaudiodb: http://theaudiodb.com (look for the "donate with PayPal button)
* musicbrainz: https://metabrainz.org/donate

== Features ==
* displays slideshow as background for music visualization (must use a compatible skin or update skin using the instructions below)
** option to have artist images downloaded and/or use a local directory of artist images
** option for a fallback slideshow if no local or remote images are found
** option to have a single slideshow displayed regardless of artist playing
* options to download artwork from fanart.tv and theaudiodb.com to display as background for music visualization
** option to download artist bio and other additional information from Kodi's internal database, theaudiodb.com, or last.fm (skin must support display of this information)
*** support for overriding the artist bio, discography, and similar artists list with local information
** option to limit size of download cache
** option to display notification during download of first image for an artist with option to provide a local image (or images) to use instead of default Kodi notification
** option to display notification when downloads are complete (or no images found for download)
** ability to exclude images from being downloaded (see Tips and Tricks below)
* support for multiple artists for a single song (as passed by Kodi)
** also supports iTunes/Amazon standard of song name (feat. artist 2) in title MP3 tag
* support for internet streams that put the artist name in the Kodi title field
* support for other addons using Artist Slideshow to provide the background
* support for an alternate name for the folder containing the images (i.e. something instead of extrafanart)

== How to use this addon ==

=== Find a Compatible Skin ===
There are a number of skins that support Artist Slideshow, but keeping a running list of them has proved too much work. I'd suggest visiting the Kodi forums and see if the skin you want to use supports Artist Slideshow. I do have a modified version of the default Confluence theme (Kodi 16 and earlier) and Estuary theme (Kodi 17 and later) that include support for Artist Slideshow. To use that skin you will need to download and install my skin repo ([https://github.com/pkscout/repository.skins.pkscout/raw/gotham/repository.skins.pkscout-1.0.1.zip Gotham] or [https://github.com/pkscout/repository.skins.pkscout/raw/helix/repository.skins.pkscout-1.1.0.zip Helix or later]) and then install the skin from there.

=== Using Artist Slideshow with the default Confluence Skin ===
Depending on the version of Kodi you have and the operating system on which you are running it, the files you need to modify will be in different locations. If you don't know where skin files are stored, then this is not the option for you. Please see the section above for information on downloading and installing a skin that supports Artist Slideshow.

''Change Default Skin Files''

This is probably the easiest way, but anytime you upgrade or reinstall XBMC you will have to redo these modifications. Go to the Kodi installation root folder (see this wiki page under special://xbmc for the path for your operating system). Then go to addons --> skin.confluence. Quit Kodi, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

''Create Custom Skin''

This is a bit more complicated but will keep your modifications intact across upgrades. Go to the Kodi installation folder, enter the addon directory and find the skin.confluence folder. Make a copy of it and move it to your user addon directory. Rename the directory to skin.confluence.mod. In that directory open the file called addon.xml. Change the third line to read id="skin.confluence.mod" and then launch (or relaunch Kodi). Go to SYSTEM --> APPEARANCE --> SKIN and switch to the modified skin. When you do that you will lose all your current skin settings, so you might want to write them down before changing. Quit Kodi again, modify the appropriate files (see below in the Changes to MusicVisualization.xml section), and then start up Kodi again.

=== Changes to MusicVisualisation.xml ===
To run the script:
<syntaxhighlighter lang=xml>
<onload>RunScript(script.artistslideshow)</onload>
</syntaxhighlighter>

On AppleTV if ArtistSlideshow isn't updating after the first artist, use this instead:
<syntaxhighlighter lang=xml>
<onload>RunScript(script.artistslideshow, daemon=True)</onload>
</syntaxhighlighter>

To add a multiimage conrol:
<syntaxhighlighter lang=xml>
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window(Visualisation).Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
</control>
</syntaxhighlighter>

== Addon settings ==

=== Slideshow ===
''Local artist folder:'' (default none)<br />
path to a directory that has artist images. Images must be organized in artist/extrafanart/ unless you set a different local fanart folder name in the advanced settings.

''Priority:'' (default remote first)<br />
three options: remote first, local first, both<br />
'''remote first''' will try and download images from remote sites. if none found will use local images. if none found will use fallback slideshow<br />
'''local first''' will use local images. if none found will try and download remote images. if none found will use fallback slideshow<br />
'''both''' will check for local images first. if they exist the downloaded images will be placed in the same directory as the local images. if not remote images will be stored in normal cache dir.

''Always use local artist path for storage:'' (default false)<br />
If you are using local image folders you've downloaded from other sources, by default AS will only add images in those directories if the artist directory already exists. If this option is set to TRUE, then AS will create new artist folders in the local artist path and save the images there. This is useful if you are sharing images between Kodi instances on different TVs.

''Always use local artist path for service information storage:'' (default false)<br />
If this is set to True, Artist Slideshow will store all the cached information from the image sources in the same folder structure as the images. This is useful if you are sharing images between Kodi instances on different TVs, as Artist Slideshow won't download duplicates of the same information.

''Include root level fanart.jpg / Include root level folder.jpg'' (default false for both)<br />
If you have your local images organized using many popular image download addons, you might not have a couple images in the root of your artist directory that aren't included in the extrafanart folder. This option will make a copy of these two images (or fanart.png / folder.png) and place them in your extrafanart folder so they are included in your slideshow.

''Disable secondary and featured artist images:'' (default false)<br />
When set to false, Artist Slideshow will show images for all artists associated with the playing song. When set to true, Artist Slideshow will show only images for the primary artist.

''Use transparent background when no artist found:'' (default false)<br />
When set to true, Artist Slideshow will use a transparent background (instead of a black one), allowing the layer below to be seen. Please note that exactly what you see will be very dependent on the skin you are using and the settings you have for that skin.

=== Alternate Slideshow ===
''Alternate name for local fanart folder:'' (default empty)<br />
this is a text field where you can provide an alternate name for the add-on to use to find local images. If this has text in it, the add-on will look in artist/customfolder instead of artist/extrafanart for local images.

''Use fallback slideshow'' (default false)<br />
Tells Kodi to use this folder of images if no artwork is found for the playing artist<br />
'''Fallback slideshow folder:''' (default none)<br />
path to a directory of images that should be used if no local or remote images can be found.

''Use override slideshow'' (default false)<br />
Tells Kodi to use this folder of images no matter what artist is playing. With this set no artist artwork will ever be downloaded.<br />
'''Override slideshow folder:''' (default none)<br />
path to a directory of images that should be used intead of artist artwork.

=== Images ===
''Download images from fanart.tv:'' (default false)<br />
fanart.tv has very high quality (1080p) artwork. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Client API key''' (default empty)<br />
fanart.tv provides the option for individual users to have an API key. For information on the benefits that provides, please see https://fanart.tv/2015/01/personal-api-keys/ <br />
'''Download all images regardless of resolution:''' (default false)<br />
Downloads images even if they are not in 16x9 aspect ratio.<br />
'''I donate to this service:''' (default false)<br />
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

''Download images from theaudiodb.com:'' (default false)<br />
theaudiodb.com has no more than three images per artist, and they are often duplicates of artwork from fanart.tv. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Download all images regardless of resolution:''' (default false)<br />
Downloads images even if they are not in 16x9 aspect ratio.<br />
'''I donate to this service:''' (default false)<br />
Set this to true if you donate money to fanart.tv. This will provide more frequent updates of images. Please don't be an ass and enable this without actually donating. We've already lost one image source because of funding issues. We don't need to lose any more.

=== Album Info ===
''Download album info from theaudiodb.com'' (default false)<br />
Downloads the artist's discography from theaudiodb.com. To use this service, you must have the MusicBrainz Artist ID tag in your music files and have that scanned into your Kodi library.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Download album info fromlast.fm'' (default false)<br />
Downloads the artist's discography from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Artist Bio ===
''Preferred language for artist bio:''' (default: English)<br />
Sets the language Kodi uses when attempting to download a bio. If no bio for that language is returned, no bio is returned (even if available in other languages).<br />
''Get artist bio from Kodi:'' (default: true)<br />
If selected, AS will ask Kodi for the artist bio that was stored when the music library was last scraped.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Get artist bio from theaudiodb.com'' (default: false)<br />
If selected, AS will download the artist bio matching the selected language from theaudiodb.com.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />
''Get artist bio fromlast.fm'' (default: false)<br />
If selected, AS will download the artist bio matching the selected language from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Similar Artists ===
''Download similar artists fromlast.fm'' (default: false)<br />
If selected, AS will download a list of similar artists from last.fm.<br />
'''Priority''' (range 1 - 10, default 5)<br />
If multiple services are enabled, the service with priority 1 will be used first, and the one with priority 10 will be used last.<br />

=== Advanced ===
''Download notification type:'' (default none)<br />
three options: none, text notifications, custom images<br />
'''none''' will surpress all notifications<br />
'''text notifications''' will use the built in XBMC notification pop-up to let you know about images being downloaded for the first time and the completion status (either nothing downloaded or download complete)<br />
'''custom images''' let's you show an image or directory of images when artwork for an artist is being downloaded for the first time. This won't display if there are local images available to display. If you select this option you must provide the path to the directory that has the custom image or images in it (stored in '''custom notification images folder''')<br />
'''Progress images folder:''' (default empty)<br />
Must be set to a valid local path with one or more images to be displayed while first image for an artist is being downloaded

AS replaces certain reserved characters in an artist names with an alternate character when looking for a local artist folder.<br />
'''Platform for image store''' can be Windows, MacOS, or Other. When set to Windows, the characters <>:"/\|?*and trailing periods are replaced with whatever is set in the settings. When set to MacOS, the character : is replaced with whatever is set in the settings. If set to other, any characters defined by os.path.sep are replaced with whatever is set in the settings.<br />
'''Replace illegal path characters in artist name with''' (default _)<br />
This character replaces any illegal characters noted above.<br />
'''Replace trailing period in artist name with:''' (default BLANK)<br />
This character replaces any trailing period as noted above.

''Limit size of download cache:'' (default false)<br />
if enabled, the download cache will be trimmed (oldest first) to keep the size below the specified minimum. Please note that if you set the image download priority to '''both''' on the Slideshow settings, this setting has no effect, as the cache manger is disabled to protect your local artwork from being deleted.<br />
'''Maximum cache size (in megabytes):''' (default 1024)<br />
if Limit size of download cache is set to true, this allows the user to specify the maximum size of the cache

''Enable debug logging:'' (default false)<br />
When enabled, if you have XBMC logging set the DEBUG you will get a very verbose set of information in your log file. You should only need to activate this when troubleshooting issues.

== Overriding Artist Info with Local Information ==

=== Directory Structure ===
To override the downloaded information, you need to create another directory in the folder you defined in the settings as the Local artist folder. Your folder structure will look something like this:
<artistname>
extrafanart
override
albums (folder with artist album art)
albumname.jpg (any XBMC image type supported)
anotheralbumname.jpg
artistbio.nfo (see below for format)
artistsalbum.nfo (see below for format)
artistsimilar.nfo (see below for format)
similar
artistimage.jpg
anotherartistimage.jpg

=== Override nfo file formats ===
All .nfo files are xml files (pretty simple ones) patterned after the XML files downloaded from last.fm.

Example artistbio.nfo
<?xml version="1.0" encoding="utf-8"?>
<artist>
<content>This is the artist's bio.</content>
</artist>

Example artistsalbum.nfo
<?xml version="1.0" encoding="utf-8"?>
<topalbums>
<album>
<name>Some Album</name>
<image>albumname.jpg</image>
</album>
<album>
<name>Another Album</name>
<image>anotheralbumname.jpg</image>
</album>
</topalbums>

Example artistsimilar.nfo
<?xml version="1.0" encoding="utf-8"?>
<similarartists>
<artist>
<name>Some Similar Artist</name>
<image>artistimage.jpg</image>
</artist>
<artist>
<name>Another Similar Artist</name>
<image>anotherartistimage.jpg</image>
</artist>
</similarartists>

== Accessing Script from Other Screens ==
You might want to use Artist Slideshow to display images somewhere other than on the music visualization. To do that you need to start Artist Slideshow when XBMC starts using DAEMON mode. To do that use:
RunScript(script.artistslideshow, daemon=True)

== New skin properties ==
Window(Visualisation).Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist

Window(Visualisation).Property(ArtistSlideshowRunning)
This one is used internally by the script to check if it is already running. There's no need to use this property in your skin.

Window(Visualisation).Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window(Visualisation).Property(ArtistSlideshow.%d.SimilarName)
Window(Visualisation).Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists (from last.fm)

Window(Visualisation).Property(ArtistSlideshow.%d.AlbumName)
Window(Visualisation).Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist (from theaudiodb.com)

Window(Visualisation).Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window(Visualisation).Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

== How to call this addon from another addon ==
To use this addon to provide the background for another addon, the calling addon must create a window that uses a multimage control:
<control type="multiimage">
<posx>0</posx>
<posy>0</posy>
<width>1280</width>
<height>720</height>
<imagepath background="true">$INFO[Window.Property(ArtistSlideshow)]</imagepath>
<aspectratio>keep</aspectratio>
<timeperimage>10000</timeperimage>
<fadetime>2000</fadetime>
<randomize>true</randomize>
<animation effect="fade" start="0" end="100" time="300">Visible</animation>
<animation effect="fade" start="100" end="0" time="300">Hidden</animation>
</control>

That window must have an infolabel in which the currently playing artist is stored (suggested name is CURRENTARTIST) as well as one for the song title (suggested name is CURRENTTILE). It is the responsibility of the calling addon to change those infolabels when the artist/song changes.

=== Calling the addon ===
Artist Slideshow does not exit after being called. It continues to run to check for changes in the artist infolabel. Becasue of that, the calling addon will have to create another thread for Artist Slideshow. The calling addon needs to import the python theading module for this to work.

def runArtistSlideshow(self):
#startup artistslideshow
xbmcgui.Window(xbmcgui.getCurrentWindowId()).setProperty("ArtistSlideshow.ExternalCall", "True")
#assumes addon is using suggested infolabel name of CURRENTARTIST and CURRENTTITLE
artistslideshow = "RunScript(script.artistslideshow,windowid=%s&artistfield=%s&titlefield=%s&albumfield=%s&mbidfield=%s)"
% (xbmcgui.getCurrentWindowId(), "CURRENTARTIST", "CURRENTTITLE", "CURRENTALBUM", "CURRENTMBID")
xbmc.executebuiltin(artistslideshow)

self.thread = threading.Thread(target=self.runArtistSlideshow)
self.thread.setDaemon(True)
self.thread.start()

When calling Artist Slideshow, only artistfield and titlefield (and their corresponding information stored in the skin) are required. It would be helpful to have albumfield, as it makes it easier to lookup the Musicbrainz ID. If you happen to have the MusicBrainz ID, you can pass that as well.

Note that the line wrap in artistslideshow = is there just for presentation purposes. If you copy and paste the code exactly as is you will get a python error. The suggestion is for the addon to spawn this thread right after it spawns the window.

=== Exiting the addon ===
When the calling addon is preparing to exit, it must tell Artist Slideshow to stop and wait until it has. This logic should be added *before* the addon's window is destroyed. Failure to include this step will likely cause XBMC to crash.

#tell ArtistSlideshow to exit
xbmcgui.Window(xbmcgui.getCurrentWindowId()).clearProperty("ArtistSlideshow.ExternalCall")
#wait until ArtistSlideshow exits
while (not xbmcgui.Window(xbmcgui.getCurrentWindowId()).getProperty("ArtistSlideshow.CleanupComplete") == "True"):
time.sleep(1)

=== Additional script/skin properties available ===
Window.Property(ArtistSlideshow)
This is the path to the directory containing the downloaded images for the currently playing artist.

Window.Property(ArtistSlideshow.ArtistBiography)
Artist biography from theaudiodb.com (or last.fm as fallback)

Window.Property(ArtistSlideshow.%d.SimilarName)
Window.Property(ArtistSlideshow.%d.SimilarThumb)
Similar artists from last.fm

Window.Property(ArtistSlideshow.%d.AlbumName)
Window.Property(ArtistSlideshow.%d.AlbumThumb)
Albums by the artist from theaudiodb.com

Window.Property(ArtistSlideshowRunning)
This one is used internally by Artist Slideshow to check if it is already running. There's no need to use this property in the calling addon's skin.

Window.Property(ArtistSlideshowTransparent)
Let's the skin know that the user has enabled the option to have AS use a transparent background when no artist images are found.

Window.Property(ArtistSlideshow.ArtworkReady)
Set to "true" as soon as an image is ready to be displayed; blank when no image is ready to be displayed. This is useful if you want to show some alternate image until AS has images ready to display.

Window.Property(ArtistSlideshow.ExternalCall)
An external addon needs to set this to True so that Artist Slideshow will run properly when called by an external script. This property should be cleared to tell ArtistSlideshow to stop running.

Window.Property(ArtistSlideshow.CleanupComplete)
This one is used internally by Artist Slideshow to tell an external script that ArtistSlideshow is done running and is exiting.

== Tips and Tricks ==
===Using Artist Slideshow with Fanart.tv===
In order to download images from fanart.tv, AS must have the MusicBrainz ID for the playing artist. The easiest way to get that information is to tag your music using MusicBrainz Picard. Once you have done that rescan your music library to import the new information into Kodi.

=== Removing Unwanted Images ===
Every artist's directory (whether your local one or the one in the cache directory) will have a file named _imagedb.nfo. Once an image has been downloaded, the image name will be stored in that file. If you delete an image, it will not be downloaded again unless you delete the image name from _imagedb.nfo file.

=== Using Artist Slideshow with a Visualization ===
If you want to see artist images and a visualization, make sure the skin is loading the Artist Slideshow images first (i.e at the top of the XML file). That will ensure the artist image is the furtherest back layer. If you choose to use a visualization, please select one with a significant amount of transparent area or you may not see much of anything. For any other skin, please contact the skin developer for a clarification on how visualizations interact with Artist Slideshow.

=== Using Artist Slideshow with AppleTV ===
On AppleTV the PAPlayer sometimes stops after each song and restarts at the beginning of a new one. That, by default, causes Artist Slideshow to stop. Once that happens, artist background images no longer update. Please see [[#Changes_to_MusicVisualisation.xml|Changes to MusicVisualisation.xml above]] for a workaround.

== Getting help ==
If you need assistance using Artist Slideshow, integrating it a skin, or calling it using another addon, please see the support thread on the XBMC forums.
: http://forum.kodi.tv/showthread.php?t=124880

== Beta Testing ==
If you are interested in beta testing new versions of this add on (or just like being on the bleeding edge of up to date), you can install beta versions (Helix or later, there will be no more updates for Gotham or earlier) from [http://raw.github.com/pkscout/repository.beta.pkscout/helix/repository.beta.pkscout-1.1.0.zip pkscout's Add On Beta Channel]. You can also monitor the support thread, as links to particular beta releases will be available there as well.

[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Commands

2018-07-10T12:58:23Z

Kibje: dumb test

{{Addon
|Name=Commands
|provider-name=AddonScriptorDE
|ID=script.commands
|latest-version=1.0.3
|extension point=xbmc.python.pluginsource
|provides=executable
|Summary=Map multiple XBMC commands to one remote button. All availabe commands: http://wiki.xbmc.org/?title=List_of_Built_In_Functions
|Description=Map multiple XBMC commands to one remote button. All availabe commands: http://wiki.xbmc.org/?title=List_of_Built_In_Functions
|Platform=
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?tid=134129
|Website=
|Source=https://github.com/AddonScriptorDE/script.commands
|Email=AddonScriptorDE at yahoo dot de
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.commands/icon.png}}

== Instructions ==
To use this just use a '''[[keymap]]''' to map a button to perform the action:

[[Category:Pages with syntax highlighting errors]]
[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Add-on:Commands

2018-07-10T12:57:24Z

Kibje: syntaxhighlight this is python

{{Addon
|Name=Commands
|provider-name=AddonScriptorDE
|ID=script.commands
|latest-version=1.0.3
|extension point=xbmc.python.pluginsource
|provides=executable
|Summary=Map multiple XBMC commands to one remote button. All availabe commands: http://wiki.xbmc.org/?title=List_of_Built_In_Functions
|Description=Map multiple XBMC commands to one remote button. All availabe commands: http://wiki.xbmc.org/?title=List_of_Built_In_Functions
|Platform=
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.xbmc.org/showthread.php?tid=134129
|Website=
|Source=https://github.com/AddonScriptorDE/script.commands
|Email=AddonScriptorDE at yahoo dot de
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.commands/icon.png}}

== Instructions ==
To use this just use a '''[[keymap]]''' to map a button to perform the action:

<syntaxhighlight lang=python>
RunPlugin(plugin://script.commands)
</syntaxhighlight>

[[Category:Pages with syntax highlighting errors]]
[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

User talk:Kibje

2018-07-10T12:56:20Z

Kibje: test

<syntaxhighlight lang="xml">
<settings>
<category label="Chat">
<setting id="run_chat" type="bool" label="Run IrcChat" default="false" />
<setting id="nickname" type="text" label="Justin.tv Username" default="" visible="eq(-1,true)" />
<setting id="password" type="text" label="Justin.tv Password" default="" option="hidden" visible="eq(-2,true)" />
</category>
</settings>
</syntaxhighlight>

Then pass the host, channel and user parameters of your website to the chat.
<source lang=python>
#if stream started:
xbmc.sleep(3000)
if addon.getSetting('run_chat') == 'true':
xbmc.executebuiltin(
"RunScript(script.ircchat, run_irc=True&nickname=%s&username=%s&password=%s&host=%s&channel=%s)"
%(addon.getSetting('nickname'), addon.getSetting('nickname'),
addon.getSetting('password'), name+'.jtvirc.com', name)
)
</source>

User talk:Kibje

2018-07-10T12:56:01Z

Kibje: test

<syntaxhighlight lang="xml">
<settings>
<category label="Chat">
<setting id="run_chat" type="bool" label="Run IrcChat" default="false" />
<setting id="nickname" type="text" label="Justin.tv Username" default="" visible="eq(-1,true)" />
<setting id="password" type="text" label="Justin.tv Password" default="" option="hidden" visible="eq(-2,true)" />
</category>
</settings>
</syntaxhighlight>

Then pass the host, channel and user parameters of your website to the chat.
<syntaxhighlight lang=python>
#if stream started:
xbmc.sleep(3000)
if addon.getSetting('run_chat') == 'true':
xbmc.executebuiltin(
"RunScript(script.ircchat, run_irc=True&nickname=%s&username=%s&password=%s&host=%s&channel=%s)"
%(addon.getSetting('nickname'), addon.getSetting('nickname'),
addon.getSetting('password'), name+'.jtvirc.com', name)
)
</syntaxhighlight>

User:Kibje

2018-07-10T12:55:49Z

Kibje: Replaced content with "Boo!"

Boo!

User:Kibje

2018-07-10T12:55:19Z

Kibje:

<syntaxhighlight lang="xml">
<settings>
<category label="Chat">
<setting id="run_chat" type="bool" label="Run IrcChat" default="false" />
<setting id="nickname" type="text" label="Justin.tv Username" default="" visible="eq(-1,true)" />
<setting id="password" type="text" label="Justin.tv Password" default="" option="hidden" visible="eq(-2,true)" />
</category>
</settings>
</syntaxhighlight>

Then pass the host, channel and user parameters of your website to the chat.
<syntaxhighlight lang=python>
#if stream started:
xbmc.sleep(3000)
if addon.getSetting('run_chat') == 'true':
xbmc.executebuiltin(
"RunScript(script.ircchat, run_irc=True&nickname=%s&username=%s&password=%s&host=%s&channel=%s)"
%(addon.getSetting('nickname'), addon.getSetting('nickname'),
addon.getSetting('password'), name+'.jtvirc.com', name)
)
</syntaxhighlight>

User:Kibje

2018-07-10T12:54:42Z

Kibje: test

<syntaxhighlight lang=xml>
<settings>
<category label="Chat">
<setting id="run_chat" type="bool" label="Run IrcChat" default="false" />
<setting id="nickname" type="text" label="Justin.tv Username" default="" visible="eq(-1,true)" />
<setting id="password" type="text" label="Justin.tv Password" default="" option="hidden" visible="eq(-2,true)" />
</category>
</settings>
</syntaxhighlight>

Then pass the host, channel and user parameters of your website to the chat.
<syntaxhighlight lang=python>
#if stream started:
xbmc.sleep(3000)
if addon.getSetting('run_chat') == 'true':
xbmc.executebuiltin(
"RunScript(script.ircchat, run_irc=True&nickname=%s&username=%s&password=%s&host=%s&channel=%s)"
%(addon.getSetting('nickname'), addon.getSetting('nickname'),
addon.getSetting('password'), name+'.jtvirc.com', name)
)
</syntaxhighlight>

Category:Pages with syntax highlighting errors

2018-07-10T12:52:00Z

Kibje: rollback

This category contains pages with {{xtag|syntaxhighlight}} or {{xtag|source}} calls which have encountered errors in parsing. To correct them, just define [https://github.com/wikimedia/mediawiki-extensions-SyntaxHighlight_GeSHi/blob/master/SyntaxHighlight.lexers.php a known computing language name] as an [[Attribute (computing)|attribute]] of the <code><nowiki><source lang=></nowiki></code> tag.

Some languages are not yet supported. If the language is valid, do not change or remove the name of the language just to remove the maintenance category. The real fix is to get the language supported by [http://pygments.org/ Pygments].

== Details ==
Many languages (mostly obscure) were de-supported due to the switch from GeSHi to Pygments for syntax highlighting. Fallbacks may be added to [https://phabricator.wikimedia.org/diffusion/ESHG/browse/master/SyntaxHighlight_GeSHi.compat.php SyntaxHighlight_GeSHi.compat.php] where languages are sufficiently similar. For unsupported commonly used languages, please contribute language definitions to Pygments.

A list of the lexers understood in version 1.30 that this wiki is running can be found here: https://phabricator.wikimedia.org/diffusion/ESHG/browse/REL1_30/SyntaxHighlight.lexers.php

== See also ==
* [[Wikipedia:Syntax highlighting]]
* [[mw:Extension:SyntaxHighlight]]

Category:Pages with syntax highlighting errors

2018-07-10T12:51:38Z

Kibje: categories on overview page

{{polluted category}}
{{Wikipedia category|hidden=yes|tracking=yes}}
{{empty category}}

This category contains pages with {{xtag|syntaxhighlight}} or {{xtag|source}} calls which have encountered errors in parsing. To correct them, just define [https://github.com/wikimedia/mediawiki-extensions-SyntaxHighlight_GeSHi/blob/master/SyntaxHighlight.lexers.php a known computing language name] as an [[Attribute (computing)|attribute]] of the <code><nowiki><source lang=></nowiki></code> tag.

Some languages are not yet supported. If the language is valid, do not change or remove the name of the language just to remove the maintenance category. The real fix is to get the language supported by [http://pygments.org/ Pygments].

== Details ==
Many languages (mostly obscure) were de-supported due to the switch from GeSHi to Pygments for syntax highlighting. Fallbacks may be added to [https://phabricator.wikimedia.org/diffusion/ESHG/browse/master/SyntaxHighlight_GeSHi.compat.php SyntaxHighlight_GeSHi.compat.php] where languages are sufficiently similar. For unsupported commonly used languages, please contribute language definitions to Pygments.

A list of the lexers understood in version 1.30 that this wiki is running can be found here: https://phabricator.wikimedia.org/diffusion/ESHG/browse/REL1_30/SyntaxHighlight.lexers.php

== See also ==
* [[Wikipedia:Syntax highlighting]]
* [[mw:Extension:SyntaxHighlight]]

Add-on:IrcChat

2018-07-10T12:49:45Z

Kibje: syntaxhighlight fix

{{Addon
|Name=IrcChat
|provider-name=divingmule, MassIV
|ID=script.ircchat
|latest-version=1.0.1
|extension point=xbmc.python.script
|provides=executable
|Summary=An IRC Client
|Description=
This add-on is a basic IRC client for Kodi mediacenter.
Internet Relay Chat (IRC) is a protocol for live interactive
Internet text messaging (chat) or synchronous conferencing.
It is mainly designed for group communication in discussion forums, called channels.

|Platform=all
|Language=
|License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991
|Forum=http://forum.kodi.tv/showthread.php?tid=163588
|Website=http://kodi.wiki/view/Add-on:IrcChat
|Source=https://github.com/divingmule/script.ircchat
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.ircchat/icon.png}}

== IRC ==
Internet Relay Chat (IRC) is a protocol for live interactive Internet text messaging (chat) or synchronous conferencing.

[http://en.wikipedia.org/wiki/Internet_Relay_Chat Internet Relay Chat Wiki]

Many web chat's on the internet use an IRC server behind the scenes. It's well established and usable on all operating systems.
And for instance XBMC, has it's own IRC channel on Freenode. Much like the forum, a place to talk or ask a question.
Now lets have a look at that channel as example. The host looks like this '''irc.freenode.org'''. Kind of like a web address.
And you could in fact connect to the channel with a browser like so:

[http://irc.lc/freenode/xbmc/irctc@@@ XBMC via webchat]

That's nice. But why a chat in a media center?
Well, many live video streaming websites have a chat next to the stream. And watching these streams on our mediacenter without them sometimes felt like listening to half a conversation. So that is how the first version of the chat came to be. It was just read only, but then it started to grow.

== Popular servers ==
* [http://xbmc.org/ Xbmc.org]: irc.freenode.org #xbmc
* [http://www.justin.tv/ Justin.tv]: channel_name.jtvirc.com #channel_name
* [http://twit.tv/ Twit.tv]: irc.twit.tv #twitlive
* [http://www.twitch.tv/ Twitch.tv]: channel_name.jtvirc.com #channel_name
* [http://www.ustream.tv/ Ustream.tv]: chat1.ustream.tv OR c.ustream.tv #channel_name

== How To ==
After installing the addon.
* Go into the addon settings.
{{highlight|bordered=yes|[[Add-ons|Program Add-Ons -> IrcChat -> Context -> Add-On Settings]]}}
* Here you can input your initial login information, host and channel.
* Next, start a steam or playlist.
* Go to programs and start the IrcChat addon (use TAB toswitch to fullscreen video).

* It is also possible to map a key to starting the script. As an easy way to start during playback, switch hosts or usernames.
<syntaxhighlight lang=xml>
<F1>RunScript(script.ircchat, run_irc=True&nickname=MyNick&username=name&password=pass123&host=irc.freenode.org&channel=xbmc)</F1>
</syntaxhighlight>

* There is a button in the top {{highlight|bordered=yes|[[List Container|<]]}} to slide out either a list of channels or a list of users. Depending on whether you are in a channel or not.
* A button to change colors {{highlight|bordered=yes|[[Spin Control|c]]}} that gives you a 'spin control'.
* The chat's keyboard input also allows you to input a channel name to connect to IF you are not in a channel. You do not need to enter the # in front of the channel name.
* Selecting your own name in the list of users allows you options like changing your name IF this is supported by the host you are on.

== Login Token ==
As of Sept. 17, 2013, Twitch now requires that you log into IRC using an OAuth token instead of your plaintext password or hash for additional security. To generate a token, visit:
http://www.twitchapps.com/tmi/

== Screenshots ==

<gallery widths=200px heights=113px>
File:script.ircchat-screenshot-1.png
File:script.ircchat-screenshot-2.png
File:script.ircchat-screenshot-3.png
File:script.ircchat-screenshot-4.png
</gallery>

== Add-on integration ==
If you wish to integrate the chat with your video streaming add-on. Host, nickname, and username are required, the other parameters are optional.
<syntaxhighlight lang=xml>
<settings>
<category label="Chat">
<setting id="run_chat" type="bool" label="Run IrcChat" default="false" />
<setting id="nickname" type="text" label="Justin.tv Username" default="" visible="eq(-1,true)" />
<setting id="password" type="text" label="Justin.tv Password" default="" option="hidden" visible="eq(-2,true)" />
</category>
</settings>
</syntaxhighlight>

Then pass the host, channel and user parameters of your website to the chat.
<syntaxhighlight lang=python>
#if stream started:
xbmc.sleep(3000)
if addon.getSetting('run_chat') == 'true':
xbmc.executebuiltin(
"RunScript(script.ircchat, run_irc=True&nickname=%s&username=%s&password=%s&host=%s&channel=%s)"
%(addon.getSetting('nickname'), addon.getSetting('nickname'),
addon.getSetting('password'), name+'.jtvirc.com', name)
)
</syntaxhighlight>

== Skin integration ==
To simply overwrite one or two images (for example the loading .png). Add a folder to your skin media folder called "IrcChat".
And place your own loading image in there with the same name as it has in the IrcChat add-on. In this case "ChatBusy.png".

To completely adjust all aspects of the chat layout. Place an xml file with the name "script-IrcChat-main.xml" in your skin's 720p folder. Or start by taking a copy of the one from the add-on. Note: Doing so requires all images to be in your skin, it will no longer look in the add-on folder.

[[Category:Pages with syntax highlighting errors]]
[[Category:Add-ons with license tag]]
[[Category:Add-ons with source tag]]
[[Category:Add-ons with website tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Social media]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Template:Index three column/doc

2018-07-10T12:48:07Z

Kibje: /* Example 1 */ syntaxhighlight fix

Used for "landing pages" or "indexes" for a given topic. Creates a three column layout for links and summaries for those pages, with the summaries being generated from the intro sections marked on a given page.

== Usage ==
The template can format anywhere between 1 and 20 page links.

The only required parameter is <code>| link 1 =</code>. To make a second link, use <code>| link 2 =</code>, and so on until 20.

Each link can also have an image icon, defined by <code>| image =</code>.

=== Parameters ===
{| class="prettytable"
! Parameter !! Description
|-
| '''<code><nowiki>|</nowiki> link # =</code>'''
| Page title to be linked to.
|-
| '''<code><nowiki>|</nowiki> link name # =</code>'''<br />{{small|''(optional)''}}
| If you wish the displayed title to be different.
|-
| '''<code><nowiki>|</nowiki> image # =</code>'''<br />{{small|''(optional)''}}
| An icon to be displayed with the link. The icon will be clickable with the above link. All images are auto resized to fit within 60px wide or tall. If no image is provided then [[:File:Circle arrow right font awesome.png]] will be used.
|-
| {{nowrap|1='''<code><nowiki>|</nowiki> description # =</code>'''}}<br />{{small|''(optional)''}}
| By default the descriptive text is the "intro" section (if marked) on the target link page. Use this parameter to override this.
|}

== Examples ==
=== Example 1 ===
<syntaxhighlight lang=text enclose="div">
{{Index three column
| image 1 = Preferences-system.png
| link 1 = Video management
| image 2 = Oxygen480-actions-media-playback-start.png
| link 2 = Video playback
| image 3 = Crystal Clear app starthere.png
| link 3 = Basic_controls
| image 4 = Television.png
| link 4 = Live TV
| image 5 = Map symbol concert hall 02.png
| link 5 = Music videos
| image 6 = Nuvola apps kthememgr.png
| link 6 = Add-ons
| image 7 = Gnome-system-run.png
| link 7 = Settings
}}
</syntaxhighlight>

''creates:''

{{Index three column
| image 1 = Preferences-system.png
| link 1 = Video management
| image 2 = Oxygen480-actions-media-playback-start.png
| link 2 = Video playback
| image 3 = Crystal Clear app starthere.png
| link 3 = Basic_controls
| image 4 = Television.png
| link 4 = Live TV
| image 5 = Map symbol concert hall 02.png
| link 5 = Music videos
| image 6 = Nuvola apps kthememgr.png
| link 6 = Add-ons
| image 7 = Gnome-system-run.png
| link 7 = Settings
}}

=== Blank template ===
<pre>
{{Index two column
| image 1 =
| link 1 =
| image 2 =
| link 2 =
| image 3 =
| link 3 =
| image 4 =
| link 4 =
| image 5 =
| link 5 =
| image 6 =
| link 6 =
| image 7 =
| link 7 =
| image 8 =
| link 8 =
}}
</pre>

== See also ==
* [[Template:Index two column]]
* [[Template:Main page icon]]
* [[Template:List]]

<includeonly>
[[Category:Page specific templates]]
</includeonly>

HOW-TO:Install Kodi for Linux

2018-07-10T12:47:35Z

Kibje: syntaxhighlight fix

{{mininav|[[Linux]] {{l2| [[Installation]] }} }}
== Installing Kodi on Ubuntu-based distributions ==
{{warning|Some (later) Ubuntu versions include Kodi built by Ubuntu themselves. If you have installed Ubuntu Kodi, please remove the packages "kodi kodi-bin kodi-data" before trying to install team-xbmc PPA packages.}}

See [[SSH]] or [http://help.ubuntu.com/community/UsingTheTerminal Click here to find out how to use the terminal.]

Use the command line terminal and enter the following commands. Follow the prompts as you would any other software installation.

<syntaxhighlight lang=bash>
sudo apt-get install software-properties-common
sudo add-apt-repository ppa:team-xbmc/ppa
sudo apt-get update
sudo apt-get install kodi
</syntaxhighlight>

{{#lst:Team XBMC PPA|repos}}

Note that this PPA only provides builds for Ubuntu i386 and Ubuntu amd64 but not for Ubuntu armhf, which can run on a Raspberry Pi.

=== Installing binary add-ons (PVR, audio decoders, audio encoders, screensavers, visualizations, audio DSP) ===
{{see|Ubuntu binary add-ons}}

=== Installing a development build ===
{{see also|Development builds}}
To install a beta/unstable version of {{kodi}} you must first add the unstable repository, then install XBMC. Use <code>ppa:team-xbmc/xbmc-nightly</code> for nightly builds and <code>ppa:team-xbmc/unstable</code> for [[beta]] builds.

<syntaxhighlight lang=bash>
sudo add-apt-repository ppa:team-xbmc/xbmc-nightly
sudo apt-get update
sudo apt-get install kodi
</syntaxhighlight>

Note that if you have any addons (such as PVR clients), these must be updated as well (they will not be updated automatically):
<syntaxhighlight lang=bash>
sudo apt-get install kodi-pvr-mythtv
</syntaxhighlight>

=== Upgrading ===
<section begin="Ubuntu upgrade" />
To update Kodi when a new version is released, just do a general system/package or use the following commands in the terminal (or via [[SSH]]):

<syntaxhighlight lang=bash>
sudo apt-get update
sudo apt-get upgrade
</syntaxhighlight>

{{note|In some cases where additional packages are required, Kodi will fail to upgrade when using the upgrade commands as above. To install additional packages use the command below:

<syntaxhighlight lang=bash>
sudo apt-get dist-upgrade
</syntaxhighlight>}}
<section end="Ubuntu upgrade" />

=== Downgrading to a stable version from a development version ===
If you install a nightly build or an unstable release and want to return to a stable release, follow these instructions:

Find the current PPA you are using:
<syntaxhighlight lang=bash>
sudo apt-cache policy | grep team-xbmc
</syntaxhighlight>

Remove the unstable or nightly PPA where it says '''PPAHERE''':
<syntaxhighlight lang=bash>
sudo add-apt-repository -r ppa:PPAHERE
</syntaxhighlight>

Then restore the stable version with the following commands:
<syntaxhighlight lang=bash>
sudo add-apt-repository ppa:team-xbmc/ppa
sudo apt-get update
sudo apt-get remove kodi kodi-bin
sudo apt-get install kodi
</syntaxhighlight>

=== Downgrading between newer and older stable versions ===
If you want to return to the previous stable release, follow these instructions:

Remove the current stable PPA:
<syntaxhighlight lang=bash>
sudo add-apt-repository -r ppa:team-xbmc/ppa
</syntaxhighlight>

Then install the old stable version with the following commands:
<syntaxhighlight lang=bash>
sudo add-apt-repository ppa:team-xbmc/kodi-old
sudo apt-get update
sudo apt-get remove kodi*
sudo apt-get install kodi
</syntaxhighlight>

=== Reverting to an earlier nightly ===
ALthough launchpad doesn't list older nightlies in their PPA, they are usually still available for download directly from the website.
Visit https://launchpad.net/~team-xbmc/+archive/ubuntu/xbmc-nightly/+packages?field.name_filter=&field.status_filter=superseded&field.series_filter=

You will then have to download the appropiate .deb file and manually install it.

=== Uninstalling ===
If you need to remove and purge an application and finally removing/purging also the application configurations files, do so by using the following commands:

<syntaxhighlight lang=bash enclose="div">
sudo apt-get update
sudo apt-get remove kodi*
sudo apt-get purge kodi*
</syntaxhighlight>

Then remove the settings folder to remove all settings and library data. This will not delete any videos or music, but just the settings and library data itself:
<syntaxhighlight lang=bash>
rm -r ~/.kodi/
</syntaxhighlight>
or
<syntaxhighlight lang=bash enclose="div">
rm -r ~/.xbmc/ # for older versions before 14.0
</syntaxhighlight>

== Embedded/Appliance type install==

=== LibreELEC ===
{{main|LibreELEC}}
{{#lst:LibreELEC|intro}}

== Third Party Repositories ==


The instructions in this section are for unofficial Linux binaries that are un/semi supported by Team Kodi. Most of those binaries use system ffmpeg or even worse totally untested libav, which is not recommended for {{kodi}} as we support ffmpeg only.

=== Debian ===
In Debian 9 (Stretch), Kodi is available in the default "main" Debian repository (you can check this with 'apt-cache show kodi' to show the description or 'apt-cache policy kodi' to check installed/available version).

In Debian 9 (Stretch), update APT and install:
<syntaxhighlight lang=bash>
sudo apt-get update
sudo apt-get install kodi
</syntaxhighlight>

For installation if you are using Debian 8 (Jessie), you can use the debian-backports repository.

Add the following lines to your /etc/apt/sources.list file, as superuser (sudo)

<syntaxhighlight lang=bash>
# kodi repos
# starting with debian jessie, debian provides kodi via its backports repository
# remember: those packages are not supported by team kodi
deb http://http.debian.net/debian jessie-backports main
</syntaxhighlight>

And then, update APT and install Kodi.

<syntaxhighlight lang=bash>
sudo apt-get update
sudo apt-get install kodi
</syntaxhighlight>

Enjoy your new Kodi.

=== Fedora ===
Refer to [[HOW-TO:Install Kodi on Fedora 26 using RPMFusion packages]] for a guide showing how to install Fedora 26 and Kodi to create a quick-booting, standalone style of media player.

=== Raspbian ===
{{see also|HOW-TO:Install Kodi on Raspberry Pi}}
Installing on Raspbian is done with:

<syntaxhighlight lang=bash>
sudo apt-get install kodi
</syntaxhighlight>

Upgrading on Raspbian is done with:

<syntaxhighlight lang=bash>
sudo apt-get update
sudo apt-get upgrade
</syntaxhighlight>

== Installation from source ==
If distribution packages are not available, or you need a newer version, or specific features enabled, then you will most likely need to compile from source. While compiling from source does not differ very much between distributions (except for installation of build dependencies), a few different guides are available in this wiki.

* [[HOW-TO compile XBMC for Linux from source code]]
* [[HOW-TO compile XBMC for Linux on Debian/Ubuntu]] - This is a tutorial on how to compile and install {{kodi}} on Debian and Ubuntu.
* [[HOW-TO compile Kodi for Linux on Arch/Manjaro]] - This is a tutorial on how to compile and install {{kodi}} on Arch or Manjaro linux.

== See also ==
* [[Linux]]
* [[HOW-TO:Autostart XBMC for Linux]]
*[[JeOS implementations for Kodi]]

* [[Linux FAQ]]

{{Updated|17}}

[[Category:Linux]]
[[Category:How-to]]
[[Category:Installation|Linux]]
[[Category:Manual]]

Archive:Install Kodi on Apple TV 2

2018-07-10T12:46:45Z

Kibje: syntaxhighlight fix

{{mininav| [[iOS]] | [[ATV2]] }}
{{atv2 farewell}}

The current stable release for iOS is {{current version}}.
;Requirements:
{{#lst:Supported hardware|ATV2}}
* If you have any issues, be sure to read the [[iOS FAQ]]!
{{-}}

{{Kodi migration note}}

== Installing from the command line ==
# Open up your [[iOS FAQ#SSH|terminal/ssh application]] and enter the following command to log in to your ATV2. Note, you need to replace "YOUR.ATV2.IP.ADDRESS" with the IP address of the Apple TV:
#: <pre>ssh root@YOUR.ATV2.IP.ADDRESS</pre>
#:: '''EXAMPLE:''' <code>ssh root@192.168.1.5</code>
# You will be asked for a password: ''default password is '''alpine'''''
# Continue to enter the following commands:
#: <pre>apt-get install wget</pre>
#: <pre>wget -O- <nowiki>http://apt.awkwardtv.org/awkwardtv.pub</nowiki> | apt-key add -</pre>
#: <pre>echo "deb <nowiki>http://apt.awkwardtv.org/ stable main" ></nowiki> /etc/apt/sources.list.d/awkwardtv.list</pre>
#: <pre>echo "deb <nowiki>http://mirrors.kodi.tv/apt/atv2 ./" ></nowiki> /etc/apt/sources.list.d/xbmc.list</pre>
#: <pre>apt-get update</pre>
#: <pre>apt-get install org.xbmc.kodi-atv2</pre>
#: <pre>reboot</pre>
And you're done! You should now be running 14.2 for Apple TV 2 (last supported version for the platform). See [[IOS FAQ#XBMC Version|here]] to verify your Kodi version.

== Installing from NitoTV ==
{{notice|While this should work in theory, the official installation method for {{kodi}} is to use the command line instructions. If you have issues with any of the Nito installers then please try the command line instructions to see if that fixes the issue. Nito simply gives a GUI for those command line instructions, so it should work, but Team {{kodi}} has no control over those installers and cannot update them or see any errors from them, or anything like that.}}
;NitoTV on the Apple TV 2
# Scroll right to the NitoTV menu on the Apple TV and choose the first option "''Install Software''".
# Scroll down the list until you see "''Kodi-ATV2''" and click on that.
# From that menu press "''install''" and your Apple TV will install {{kodi}} and then do a '''SOFT''' reboot (no tethered boot required).
# {{kodi}} will now be in your Apple TV menu, scroll right to it, click and enjoy.
And you're done! You should now be running 14.2 Apple TV 2. See [[IOS FAQ#XBMC Version|here]] to verify your {{kodi}} version.
{{-}}

== Updating ==
Either update through NitoTV or issue the following commands to update:
# Open up your [[iOS FAQ#SSH|terminal/ssh application]] and enter the following command to log in to your ATV2:
#: <pre>ssh root@YOUR.ATV2.IP.ADDRESS</pre>
#:: '''EXAMPLE:''' <code>ssh root@192.168.1.5</code>
# You will be asked for a password: ''default password is '''alpine'''''
# Continue to enter the following commands:
#: <pre>apt-get update</pre>
#: <pre>apt-get install org.xbmc.kodi-atv2</pre>

== Development and custom builds ==
{{anchor|Monthly builds|Beta|Frodo beta|Frodo RC|Beta builds|Nightly builds|Development builds}}
{{main|Development builds}}

{{highlight|color=#FFB5B5| {{big|ALWAYS '''[[BACKUP]]''' YOUR '''[[userdata|USERDATA FOLDER]]''' WHEN USING DEVELOPMENT BUILDS! }} }}

{| class="prettytable"
|-
! Build !! Description !! URL
|-
| '''Nightly build''' || Nightly builds are unstable test builds that have the latest bug fixes and feature additions. They are not fully tested, so anticipate issues and be sure to [[iOS FAQ#Backup|backup your userdata folder]] || http://mirrors.kodi.tv/nightlies/darwin/atv2/
|-
| '''Monthly build''' || Monthly builds are more stable than nightly builds, but still contain lots of experimental new code. || http://mirrors.kodi.tv/snapshots/darwin/atv2/
|-
| '''Betas and {{nowrap|release candidates}}''' || Betas and release candidates are builds that are being tested to see if they have any bugs left before becoming a stable release. Most major bugs should be fixed in these builds. || http://mirrors.kodi.tv/apt/pre-release/atv2/deb/
|-
| '''Older stable builds''' || If you wish to download an older version of {{kodi}} for whatever reason, you can do so with these same instructions below. || http://mirrors.kodi.tv/apt/atv2/deb/
|}

# Open one of the above URL locations in a web browser and copy the url of the '''most recent file''' in that listing.
#:: '''EXAMPLE:''' <code><nowiki>http://</nowiki>mirrors.kodi.tv/nightlies/darwin/atv2/kodi-20150120-e740097-master-atv2'''.deb'''</code>
# Open up your [[iOS FAQ#What is SSH?|terminal/ssh application]] and enter the following command to log in to your ATV2:
#: <pre>ssh root@YOUR.ATV2.IP.ADDRESS</pre>
#:: '''EXAMPLE:''' <code>ssh root@192.168.1.5</code>
# You will be asked for a password: ''default password is '''alpine'''''
# Continue to enter the following commands:
#: <pre>rm -f *kodi*.deb</pre>
#: <pre>apt-get update</pre>
#: <pre>wget URL-FROM-STEP-ONE-HERE</pre>
#:: '''EXAMPLE:''' <code><nowiki>wget http://</nowiki>mirrors.kodi.tv/nightlies/darwin/atv2/kodi-20150120-e740097-master-atv2'''.deb'''</code>
#: <pre>dpkg -i *kodi*.deb</pre>
#: <pre>rm *kodi*.deb</pre>

See [[IOS FAQ#XBMC Version|here]] to verify your {{kodi}} version.

{{note|To go back to a stable version of {{kodi}} you might need to first uninstall {{kodi}} and then use the normal install instructions, or manually download the stable release deb file and install using the dev build instructions.}}

=== Going from Kodi to XBMC ===
Due to the name change, the steps for downgrading between Kodi (starting at v14 and up) to XBMC (v13.2 and lower) requires slightly different steps:

# Open one of the [[#Development and custom builds|above URL locations]] in a web browser and copy the url of the version you wish to install.
#:: '''EXAMPLE:''' <code><nowiki>http://</nowiki>mirrors.kodi.tv/apt/atv2/deb/old/org.xbmc.xbmc-atv2_12.2-0_iphoneos-arm'''.deb'''</code>
# Open up your [[iOS FAQ#What is SSH?|terminal/ssh application]] and enter the following command to log in to your ATV2:
#: <pre>ssh root@YOUR.ATV2.IP.ADDRESS</pre>
#:: '''EXAMPLE:''' <code>ssh root@192.168.1.5</code>
# You will be asked for a password: ''default password is '''alpine'''''
# Continue to enter the following commands:
#: <pre>rm -f *kodi*.deb</pre>
#: <pre>rm -f *xbmc*.deb</pre>
#: <pre>apt-get update</pre>
#: <pre>wget URL-FROM-STEP-ONE-HERE</pre>
#:: '''EXAMPLE:''' <code><nowiki>wget http://</nowiki>mirrors.kodi.tv/apt/atv2/deb/old/org.xbmc.xbmc-atv2_12.2-0_iphoneos-arm'''.deb'''</code>
#: <pre>wget http://mirrors.kodi.tv/apt/atv2/deb/org.xbmc.xbmc-seatbeltunlock_1.0-5_iphoneos-arm.deb</pre>
#: <pre>dpkg -i *xbmc*.deb</pre>
#: <pre>rm *xbmc*.deb</pre>

See [[IOS FAQ#XBMC Version|here]] to verify your {{kodi}} version.

== Uninstalling ==
=== Uninstalling just {{kodi}} ===
SSH into your Apple TV (Using the same instructions from above to login). Then run:<br />
<pre> apt-get remove org.xbmc.xbmc-atv2</pre>
or
<pre> apt-get remove org.xbmc.kodi-atv2</pre>

It will ask you if you want to continue:
<pre>The following packages will be REMOVED:
org.xbmc.kodi-atv2
0 upgraded, 0 newly installed, 1 to remove and 5 not upgraded.
After this operation, 0B of additional disk space will be used.
Do you want to continue [Y/n]?</pre>
Just enter "Y" to accept and continue.

=== Removing settings ===
{{kodi}} will uninstall from your Apple TV but will leave certain things ([[databases]] and everything in your [[userdata folder]]) behind to make it easier if you wanted to reinstall. To delete those also run:
<pre>rm -Rf /private/var/mobile/Library/Preferences/XBMC</pre>
<pre>rm -Rf /private/var/mobile/Library/Preferences/Kodi</pre>
This will then be completely clear and {{kodi}} will be removed.

=== Deleting {{kodi}} dependencies ===
{{kodi}} has three dependencies that it installs along with itself when you first install {{kodi}} (org.xbmc.xbmc-seatbeltunlock, gawk, bsdiff). After uninstalling {{kodi}} you can also uninstall these 3 dependencies by running this command:
<syntaxhighlight lang=bash enclose="div">
apt-get remove org.xbmc.xbmc-seatbeltunlock && apt-get remove gawk && apt-get remove bsdiff && apt-get remove org.xbmc.kodi-seatbeltunlock
</syntaxhighlight>

{{Helix updated}}

[[Category:Manual]]
[[Category:IOS|Apple TV 2]]
[[Category:How-to|Apple TV 2]]
[[Category:Installation|Apple TV2]]

Add-on:Cinema Experience

2018-07-10T12:45:01Z

Kibje: syntaxhighlight fix

{{Addon
|Name=Cinema Experience
|provider-name=Giftie
|ID=script.cinema.experience
|latest-version=4.0.11
|extension point=xbmc.python.script
|provides=
|Summary=Re-create a full movie theater experience.
|Description=Play trailers, slideshows, intro videos, outro videos: To re-create a movie theater experience in the comfort of your home.
|Platform=all
|Language=
|License=
|Forum=http://forum.xbmc.org/showthread.php?tid=87563
|Website=
|Source=https://github.com/Giftie/script.cinema.experience
|Email=
|broken=
|icon url=http://mirrors.kodi.tv/addons/krypton/script.cinema.experience/icon.png}}

= About Cinema Experience =
== History ==
This add-on has a lot of history. It started life in 2009 as the Home Theatre Experience script, written by an amazing and skilled Python programmer '''nuka1195'''. Through out its life it has brought many changes to XBMC. In December 2010, '''giftie''' took the reigns, and the script was modified to work with the new add-on engine in XBMC's Dharma. The name was changed, and the incarnation of Cinema Experience you know was born.

In the beginning, the script was only being maintained to function with XBMC. Then the script needed some functional repairs. Later, some major changes (and even some that brought about negative feedback). Now it's 2013, and XBMC Frodo is here. Cinema Experience is here to stay. Cinema Experience is currently maintained and improved by '''giftie'''. He's added numerous features to the script, and provides invaluable support via the [http://forum.kodi.tv/showthread.php?tid=87563 XBMC forums].

== What does it do? ==
The Cinema Experience script will add that WOW factor to your home theater, and give you a true Cinema Experience! Yes, you will still have to supply the popcorn and drinks. There's not much we can do about that. This script allows you to play trivia slides, movie trailers and other videos (intros and outros) that will help you get that Cinema Experience - just like at the local theater. Trivia slides can be any JPG or PNG image (many Movie Trivia, Stills, and Movie Fact packs already exist). The Feature Presentation Movie(s) must be in your Video Library. Cinema Experience can stream trailers, download them from Apple Movie Trailers, or play locally stored trailer(s) that are on your system or in your Movie Library.

== What doesn't it do? ==
The Cinema Experience script will NOT work with any movies that are NOT local and scraped into your Movie Library. This means that any streaming content (let's use Netflix as an example, but this applies to any and all Video Add-ons that stream content to XBMC) either supported and in the official repository or not supported and in a third party repository will not work with the Cinema Experience script.

== How do I get it? ==
At the moment, for XBMC Dharma and Eden this add-on is only available through installable ZIP files. The Frodo version has been added to the Official Official XBMC Repository, making it easier to get.

Dharma: [http://www.mediafire.com/file/6r7d1pqnfeib7xx/script.cinema.experience.1.0.53.zip Download]

Eden: [https://www.dropbox.com/s/9xqnclvosuhm2o1/script.cinema.experience.2.0.57.zip Download]

Frodo: Available from the Official XBMC Repository

== Reporting Bugs & Requesting Features ==
Cinema Experience is an evolving creature, getting better and more feature-rich with each release. That said, ''bugs happen''. When they do, a bug report needs to be made. These are to be made on the Cinema Experience [http://forum.kodi.tv/showthread.php?tid=87563 forum thread]. A [http://wiki.xbmc.org/index.php?title=Debug_log debug log] is '''ALWAYS''' required, along with the steps needed to re-create the bug. I won't be able to help you if I can't understand what's happening.

<big>'''Reporting Bugs: Method 1'''</big>

Use the Debug Log Script.

<big>'''Reporting Bugs: Method 2'''</big>

Manually [[Log File|locate your xbmc.log file]].
Copy & paste your xbmc.log file to [http://pastebin.com/ pastebin.com] (or a similar site).

''Note:'' If you feel that you have private information in your log file that you don't want the public be able to see, set up an account on [http://pastebin.com/ pastebin.com] and store it as a private paste.

<big>'''Uploading Logs'''</big>
# Put XBMC into Debug Mode.
# Restart XBMC.
# If you have add-ons that run automatically when XBMC starts, wait a few minutes for these scripts to run (ShareThe.TV, Weather.com Plus, etc.).
# Run Cinema Experience.
# Upload your '''FULL''' xbmc.log file to [http://pastebin.com/ pastebin.com] (or a similar site).
# Create a new forum message in [http://forum.kodi.tv/showthread.php?tid=87563 this thread]. Includethe steps required to reproduce the bug and your [http://pastebin.com/ pastebin.com] URL.

<big>'''Requesting Features'''</big>

I accept feature requests in [http://forum.kodi.tv/showthread.php?tid=87563 this thread]. Be sure to be specific about what you'd like to see added.

= Information & Setup =

== Supported Ratings Systems ==
Cinema Experience currently supports the [http://www.mpaa.org/ MPAA], [http://www.bbfc.co.uk/ BBFC], [http://www.fsk.de/ FSK] and [http://www.mj.gov.br/classificacao DEJUS] ratings systems. If you'd like a new rating system supported, post in [http://forum.kodi.tv/showthread.php?tid=87563 this thread]. You may need to provide a database file, or some screenshots of the table. I need to know each different rating in that column. What I need to see will depend on your database. If you are using the default database format (i.e. you haven't made any changes to XBMC) you can post the database file to ''Google Drive'' or ''Drop Box'' and then PM me a link to the file. If you are using MySQL, you will need to access it yourself (using a viewer of some sort) and send me some screenshots '''movieview''' table. Generally, column '''c12''' contains the ratings.

The database you need depends on the OS you are using. [[Databases|This Wiki Page]] will help you find the proper file. The Video database is named '''MyVideosXX.db''' - with XX representing the database version. Use the one with the latest date.

== Sequence Overview ==
Cinema Experience gives you the ability to enable or disable any introduction videos, or the trivia slideshow. You have the power to customize your cinema experience. The following is an example of the complete script flow:

'''
:# Trivia Intro Video(s)
:# Trivia Slides with Optional Music Playlist
:# Trivia Outro Video(s)
:# Movie Theater Intro Video(s)
:# Coming Attractions Intro Video(s)
:# Trailer(s)
:# Coming Attractions Outro Video(s)
:# 3D Intro Video(s) - if upcoming Movie is in 3D format
:# 3D Trailers( from folder as I haven't found a site that has them really available) - if upcoming Movie is in 3D format
:# '''''Countdown Video'''''
:# '''''Feature Presentation Intro Video(s)'''''
:# '''''Rating Video''''' (MPAA, BBFC and FSK ratings are currently supported)
:# '''''Audio Format Video'''''
:# FEATURE PRESENTATION
:# '''''Intermission Video(s)''''' (note)
:# '''''Rating Video'''''
:# '''''Audio Format Video'''''
:# FEATURE PRESENTATION 2
:# '''''Intermission Video(s)''''' (note)
:# '''''Rating Video'''''
:# '''''Audio Format Video'''''
:# FEATURE PRESENTATION 3
:# '''''Intermission Video(s)''''' (note)
:# '''''Rating Video'''''
:# '''''Audio Format Video'''''
:# FEATURE PRESENTATION 4
:# '''''Intermission Video(s)''''' (note)
:# '''''Rating Video'''''
:# '''''Audio Format Video'''''
:# FEATURE PRESENTATION 5 (end note)
:# '''''Feature Presentation Outro Video(s)'''''
:# 3D Outro Video(s) - if upcoming Movie is in 3D format
:# Movie Theater Outro Video(s)
'''

'''''Available in 3D if upcoming movie is 3D and settings enabled'''''

<small>''(note)''</small> At this point in the script, if multiple features have been queued and the skin uses home menu integration, multiple rating videos, audio format videos, features, and intermission videos will take the place of a single feature. A total of 5 features can be queued. This option can be even larger if you use one of the starting methods suggested in the Script Starting methods section.

== Directory Tree Overviews ==

=== Root Directory Structure ===

This is the suggested directory structure for all of your Cinema Experience content.

[[File:Cinema Experience Root.png]]

=== Audio Format Directory Structure ===

The only directories that need to be in a specific format are in the Audio Format directory. This is because the script uses the name of the Audio Format (DTS, Dolby Digital, etc.) to determine what video to play.

[[File:Audio Format Directory Tree.png]]

=== Intro & Outro Directory Structure ===

Even though these directories don't need to be in a specific format, it's a good idea to use the standard shown below. If you're having trouble, switch to the standard and reconfigure Cinema Experience for the new directory structure.

[[File:Intros %26 Outros Directory Tree.png]]

=== Trivia Directory Structure ===

Even though these directories don't need to be in a specific format, it's a good idea to use the standard shown below. If you're having trouble, switch to the standard and reconfigure Cinema Experience for the new directory structure. The example below shows some popular slide sets copied into the appropriate directory.

[[File:Trivia_Directory_Tree.png]]

== Trivia Slideshow Explained ==

The script can display a slideshow at the start of the experience. The slides can be standard still slides or Q&A(with clues). The best method of storing the slides are to have them in separate folders, the script can search the folders recursively.

=== Types of Slides ===

==== Stills ====

'''Stills''' are trivia slides that only have one part, or are not multiple part slides like the '''Question & Answer''' slides. These slides do not require the use of a ''slides.xml'' file.

==== Q&A ====

'''Question & Answer''' slides have multiple parts (for example: Question, Clue, Answer). This type of slide does require the use of a ''slides.xml'' file to enable the script to determine how and when to display each Q&A slide.

===== XML File Explained =====
<big>'''A Breakdown of the XML File'''</big>
{| class="wikitable"
|-
| <slide rating="'''X'''" /> || This can be used to match the rating of the feature being played, or to set a limit on which slides are played based on value set in the Settings.
|-
| <question format="'''X'''" /> || Provides the format that identifies slides as an Question slide.
|-
| <clue format="'''X'''" /> || Provides the format that identifies slides as an Clue slide.
|-
| <answer format="'''X'''" /> || Provides the format that identifies slides as an Answer slide.
|}

<source lang=xml>
<slides>
<slide>
<slide rating="R">
<question format=".([0-9]{1,3})+_q.jpg" />
<clue format=".([0-9]{1,3})+_c.jpg" />
<answer format=".([0-9]{1,3})+_a.jpg" />
</slide>
</slides>
</source>

<big>'''A Breakdown of ".([0-9]{1,3})+_q.jpg"'''</big>

{| class="wikitable"
|-
| . || Provides identification of any leters (i.e. identifies the word "stills" in "stills20_q.jpg")
|-
| ([0-9]{1,3}) || Provides identification of any number from 0 - 999 (i.e. identifies the number "20" in "stills20_q.jpg").
|-
| +_q || This allows the script to determine if it is a Question, Clue or Answer (i.e. "stills20_q.jpg" is a question, but "stills20_c.jpg" is a clue).
|}

The "+_q" can be any letter or combination of letters as long as the pattern is kept. For example:

{| class="wikitable"
|-
| Question || <question format=".([0-9]{1,3})+_q.jpg" /> || <question format=".([0-9]{1,3})+_a.jpg" />
|-
| Clue || <clue format=".([0-9]{1,3})+_c.jpg" /> || <clue format=".([0-9]{1,3})+_b.jpg" />
|-
| Answer || <answer format=".([0-9]{1,3})+_a.jpg" /> || <answer format=".([0-9]{1,3})+_c.jpg" />
|}

<big>'''Example XML Files'''</big>

This example of a ''slides.xml'' file is for a two part trivia question (Q&A) with words and ordering numbers (i.e. slidename1_q").
<source lang=xml>
<slides>
<slide>
<slide rating="R">
<question format=".([0-9]{1,3})+_q.jpg" />
<clue format="N/A" />
<answer format=".([0-9]{1,3})+_a.jpg" />
</slide>
</slides>
</source>

This example of a ''slides.xml'' file is for a two part trivia question (Q&A) without ordering numbers (i.e. slidename_q").
<source lang=xml>
<slides>
<slide>
<slide rating="R">
<question format=".+_a.jpg" />
<clue format="N/A" />
<answer format=".+_b.jpg" />
</slide>
</slides>
</source>

= Settings Explained =

== Trivia Mode ==
Three(3) modes available: '''None''', '''Slide Show''' and '''Movie Quiz Script'''.

=== None ===

No Trivia pre-show

=== Trivia Slideshow ===

; Slide Show specific settings:
:; Duration(in Minutes): Set the total length, in minutes, of the slide show
:; Slides Folder: The parent folder of the slides
:; Show Question Slide for(seconds): The time, in seconds, that the question slide is displayed on the screen
:; Show Clue Slide for(seconds): The time, in seconds, that the clue slide is displayed on the screen
:; Show Answer Slide for(seconds): The time, in seconds, that the answer slide is displayed on the screen
:; Show Still Slide for(seconds): The time, in seconds, that the still slide is display on the screen
:; Play Music during Slide Show: Enabling this settings the script will play music during the slide show
:::; Music Mode: Two modes available, Music File/Playlist or Music Folder
:::; Music File/Playlist: Select the music file or playlist that is played during the slide show. Only standard playlist(''.m3u, .pls, .asf, .ram'') are allowed(no SmartPlaylist)
:::; Music Folder: Select the folder which to play music from during the slide show
:::; Adjust Volume during Slide Show: Enabling this setting allows the script to drop the volume level during slide show
::::; Music Volume Level: Set the volume level(0-100)
::::; Fade Volume at end of Slide Show: Enabling this setting allows the script to fade the volume down, then back up at the end of the slide show
::::; Fade time in seconds: Set the fade time in seconds
:; Select Only Unwatched slides: Enabling this setting tells the script only to use unviewed slides. The script will automatically reset the watched status during the slide show if slides run out before the end of the slide show
:; Reset Slide watched status: Manually reset the watched status of slides
:; Limit Slides by movie rating(requires slides.xml): Enabling this setting informs the script to limit the slides to a maximum MPAA rating of the movie. Other movie rating formats are roughly assessed and matched to MPAA Ratings
:::; Rating Limit for Trivia(requires slides.xml): If the previous setting is not enabled, adjusting this setting will fix the MPAA level of the slides used in slide show

=== Movie Quiz Script ===

Use the Movie Quiz Script in place of the Slide Show

=== Common Settings to the two trivia modes ===
:; Intro Video: Enabling this setting will play Intro video(s) before Trivia
:::; Single Video: Select a video to play, this also can be a playlist file(''.m3u, .pls, .asf, .ram'')
:::; 1 Random Video: Select a folder to play a single video from, randomly selected
:::; 2 Random Videos: Select a folder to play a two(2) videos from, randomly selected
:::; 3 Random Videos: Select a folder to play a three(3) videos from, randomly selected
:::; 4 Random Videos: Select a folder to play a four(4) videos from, randomly selected
:::; 5 Random Videos: Select a folder to play a five(5) videos from, randomly selected
:; Outro Video: Enabling this setting will play Outro video(s) at the end of the trivia
:::; Single Video: Select a video to play, this also can be a playlist file(''.m3u, .pls, .asf, .ram'')
:::; 1 Random Video: Select a folder to play a single video from, randomly selected
:::; 2 Random Videos: Select a folder to play a two(2) videos from, randomly selected
:::; 3 Random Videos: Select a folder to play a three(3) videos from, randomly selected
:::; 4 Random Videos: Select a folder to play a four(4) videos from, randomly selected
:::; 5 Random Videos: Select a folder to play a five(5) videos from, randomly selected

== Special Videos ==

== Movie Trailers ==

== Feature Presentations ==

== Home Automation ==

== Miscellaneous ==

= Integration =

== Home Automation Integration ==

=== home_automation.py ===
When the script runs for the first time, the script will copy a folder named '''''ha_scripts''''' and it's contents to your '''''userdata\addon_data\script.cinema.experience''''' folder. Inside that folder is a file named ''home_automation.py'', which is a python script that Cinema Experience will trigger. Here is were the coding begins. It may seem intimidating, but it's actually fairly simple. Edit ''home_automation.py'' in a text or script editor. Beginning on line 53 of the file, you will notice commented parts of the code that say ''{{color|#6aa84f|# place code below this line}}'', example shown below in '''bold text'''.

<syntaxhighlight lang=python enclose="div">
class Automate:
def __init__( self ):
pass

def sab_pause(self, mode):
"""
This function provides a method to pause and resume SabNZBd downloading, very useful on a limited network or low powered system

Usage:

apikey - Your SabNZBd API key goes here
ip - The IP of your SabNZBd Machine, if local, leave as is, if it does not work, put the actual address in
port - Normally 5000 but change it to match you SabNZBd program

Pause:

self.sab_pause( "pause" )

Resume:

self.sab_pause( "resume" )
"""
apikey = ""
ip = "127.0.0.1" # address
port = "5000"
url = "http://%s:%s/sabnzbd/" % ( ip, port )
query = {}
query[ "mode" ] = mode
query["apikey"] = apikey
response = urllib2.urlopen( urllib2.Request( url + "api?", urlencode( query ) ) )
response_data = response.read()

def activate_ha( self, trigger = None, prev_trigger = None, mode="normal" ):
if ha_settings[ "ha_enable" ]:
if ha_settings[ "ha_multi_trigger" ] and prev_trigger == trigger:
pass
elif mode != "thread":
self.activate_on( trigger )
else:
thread = Thread( name='ha_trigger', target=self.activate_on, args=( trigger, ) )
thread.start()
prev_trigger = trigger
return prev_trigger

def activate_on( self, trigger = None ):
"""
Scripting to trigger almost anything(HA, other scripts, etc...) when videos start.

Usage:
activate_on( "Movie" )
will trigger code that is set under the Movie heading.

"""
if not trigger:
utils.log( " - [ home_automation.py ] - No Trigger Sent, Returning", xbmc.LOGNOTICE )
return
utils.log( " - [ home_automation.py ] - activate_on( %s ) Triggered" % trigger, xbmc.LOGNOTICE )
if trigger in triggers:
utils.log( " - [ home_automation.py ] - Trigger %s" % trigger, xbmc.LOGNOTICE )
# Script Start
if trigger == "Script Start" and ha_settings[ "ha_script_start" ]:
# place code below this line
pass
# Trivia Intro
elif trigger == "Trivia Intro" and ha_settings[ "ha_trivia_intro" ]:
# place code below this line
pass
</syntaxhighlight>

This line is where we will start. For those not familiar with python, lines beginning with '{{color|#6aa84f|#}}' are comment lines. To get the information to EventGhost, we need the script to send a broadcast. On XBMC Version Eden and Dharma, we used to use the xbmc.executehttpapi() function. Frodo and newer, HTTP API had been removed. Now the script includes it's own UDP Broadcaster. The home_automation.py script module already imports the '''utils''' module, all that is need it to used the '''utils.broadcastUDP()''' function.

The broadcast we need to send from Cinema Experience is something that we can easily identify and distinguish in EventGhost. For this example we will use "CE_Automate". We will also use the html '''<nowiki><b></nowiki>''' tag to start the broadcast, and '''<nowiki></b></nowiki>''' to end the broadcast, as well as '''<nowiki><li></nowiki>''' to separate the trigger. For example:

<syntaxhighlight lang=html>
<b>CE_Automate<li>script_start</b>
<b>CE_Automate<li>trivia_start</b>
</syntaxhighlight>

Now let's put it into the code, but first a little tip about the indentation. Python really likes indentation, in fact it will not work and throw a fit if the indentation is not correct. The script uses '''4 spaces per indentation''', these are also '''not tabs'''. The code we insert will need to line up with the other indented lines. For example:

<syntaxhighlight lang=python enclose="div">
# Script Start
if trigger == "Script Start" and ha_settings[ "ha_script_start" ]:
# place code below this line
utils.broadcastUDP( "<b>CE_Automate<li>script_start</b>" )
</syntaxhighlight>

Now, when the script starts, it will broadcast: <code><nowiki><b>CE_Automate<li>script_start</b></nowiki></code>

=== EventGhost Setup ===

Now we need to turn our attention to EventGhost. Install the '''XBMC Event Receiver''' plugin [http://www.eventghost.net/forum/viewtopic.php?f=10&t=2140&start=30#p18203 found here] and setup with these settings(use the IP 127.0.0.1 if EventGhost is on the same machine as XBMC, otherwise use your XBMC IP address).

{| class="wikitable" width="35%"
|-
! Setting !! Value
|-
| Event-Prefix:
| '''XBMC-Event'''
|-
| XBMC Host IP:
| '''127.0.0.1'''
|-
| XBMC HTTP Port:
| '''8083'''
|-
| XBMC Broadcast IP:
| '''255.255.255.255'''
|-
| UDP Port:
| '''8278'''
|-
| Respond to Self Broadcast:
| '''checked'''
|-
| Payload Delimiter:
| '''<nowiki><b></b></nowiki>'''
|}

The triggers we need to look for are the messages that we have broadcast from Cinema Experience. The '''XBMC Event Receiver''' prefixes the broadcast with ''XBMC-Event.'', so the event we will be looking for messages like this: <code><nowiki>XBMC-Event.<b>CE_Automate<li>script_start</b></nowiki></code>

So now we can create a macro, and use <code><nowiki>XBMC-Event.<b>CE_Automate<li>script_start</b></nowiki></code> as the event, then add what you want EventGhost to do when this event occurs. If the script senses that the playback has stopped (by pressing stop, video crash, etc.) it will trigger the ''script_end'' trigger.

=== Script Triggers ===

Here are a list of the triggers that are available:

{| class="wikitable" width="60%"
|-
! Event !! Trigger
|-
| Script Start
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>script_start</b></nowiki></code>
|-
| Script End
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>script_end</b></nowiki></code>
|-
| Trivia Intro
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>trivia_intro</b></nowiki></code>
|-
| Trivia Start
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>trivia_start</b></nowiki></code>
|-
| Trivia Outro
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>trivia_outro</b></nowiki></code>
|-
| Movie Theater Intro
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>movie_theatre_intro</b></nowiki></code>
|-
| Coming Attraction Intro
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>coming_attractions_intro</b></nowiki></code>
|-
| Trailer
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>trailer</b></nowiki></code>
|-
| Coming Attraction Outro
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>coming_attractions_outro</b></nowiki></code>
|-
| Feature Presentation Intro
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>feature_intro</b></nowiki></code>
|-
| Countdown Video
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>countdown_video</b></nowiki></code>
|-
| Audio Format Video
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>audio_video</b></nowiki></code>
|-
| Rating Video
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>mpaa_rating</b></nowiki></code>
|-
| FEATURE PRESENTATION
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>movie_start</b></nowiki></code>
|-
| Intermission
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>intermission</b></nowiki></code>
|-
| Feature Presentation Outro
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>feature_outro</b></nowiki></code>
|-
| Movie Theater Outro
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>movie_theatre_outro</b></nowiki></code>
|-
| Paused
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>paused</b></nowiki></code>
|-
| Resumed
| <code><nowiki>XBMC-Event.<b>CE_Automate<li>resumed</b></nowiki></code>
|}

== Skin Integration ==

Skin developers can now seamlessly integrate Cinema Experience! Often the chosen location for such integration is in the ''DialogVideoInfo.xml'' file. There are two methods, the old way and the new ''Movie ID'' way. Choose the method for your platform.

=== Old Method (Dharma/Eden) ===
<source lang=xml>
<control type="button" id="49">
<description>Home Theatre</description>
<include>ButtonInfoDialogsCommonValues</include>
<label>Cinema</label>
<onclick>Dialog.Close(MovieInformation)</onclick>
<onclick>XBMC.RunScript(script.cinema.experience)</onclick>
<visible>system.hasaddon(script.cinema.experience) + Container.Content(movies)</visible>
</control>
</source>

=== New Method (Frodo v3.0.1+) ===
<source lang=xml>
<control type="button" id="49">
<description>Home Theatre</description>
<include>ButtonInfoDialogsCommonValues</include>
<label>Cinema</label>
<onclick>Dialog.Close(MovieInformation)</onclick>
<onclick>XBMC.RunScript(script.cinema.experience,movieid=$INFO[ListItem.DBID])</onclick>
<visible>system.hasaddon(script.cinema.experience) + Container.Content(movies)</visible>
</control>
</source>

== Script Starting Methods ==

There are a few different arguments available to change the starting the script. This are mostly for starting from with-in a skin or from an outside source(remote). Each cause the script to behave differently.

<big>'''Using the built-in RunScript Method'''</big> ''<small>often used in skins and keymaps</small>''
:RunScript(script.cinema.experience,argument)

<big>'''Using the JSON RPC Method'''</big>
:{"jsonrpc": "2.0", "method": "Addons.ExecuteAddon", "params": { "wait": false, "addonid": "script.cinema.experience", "params": [ "arguments" ] }, "id": 1}

=== Available Arguments ===

==== Window ID ====

This is primarily used to put the script into multiple feature mode, though it can be used for a single Movie. The user will need to queue the movies into a playlist(normal queuing methods are used, Q on a keyboard, 0 on a remote or from the context menu)

Possible window IDs to use:
::movietitles
::moviegenres
::movieyears
::movieactors
::moviedirectors
::moviestudios
::moviesets
::moviecountries
::recentlyaddedmovies

These match the general quick library links available from the homepage.

eg.
:::RunScript(script.cinema.experience,movietitles)

This will open up the library using Movie Titles, with the script waiting for the set number of features to be queue.

==== Movie ID ====

This is a new method introduced in version 3.0.1 of the script, to replace the former method of starting the script from a skin. The former method(no arguments sent to the script) caused an unsightly jump in the Movie Library list. This was due to the method XBMC uses to queue a video. With Frodo, skins now can extract the database ID for the Movie(using $INFO[ListItem.DBID] ) This method also allow a known database ID to be sent. Multiple database IDs can be sent at the same time, causing the script to go into Multiple Feature mode(fixed in version 3.0.4). The database IDs need to be separated by a semi-colon(;)

eg.
:::RunScript(script.cinema.experience,movieid=$INFO[ListItem.DBID]) <small>''skin method''</small>

:::RunScript(script.cinema.experience,movieid=35) <small>''single movie database ID''</small>
:::{"jsonrpc": "2.0", "method": "Addons.ExecuteAddon", "params": { "wait": false, "addonid": "script.cinema.experience", "params": [ "movieid=35" ] }, "id": 1}

:::RunScript(script.cinema.experience,movieid=35;123;112) <small>''multiple movie database IDs''</small>
:::{"jsonrpc": "2.0", "method": "Addons.ExecuteAddon", "params": { "wait": false, "addonid": "script.cinema.experience", "params": [ "movieid=35;123;112" ] }, "id": 1}

= FAQ =

[[Category:Pages with syntax highlighting errors]]
[[Category:Add-ons with source tag]]
[[Category:All add-ons]]
[[Category:Program add-ons]]
[[Category:Krypton add-on repository]]
[[Category:Isengard add-on repository]]
[[Category:Gotham add-on repository]]
[[Category:Helix add-on repository]]
[[Category:Leia add-on repository]]
[[Category:Jarvis add-on repository]]

Archive:Compile Kodi on openSUSE

2018-07-10T12:39:29Z

Kibje: syntaxhighlight fix

{{mininav|[[Development]]|[[Compiling]]}}
{{redv|Warning:|This page is '''deprecated'''.<br />Starting with Kodi v18 "Leia", Kodi's build guides are kept '''[https://github.com/xbmc/xbmc/blob/master/docs/README.md alongside the code]''', where it is much easier to keep them up-to-date with current code.}}
== Prerequisites ==

In order to successful install XBMC Eden, (by source or by rpms) you need the following Repositories to be added in Yast (change "12.1" to "11.4" or "11.3" if required):

* openSUSE-12.1-Oss (this is already enabled in a standard installation)
http://download.opensuse.org/distribution/12.1/repo/oss/

* Packman Repository
http://ftp.skynet.be/pub/packman/suse/12.1/

You can easly add them by '''YaST (package manager) --> repositories --> repositories manager --> add --> community repositories'''

== Installation ==
=== Installation with RPMs ===
Use YaST or zypper to install XBMC:

<syntaxhighlight lang=bash>$ sudo zypper in XBMC</syntaxhighlight>
'''NOTE:''' XBMC is in the Packman repository
'''NOTE: As of April 1st, 2012, XBMC-Eden (11.0) has not yet been uploaded to the Packman repository'''

You can now skip to ''[[#Run It|Run It!]]''

=== Installation from source code ===

==== Getting the source code ====
===== Stable sources =====

Stable sources can be downloaded in tar.gz format from
http://mirrors.kodi.tv/releases/source/

After downloading, run
<syntaxhighlight lang=bash>$ tar -xfz xbmc-11.0.tar.gz</syntaxhighlight>

You can now skip to ''[[#Installing all building dependencies|Installing all building dependencies]]''

===== Development sources =====
If you want to build xbmc from current development snapshot:
The first time:

<syntaxhighlight lang=bash>$ sudo zypper in git
$ cd $HOME
$ mkdir src
$ cd src
$ git clone git://github.com/xbmc/xbmc.git</syntaxhighlight>

In order to update the source code (and clean old make files):<br />
<syntaxhighlight lang=bash>$ cd $HOME/src
$ git pull
$ make clean</syntaxhighlight>

==== Installing all building dependencies ====

XBMC requires a number of external libraries to build (you may want to copy and paste):

<syntaxhighlight lang=bash>$ sudo zypper in make cmake autoconf automake gcc gcc-c++ libtool gettext-devel patch
$ sudo zypper in boost-devel glew-devel libmysqlclient-devel libass-devel libmpeg2-devel
$ sudo zypper in libmad-devel libjpeg-devel libsamplerate-devel libogg-devel libvorbis-devel
$ sudo zypper in libmodplug-devel libcurl-devel flac-devel libbz2-devel libtiff-devel lzo-devel
$ sudo zypper in libyajl-devel fribidi-devel sqlite3-devel libpng12-devel pcre-devel libcdio-devel
$ sudo zypper in libjasper-devel libSDL_mixer-devel libSDL_image-devel libmicrohttpd-devel
$ sudo zypper in libsmbclient-devel python-devel gperf zip nasm </syntaxhighlight>

==== Compile source ====
To compile respecting openSUSE Filesystem structure please do the following:

===== 32bit (i586) =====
<syntaxhighlight lang=bash>$ cd XBMC_DIRECOTRY (the directory you extracted / pull XBMC into)
$ ./bootstrap
$ ./configure --enable-mid --disable-debug --disable-pulse --prefix=/usr
$ make
$ sudo make install</syntaxhighlight>

===== 64bit (x86_64) =====
I doubt that all this is needed any more - I just did an x86_64 build without this stuff. I had to however install a few more dependencies.

x86_64 users need to export CFLAGS and apply a patch because a non standard '''libdir''' ( http://forum.kodi.tv/showthread.php?t=34527 ) on ubuntu (the only one supported)

create a text file called for example "missing-cflags.patch" a paste inside it the following lines:

http://pastebin.com/f22b29f07

than put it in your folder and type the following:

<syntaxhighlight lang=bash>$ cd $HOME/xbmc
$ mv ../missing-cflags.patch .
$ patch -p1 < missing-cflags.patch
$ CFLAGS="-I/usr/lib64/dbus-1.0/include -I/usr/lib64/glib-2.0/include"
$ export CFLAGS
$ ./configure --enable-mid --disable-debug --disable-pulse --prefix=/usr
$ CFLAGS="-I/usr/lib64/dbus-1.0/include -I/usr/lib64/glib-2.0/include" make
$ sudo make install</syntaxhighlight>

== Run it ==

Open a shell and type <syntaxhighlight lang=bash>xbmc</syntaxhighlight> to launch it.

Continue with [[Media Sources|How to Add Content (Media Sources)]] to your XBMC.

Have fun
[http://developer.novell.com/wiki/index.php/User:Anubisg1 Anubisg1]

[[Category:How-to]]
[[Category:Linux]]
[[Category:Compiling]]

Archive:Use any IR remote with OpenELEC

2018-07-10T12:36:56Z

Kibje: syntaxhighlight fix 2

{{forum link2|1=Have questions about this guide or want to comment on it? Go here: http://forum.kodi.tv/showthread.php?pid=1656784}}
<section begin="intro" />How to get your infrared [[LIRC]] remote working in [[Archive:OpenELEC]]. This guide will show you how to modify OpenELEC so that it works with almost any LIRC remote. The four files are lircd.conf Lircmap.xml remote.xml and autostart.sh

This is really simple and can be accomplished in 15-20 min.<section end="intro" />

You can likely use any remote.xml you can find. The one in the default root location (/usr/share/xbmc/system/keymaps) should be fine. Copy it and put it in the /storage/.xbmc/userdata/keymaps location as we might be tweaking it.

== Guide ==
{{how-to
| Step1 = We must first change the protocol if you are going to use irrecord on the OpenELEC machine.

<syntaxhighlight lang=bash>ir-keytable -p lirc</syntaxhighlight>

| Step2 = First thing is grab the IR remote of your choice and follow the previous tutorial [http://forum.kodi.tv/showthread.php?tid=170372 "Use Any IR Remote In The House"], but '''skip the remote.xml part.'''

| Step3 = Start at step 13 and don't use sudo. Also, use the terminal editor nano or do all of it on some other linux based machine. You will have to adjust a few things as OpenELEC is different.

| Step4 = This will get you the first 2 files and consumes most of the 15 mins.

:lircd.conf
:Lircmap.xml (see below for template)

| Step5 =
Make sure the name of your remote matches in Lircmap.xml and lircd.conf

Here are the valid Lircmap.xml names. Don't try to make up your own. Don't go too crazy. Stick to the common names and it will mean less editing. Copy this entire thing to your Lircmap.xml (change your remote name) and only fill in the ones you need.

<syntaxhighlight lang=xml><lircmap>

<remote device="MY-Remote-Name">

<left></left>
<right></right>
<up></up>
<down></down>
<select></select>
<back></back>

<play></play>
<pause></pause>
<stop></stop>

<volumeplus></volumeplus>
<volumeminus></volumeminus>
<mute></mute>

<pageplus></pageplus>
<pageminus></pageminus>

<power></power>
<menu></menu>
<info></info>
<display></display>
<title></title>

<red></red>
<green></green>
<yellow></yellow>
<blue></blue>

<zero></zero>
<one></one>
<two></two>
<three></three>
<four></four>
<five></five>
<six></six>
<seven></seven>
<eight></eight>
<nine></nine>

<skipplus></skipplus>
<skipminus></skipminus>

<reverse></reverse>
<forward></forward>

<subtitle></subtitle>
<language></language>

<channelplus></channelplus>
<channelminus></channelminus>

<mytv></mytv>
<mymusic></mymusic>
<mypictures></mypictures>
<myvideo></myvideo>
<livetv></livetv>
<recordedtv></recordedtv>
<liveradio></liveradio>
<epgsearch></epgsearch>

<guide></guide>

<record></record>
<start></start>

<star></star>
<hash></hash>
<clear></clear>
<enter></enter>
<xbox></xbox>

<playlist></playlist>
<teletext></teletext>

</remote>

</lircmap>
</syntaxhighlight>

| Step6 = Next create an autostart.sh file in /storage/.config (If you have one already just add the following to that file)

<syntaxhighlight lang=bash>
#!/bin/sh

killall lircd
ir-keytable -p lirc
lircd --device=/dev/lirc0 /storage/.config/lircd.conf
</syntaxhighlight>

You don't need the #!/bin/sh if you already have it in the file.

| Step7 = Make the file executable:
<syntaxhighlight lang=bash>chmod +x /storage/.config/autostart.sh</syntaxhighlight>

| Step8 = Place lircd.conf in /storage/.config/

Place Lircmap.xml in /storage/.xbmc/userdata/

and place remote.xml in /storage/.xbmc/userdata/keymaps/

| Step9 = That's it! Piece of cake. Reboot

| Step10 = If for any reason you want to go back to the way it was, simply delete those files.
}}

== Notes ==
* Credit goes to FishOil for the original guide: http://forum.kodi.tv/showthread.php?pid=1656784

* You also may want to have a look at [http://forum.kodi.tv/showthread.php?tid=189617 Understanding LIRC & XBMC]

* If it doesn't work the first step is to find out if LIRC is configured correctly
:# SSH into the box and type irw
:# Push some buttons on the remote.
:# Your custom remote name should be displayed along with the button name.

[[Category:How-to]]
[[Category:Remotes]]

HOW-TO:Use SMS-style text entry for remotes

2018-07-10T12:35:41Z

Kibje: syntaxhighlight fix

{{mininav|[[Remote controls]]}}
<section begin="intro" />If you have a remote control that is viewed as a keyboard to Kodi and want to enable SMS-style text input and page jumping, this guide wills how you how to enable this using a custom '''[[keymap]]'''. If you have a normal "[[MCE]]" style remote or non-Android [[CEC]] device, then this how-to may not necessary.<section end="intro" />

== Steps ==
{{how-to
| Step1 = Create a '''plain text file''' (no rich text formatting, don't use .doc, etc) and save it as '''keyboard.xml'''. Make sure that the file extension is ".xml" and '''not''' ".txt" or ".xml.txt".

| Step2 = Cut and paste this into your new plain text file:
<syntaxhighlight lang=xml enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<keymap>
<global>
<keyboard>
<zero>Number0</zero>
<one>JumpSMS1</one>
<two>JumpSMS2</two>
<three>JumpSMS3</three>
<four>JumpSMS4</four>
<five>JumpSMS5</five>
<six>JumpSMS6</six>
<seven>JumpSMS7</seven>
<eight>JumpSMS8</eight>
<nine>JumpSMS9</nine>
<escape>Back</escape>
</keyboard>
</global>
<VirtualKeyboard>
<keyboard>
<zero>Number0</zero>
<one>Number1</one>
<two>Number2</two>
<three>Number3</three>
<four>Number4</four>
<five>Number5</five>
<six>Number6</six>
<seven>Number7</seven>
<eight>Number8</eight>
<nine>Number9</nine>
<backspace>Backspace</backspace>
</keyboard>
</VirtualKeyboard>
<FullscreenVideo>
<keyboard>
<zero>Number0</zero>
<one>Number1</one>
<two>Number2</two>
<three>Number3</three>
<four>Number4</four>
<five>Number5</five>
<six>Number6</six>
<seven>Number7</seven>
<eight>Number8</eight>
<nine>Number9</nine>
<escape>Stop</escape>
</keyboard>
</FullscreenVideo>
<VideoMenu>
<keyboard>
<zero>Number0</zero>
<one>Number1</one>
<two>Number2</two>
<three>Number3</three>
<four>Number4</four>
<five>Number5</five>
<six>Number6</six>
<seven>Number7</seven>
<eight>Number8</eight>
<nine>Number9</nine>
</keyboard>
</VideoMenu>
<NumericInput>
<keyboard>
<zero>Number0</zero>
<one>Number1</one>
<two>Number2</two>
<three>Number3</three>
<four>Number4</four>
<five>Number5</five>
<six>Number6</six>
<seven>Number7</seven>
<eight>Number8</eight>
<nine>Number9</nine>
</keyboard>
</NumericInput>
<Teletext>
<keyboard>
<zero>number0</zero>
<one>number1</one>
<two>number2</two>
<three>number3</three>
<four>number4</four>
<five>number5</five>
<six>number6</six>
<seven>number7</seven>
<eight>number8</eight>
<nine>number9</nine>
</keyboard>
</Teletext>
</keymap>
</syntaxhighlight>

| Step3 = Save this file in [[userdata]]/Keymaps/:
{{hidden|1=[[userdata folder]] location:|2={{#lst:userdata|location all}} }}
Note: if you use the Keymap Editor addon for Kodi, you need to append these new XML lines above inside the XML file generated by this addon, '''not''' in keyboard.xml. In March of 2015, the file generated by Keymap Editor is called "gen.xml".

| Step4 = If Kodi is already running then restart it so that the changes take effect.

| Step5 = {{note|This step is not required for Kodi v14 and higher.}}

Go into Kodi and then {{highlight|bordered=yes|[[Settings/System#Input devices|Settings -> System -> Input devices]]}} and enable '''Remote control sends keyboard presses'''. This will allow your arrow keys to use the on-screen keyboard even though Kodi thinks your remote is a keyboard already.
}}

== Filter instead of jump ==
You can also use FilterSMS instead of JumpSMS in the above keymap. This will filter out titles that don't match the letters being entered.

For example, typing "STAR" will filter out anything that doesn't start with those letters, leaving behind entries like "Star Wars", "Star Trek", "Stargate", etc.

== Note for Imon remotes users ==
* Some Imon remotes, such as the Pad, and perhaps other remotes, have numeric buttons that do not send keys like “one”, “two”, etc. Neither they do output key-codes from the numeric pad of a keyboard. What they do is send key-codes from the keys Under the function keys (F1, F2, etc), meaning: 1,2,3, etc. The problem on some system is : they send the keyboard’s lowercase (unshifted) characters for the 1,2,3, etc, keys. For example, if you have a French AZERTY keyboard, the remote's numeric keys will be understood by Kodi as "&é”‘(-è_çà)". As a result, the XML lines above need to be changed.<br />

* Using the Keymap Editor addon, it should be possible to press the remote buttons and have the button's output registered. But in some cases it is not possible or not handy, so it is sometimes better to use some real keyboard key codes. In the following method, we do not count on the remote's IR emitted key codes, but on regular keyboard keystrokes.<br />

* Use the Keymap Editor addon to note which key-code Kodi gets when typing the keys from the second row of the keyboard. Go to Keymap Editor > edit > global > virtual keyboard > and for each number, type the corresponding numeric key on the keyboard (not the numpad).<br />

* Open the gen.xml file, generated by the Keymap Editor addon. Following the instructions above, it should include the XML lines above for the T9 ability. Edit the lines like <zero>Number0</zero> and replace them by the codes you got from the Keymap Editor addon. For example : <key id=”61488″>Number0</key>.<br />

* More info on this : http://www.dreamcraftdigital.com/kodiandimon/ , http://forum.kodi.tv/showthread.php?tid=218401 , http://www.soundgraph.com/forums/showthread.php?t=27737

{{Isengard updated}}

[[Category:Remotes]]
[[Category:How-to]]
[[Category:Custom keymaps]]

Fade label control

2018-07-10T12:34:23Z

Kibje: /* Example */ syntaxhighlight fix

<section begin="main content" />
The fade label control is used for displaying multiple pieces of text in the same space in Kodi. You can choose the font, size, colour, location and contents of the text to be displayed. The first piece of information to display fades in over 50 frames, then scrolls off to the left. Once it is finished scrolling off screen, the second piece of information fades in and the process repeats. A fade label control is not supported in a list container.
=== Example ===
<syntaxhighlight lang=xml enclose="div">
<control type="fadelabel" id="1">
<description>My First fadelabel</description>
<left>80</left>
<top>60</top>
<width>250</width>
<visible>true</visible>
<scrollout>true</scrollout>
<pauseatend>200</pauseatend>
<label>6</label>
<info>MusicPlayer.Genre</info>
<info>MusicPlayer.Artist</info>
<info>MusicPlayer.Album</info>
<info>MusicPlayer.Year</info>
<font>font14</font>
<textcolor>FFB2D4F5</textcolor>
<textoffsetx>20</textoffsetx>
<scroll>true</scroll>
<randomize>true</randomize>
</control>
</syntaxhighlight>

=== Tag descriptions ===
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="prettytable"
! Tags !! Description
|-
| '''label'''
|
Specifies the text which should be drawn. You should specify an entry from the strings.xml here, however you may also specify a piece of text yourself if you wish, though ofcourse it will not be localisable. [[Label Parsing|You may also specify more than one piece of information here by using the $INFO and $LOCALIZE formats.]]
|-
| '''info'''
|
Specifies the information that should be presented. Kodi will <span class="nobr">auto-fill</span> in this info in place of the <label>. [[InfoLabels|See here for more information.]]
|-
| '''font'''
| Specifies the font to use from the font.xml file.
|-
| '''textcolor'''
| Specified the color the text should be, in hex AARRGGBB format, or a name from the [[Colour Themes|colour theme.]]
|-
| '''textoffsetx'''
| Specify the offset from the left edge that the text should be rendered at when static (not scrolling). The scrolling text will still scroll using the full <width> of the control.
|-
| '''shadowcolor'''
| Specifies the color of the drop shadow on the text, in AARRGGBB format, or a name from the [[Colour Themes|colour theme.]]
|-
| '''angle'''
| Specifies the angle at which the text should be drawn, measured counter clockwise from the horizontal.
|-
| '''scrollout'''
| If set to False the fadelabel will only scroll until the last char is to the right side of the width of the fadelabel instead of all the way out to the left. Defaults to true
|-
| '''pauseatend'''
| Specifies the time that the text will wait until it fades away before it scrolls again or moves to the next item.
|-
| '''resetonlabelchange'''
| If set to false the fadelabel will not reset the scrolling offset when the label's content changes. Useful if you have things such as the play time (in seconds) inside a fadelabel. Defaults to true.
|-
| '''scrollspeed'''
| Scroll speed of text in pixels per second. Defaults to 60.
|-
| '''scroll'''
| If set to false, the labels won't scroll. Defaults to true.
|-
| '''randomize'''
| If set to true, the labels will be displayed in a random order. Defaults to false.
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Fade label control

2018-07-10T12:34:06Z

Kibje: syntaxhighlighter fix

<section begin="main content" />
The fade label control is used for displaying multiple pieces of text in the same space in Kodi. You can choose the font, size, colour, location and contents of the text to be displayed. The first piece of information to display fades in over 50 frames, then scrolls off to the left. Once it is finished scrolling off screen, the second piece of information fades in and the process repeats. A fade label control is not supported in a list container.
=== Example ===
<syntaxhighlighter lang=xml enclose="div">
<control type="fadelabel" id="1">
<description>My First fadelabel</description>
<left>80</left>
<top>60</top>
<width>250</width>
<visible>true</visible>
<scrollout>true</scrollout>
<pauseatend>200</pauseatend>
<label>6</label>
<info>MusicPlayer.Genre</info>
<info>MusicPlayer.Artist</info>
<info>MusicPlayer.Album</info>
<info>MusicPlayer.Year</info>
<font>font14</font>
<textcolor>FFB2D4F5</textcolor>
<textoffsetx>20</textoffsetx>
<scroll>true</scroll>
<randomize>true</randomize>
</control>
</syntaxhighlighter>

=== Tag descriptions ===
In addition to the [[Default Control Tags]] the following tags are available. Note that each tag is '''lower case''' only. This is important, as xml tags are case-sensitive.
{| class="prettytable"
! Tags !! Description
|-
| '''label'''
|
Specifies the text which should be drawn. You should specify an entry from the strings.xml here, however you may also specify a piece of text yourself if you wish, though ofcourse it will not be localisable. [[Label Parsing|You may also specify more than one piece of information here by using the $INFO and $LOCALIZE formats.]]
|-
| '''info'''
|
Specifies the information that should be presented. Kodi will <span class="nobr">auto-fill</span> in this info in place of the <label>. [[InfoLabels|See here for more information.]]
|-
| '''font'''
| Specifies the font to use from the font.xml file.
|-
| '''textcolor'''
| Specified the color the text should be, in hex AARRGGBB format, or a name from the [[Colour Themes|colour theme.]]
|-
| '''textoffsetx'''
| Specify the offset from the left edge that the text should be rendered at when static (not scrolling). The scrolling text will still scroll using the full <width> of the control.
|-
| '''shadowcolor'''
| Specifies the color of the drop shadow on the text, in AARRGGBB format, or a name from the [[Colour Themes|colour theme.]]
|-
| '''angle'''
| Specifies the angle at which the text should be drawn, measured counter clockwise from the horizontal.
|-
| '''scrollout'''
| If set to False the fadelabel will only scroll until the last char is to the right side of the width of the fadelabel instead of all the way out to the left. Defaults to true
|-
| '''pauseatend'''
| Specifies the time that the text will wait until it fades away before it scrolls again or moves to the next item.
|-
| '''resetonlabelchange'''
| If set to false the fadelabel will not reset the scrolling offset when the label's content changes. Useful if you have things such as the play time (in seconds) inside a fadelabel. Defaults to true.
|-
| '''scrollspeed'''
| Scroll speed of text in pixels per second. Defaults to 60.
|-
| '''scroll'''
| If set to false, the labels won't scroll. Defaults to true.
|-
| '''randomize'''
| If set to true, the labels will be displayed in a random order. Defaults to false.
|}

<section end="main content" />

== See also ==
'''Development:'''
* [[Add-on development]]
* [[Skinning]]

[[Category:Skin development]]

Favourites.xml

2018-07-10T12:33:37Z

Kibje: syntaxhighlighter fix

{{mininav| [[Userdata]] {{l2| [[Favourites]] }} }}

<section begin="intro" />Developer documentation detailing the structure and modification of the favourites.xml file. For the User Guide about the favourites feature see '''''[[Favourites]]'''''.<section end="intro" />

== Favourites via xml==
The '''display order''' seen in the Favourites screen is determined by the order of the entries in the xml file. Adjust the order of the favourites in the file to modify the displayed order in {{kodi}}.

The '''''favourites.xml''''' is located in the '''''[[Userdata]]''''' folder.

'''Example: '''
The format of the favourites.xml is as follows. The example shows Playlist, TV Show, TV Episode, Artist, Album and Add-on.
<syntaxhighlight lang=xml enclose="div">
<favourites>
<favourite name="Marvel Universe">ActivateWindow(10025,"special://profile/playlists/video/Marvel Universe.xsp",return)</favourite>
<favourite name="Continuum" thumb="E:\TV Show- TEST\Continuum\thumb.jpg">ActivateWindow(10025,"E:\\TV Show- TEST\\Continuum\\",return)</favourite>
<favourite name="1x02. Fast Times" thumb="E:\TV Show- TEST\Continuum\Continuum S01E02-thumb.jpg">PlayMedia("E:\\TV Show- TEST\\Continuum\\Continuum S01E02.mkv")</favourite>
<favourite name="Era" thumb="F:\Music\ArtistInfoKodi\Era\folder.jpg">ActivateWindow(10502,"musicdb://artists/113/?albumartistsonly=false",return)</favourite>
<favourite name="NextPVR PVR Client" thumb="F:\Kodi v18- Nightly\addons\pvr.nextpvr\icon.png">RunAddon(pvr.nextpvr)</favourite>
<favourite name="TV Show- TEST">ActivateWindow(10025,"E:\\TV Show- TEST\\",return)</favourite>
<favourite name="Artist Albums">ActivateWindow(10502,"F:\\Music\\FLAC\\Artist Albums\\",return)</favourite>
</favourites>
</syntaxhighlight >

==Renaming a favourite via xml==
Change the name of any item by amending the ''<fabourite name="">'' section.

<syntaxhighlight lang=xml enclose="div">
<favourites>
<favourite name="Enter Desired name here" thumb="http://static.ddmcdn.com/gif/videos/120x90/52447.jpg">PlayMedia("plugin://plugin.video.howstuffworks_com/?url=52447&mode=playVideo")</favourite>
</favourites>
</syntaxhighlight >

{{Top}}

{{updated|18}}
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Development]]
[[Category:General topics]]

HOW-TO:Use SMS-style text entry for remotes

2018-07-10T12:31:34Z

Kibje: syntaxhighlighter fix

{{mininav|[[Remote controls]]}}
<section begin="intro" />If you have a remote control that is viewed as a keyboard to Kodi and want to enable SMS-style text input and page jumping, this guide wills how you how to enable this using a custom '''[[keymap]]'''. If you have a normal "[[MCE]]" style remote or non-Android [[CEC]] device, then this how-to may not necessary.<section end="intro" />

== Steps ==
{{how-to
| Step1 = Create a '''plain text file''' (no rich text formatting, don't use .doc, etc) and save it as '''keyboard.xml'''. Make sure that the file extension is ".xml" and '''not''' ".txt" or ".xml.txt".

| Step2 = Cut and paste this into your new plain text file:
<syntaxhighlighter lang=xml enclose="div">
<?xml version="1.0" encoding="UTF-8"?>
<keymap>
<global>
<keyboard>
<zero>Number0</zero>
<one>JumpSMS1</one>
<two>JumpSMS2</two>
<three>JumpSMS3</three>
<four>JumpSMS4</four>
<five>JumpSMS5</five>
<six>JumpSMS6</six>
<seven>JumpSMS7</seven>
<eight>JumpSMS8</eight>
<nine>JumpSMS9</nine>
<escape>Back</escape>
</keyboard>
</global>
<VirtualKeyboard>
<keyboard>
<zero>Number0</zero>
<one>Number1</one>
<two>Number2</two>
<three>Number3</three>
<four>Number4</four>
<five>Number5</five>
<six>Number6</six>
<seven>Number7</seven>
<eight>Number8</eight>
<nine>Number9</nine>
<backspace>Backspace</backspace>
</keyboard>
</VirtualKeyboard>
<FullscreenVideo>
<keyboard>
<zero>Number0</zero>
<one>Number1</one>
<two>Number2</two>
<three>Number3</three>
<four>Number4</four>
<five>Number5</five>
<six>Number6</six>
<seven>Number7</seven>
<eight>Number8</eight>
<nine>Number9</nine>
<escape>Stop</escape>
</keyboard>
</FullscreenVideo>
<VideoMenu>
<keyboard>
<zero>Number0</zero>
<one>Number1</one>
<two>Number2</two>
<three>Number3</three>
<four>Number4</four>
<five>Number5</five>
<six>Number6</six>
<seven>Number7</seven>
<eight>Number8</eight>
<nine>Number9</nine>
</keyboard>
</VideoMenu>
<NumericInput>
<keyboard>
<zero>Number0</zero>
<one>Number1</one>
<two>Number2</two>
<three>Number3</three>
<four>Number4</four>
<five>Number5</five>
<six>Number6</six>
<seven>Number7</seven>
<eight>Number8</eight>
<nine>Number9</nine>
</keyboard>
</NumericInput>
<Teletext>
<keyboard>
<zero>number0</zero>
<one>number1</one>
<two>number2</two>
<three>number3</three>
<four>number4</four>
<five>number5</five>
<six>number6</six>
<seven>number7</seven>
<eight>number8</eight>
<nine>number9</nine>
</keyboard>
</Teletext>
</keymap>
</syntaxhighlighter>

| Step3 = Save this file in [[userdata]]/Keymaps/:
{{hidden|1=[[userdata folder]] location:|2={{#lst:userdata|location all}} }}
Note: if you use the Keymap Editor addon for Kodi, you need to append these new XML lines above inside the XML file generated by this addon, '''not''' in keyboard.xml. In March of 2015, the file generated by Keymap Editor is called "gen.xml".

| Step4 = If Kodi is already running then restart it so that the changes take effect.

| Step5 = {{note|This step is not required for Kodi v14 and higher.}}

Go into Kodi and then {{highlight|bordered=yes|[[Settings/System#Input devices|Settings -> System -> Input devices]]}} and enable '''Remote control sends keyboard presses'''. This will allow your arrow keys to use the on-screen keyboard even though Kodi thinks your remote is a keyboard already.
}}

== Filter instead of jump ==
You can also use FilterSMS instead of JumpSMS in the above keymap. This will filter out titles that don't match the letters being entered.

For example, typing "STAR" will filter out anything that doesn't start with those letters, leaving behind entries like "Star Wars", "Star Trek", "Stargate", etc.

== Note for Imon remotes users ==
* Some Imon remotes, such as the Pad, and perhaps other remotes, have numeric buttons that do not send keys like “one”, “two”, etc. Neither they do output key-codes from the numeric pad of a keyboard. What they do is send key-codes from the keys Under the function keys (F1, F2, etc), meaning: 1,2,3, etc. The problem on some system is : they send the keyboard’s lowercase (unshifted) characters for the 1,2,3, etc, keys. For example, if you have a French AZERTY keyboard, the remote's numeric keys will be understood by Kodi as "&é”‘(-è_çà)". As a result, the XML lines above need to be changed.<br />

* Using the Keymap Editor addon, it should be possible to press the remote buttons and have the button's output registered. But in some cases it is not possible or not handy, so it is sometimes better to use some real keyboard key codes. In the following method, we do not count on the remote's IR emitted key codes, but on regular keyboard keystrokes.<br />

* Use the Keymap Editor addon to note which key-code Kodi gets when typing the keys from the second row of the keyboard. Go to Keymap Editor > edit > global > virtual keyboard > and for each number, type the corresponding numeric key on the keyboard (not the numpad).<br />

* Open the gen.xml file, generated by the Keymap Editor addon. Following the instructions above, it should include the XML lines above for the T9 ability. Edit the lines like <zero>Number0</zero> and replace them by the codes you got from the Keymap Editor addon. For example : <key id=”61488″>Number0</key>.<br />

* More info on this : http://www.dreamcraftdigital.com/kodiandimon/ , http://forum.kodi.tv/showthread.php?tid=218401 , http://www.soundgraph.com/forums/showthread.php?t=27737

{{Isengard updated}}

[[Category:Remotes]]
[[Category:How-to]]
[[Category:Custom keymaps]]

Archive:Use any IR remote with OpenELEC

2018-07-10T12:30:52Z

Kibje: syntaxhighlighter fixes

{{forum link2|1=Have questions about this guide or want to comment on it? Go here: http://forum.kodi.tv/showthread.php?pid=1656784}}
<section begin="intro" />How to get your infrared [[LIRC]] remote working in [[Archive:OpenELEC]]. This guide will show you how to modify OpenELEC so that it works with almost any LIRC remote. The four files are lircd.conf Lircmap.xml remote.xml and autostart.sh

This is really simple and can be accomplished in 15-20 min.<section end="intro" />

You can likely use any remote.xml you can find. The one in the default root location (/usr/share/xbmc/system/keymaps) should be fine. Copy it and put it in the /storage/.xbmc/userdata/keymaps location as we might be tweaking it.

== Guide ==
{{how-to
| Step1 = We must first change the protocol if you are going to use irrecord on the OpenELEC machine.

<syntaxhighlighterlang=bash>ir-keytable -p lirc</syntaxhighlighter>

| Step2 = First thing is grab the IR remote of your choice and follow the previous tutorial [http://forum.kodi.tv/showthread.php?tid=170372 "Use Any IR Remote In The House"], but '''skip the remote.xml part.'''

| Step3 = Start at step 13 and don't use sudo. Also, use the terminal editor nano or do all of it on some other linux based machine. You will have to adjust a few things as OpenELEC is different.

| Step4 = This will get you the first 2 files and consumes most of the 15 mins.

:lircd.conf
:Lircmap.xml (see below for template)

| Step5 =
Make sure the name of your remote matches in Lircmap.xml and lircd.conf

Here are the valid Lircmap.xml names. Don't try to make up your own. Don't go too crazy. Stick to the common names and it will mean less editing. Copy this entire thing to your Lircmap.xml (change your remote name) and only fill in the ones you need.

<syntaxhighlighterlang=xml><lircmap>

<remote device="MY-Remote-Name">

<left></left>
<right></right>
<up></up>
<down></down>
<select></select>
<back></back>

<play></play>
<pause></pause>
<stop></stop>

<volumeplus></volumeplus>
<volumeminus></volumeminus>
<mute></mute>

<pageplus></pageplus>
<pageminus></pageminus>

<power></power>
<menu></menu>
<info></info>
<display></display>
<title></title>

<red></red>
<green></green>
<yellow></yellow>
<blue></blue>

<zero></zero>
<one></one>
<two></two>
<three></three>
<four></four>
<five></five>
<six></six>
<seven></seven>
<eight></eight>
<nine></nine>

<skipplus></skipplus>
<skipminus></skipminus>

<reverse></reverse>
<forward></forward>

<subtitle></subtitle>
<language></language>

<channelplus></channelplus>
<channelminus></channelminus>

<mytv></mytv>
<mymusic></mymusic>
<mypictures></mypictures>
<myvideo></myvideo>
<livetv></livetv>
<recordedtv></recordedtv>
<liveradio></liveradio>
<epgsearch></epgsearch>

<guide></guide>

<record></record>
<start></start>

<star></star>
<hash></hash>
<clear></clear>
<enter></enter>
<xbox></xbox>

<playlist></playlist>
<teletext></teletext>

</remote>

</lircmap>
</syntaxhighlighter>

| Step6 = Next create an autostart.sh file in /storage/.config (If you have one already just add the following to that file)

<syntaxhighlighterlang=bash>
#!/bin/sh

killall lircd
ir-keytable -p lirc
lircd --device=/dev/lirc0 /storage/.config/lircd.conf
</syntaxhighlighter>

You don't need the #!/bin/sh if you already have it in the file.

| Step7 = Make the file executable:
<syntaxhighlighterlang=bash>chmod +x /storage/.config/autostart.sh</syntaxhighlighter>

| Step8 = Place lircd.conf in /storage/.config/

Place Lircmap.xml in /storage/.xbmc/userdata/

and place remote.xml in /storage/.xbmc/userdata/keymaps/

| Step9 = That's it! Piece of cake. Reboot

| Step10 = If for any reason you want to go back to the way it was, simply delete those files.
}}

== Notes ==
* Credit goes to FishOil for the original guide: http://forum.kodi.tv/showthread.php?pid=1656784

* You also may want to have a look at [http://forum.kodi.tv/showthread.php?tid=189617 Understanding LIRC & XBMC]

* If it doesn't work the first step is to find out if LIRC is configured correctly
:# SSH into the box and type irw
:# Push some buttons on the remote.
:# Your custom remote name should be displayed along with the button name.

[[Category:How-to]]
[[Category:Remotes]]

Archive:Kodibuntu FAQ

2018-07-10T12:29:06Z

Kibje: syntaxhighlighter fix

{{outdated}}

'''F'''requently '''A'''sked '''Q'''uestions for KodiBuntu (formally known as XBMCbuntu).

__TOC__
{{-}}

== General FAQ ==
:<big>''See also: '''[[All platforms FAQ]]''' for FAQs that apply to all versions of Kodi.''</big>
:<big>''See also: '''[[Linux FAQ]]''' for general Kodi on Linux questions.''</big>

{| width="100%"
{{FAQ|1=Kodi|2=What_is_it
| BGcolor=WhiteSmoke
| Question=What is Kodibuntu?
| Answer=
{{#lst:Kodibuntu|intro}}
}}

{{FAQ|1=what_version
| BGcolor=
| Question=What version of Lubuntu is used by the current Kodibuntu?
| Answer=
: For v13 and v14, Kodibuntu is based on Lubuntu 14.04LTS (Trusty Tahr)
}}

{{FAQ|1=Minimum_requirements
| BGcolor=WhiteSmoke
| Question=What are Kodibuntu's minimum and recommended requirements?
| Answer=
{{collapse top}}
{{#lst:Supported hardware|Linux}}
{{collapse bottom}}
}}

{{FAQ|1=upgrading
| BGcolor=
| Question=Upgrading Kodi
| Answer=
{{main|HOW-TO:Install Kodi for Linux#Upgrading}}
{{#lst:HOW-TO:Install Kodi for Linux|Ubuntu upgrade}}
}}

|}

== Drivers ==
{| width="100%"
{{FAQ|1=upgrade_drivers
| BGcolor=whitesmoke
| Question=How can I Upgrade NVidia drivers in Ubuntu/Kodibuntu and variants?
| Answer=
<section begin="Upgrade_nvidia_driver />
Nvidia as well as drivers suppliers for Ubuntu and variants, recommended user to install these packages via repositories provided!
The maintainers ensure the drivers are correct and compatible to the distro being targeted.

<syntaxhighlighter lang=bash enclose="div">
sudo apt-get install python-software-properties pkg-config
sudo add-apt-repository ppa:ubuntu-x-swat/x-updates
sudo apt-get update
sudo apt-get install nvidia-current nvidia-settings
</syntaxhighlighter><br />

Alternatively, there is now a repository for Nvidia graphics drivers containing upto the latest proprietary GPU drivers. You can specify the driver version that you want to install.

<syntaxhighlighter lang=bash enclose="div">
sudo apt-get install python-software-properties pkg-config
sudo add-apt-repository ppa:graphics-drivers/ppa
sudo apt-get update
sudo apt-get install nvidia-XXX nvidia-settings libvdpau1
(XXX being the selected driver version, e.g. 355)
</syntaxhighlighter><br />
A list of available driver versions can be found at [http://launchpad.net/~graphics-drivers/+archive/ubuntu/ppa launchpad.net/~graphics-drivers/+archive/ubuntu/ppa] .

{{forum link2|[[forum:142220|Nvidia Drivers updates Kodibuntu]] (Ubuntu and variants forum discussion thread)}}<br />
}}<section end="Upgrade_nvidia_driver" />
|}

== Handling files & Backups ==

{| width="100%"
{{FAQ|1=transferring_files
| BGcolor=#ffffff
| Question=How can I transfer files to/from Kodibuntu?
| Answer=
Use SFTP with a client such as Cyberduck or FileZilla or scp via SSH within Linux/OS X shell. '''username and password''' is '''xbmc''', '''kodi''', blank or the Kodi password selected during install.

:''See also:'' [[SFTP|Connecting to Kodibuntu via SFTP]]
:''See also:'' [[SSH|Connecting to Kodibuntu via SSH]]
}}
|}

{| width="100%"
{{FAQ|1=Backup
| BGcolor=whitesmoke
| Question=How can I backup all my settings to restore them if something goes wrong?
| Answer=
{{see also|Backup}}
You can use the [[Add-on:Backup]] Backup and restore your Kodi database and configuration files in the event of a crash or file corruption.

Alternatively if you do not wish to use a addon, you can navigate to your [[userdata]] folder and copy/archive all its contents to a external drive. This can be achieved various ways, depending on your OS.
}}
|}

== Connectivity ==
{| width="100%"
{{FAQ|1=connectivity
| BGcolor=
| Question=How can I connect a bluetooth keyboard/mouse/remote??
| Answer=
A good way to decipher this is to:
:See this video:http://lubuntu.net/blog/lubuntu-screencast-bluetooth
}}
|}

== Troubleshooting ==

{| width="100%"
{{FAQ|1=audio_issues
| BGcolor=whitesmoke
| Question=What if I have audio issues with Kodibuntu?
| Answer=
You can look at the audio troubleshooting page below, if your problems persist, you can always try to search for answers to your problem in forums and if none are found open your own thread.
Remember to have '''[[Debug log]]''' handy in pastebin, in such cases.
:<big>'''''See: [[Audio Troubleshooting]]</big>
}}

{{FAQ|1=window_too_big
| BGcolor=
| Question=Can't install, because the install window is too big?
| Answer=
In the event you come across this issue, you can look at adapting the solutions proposed in the forum post below.
:See [[forum:126453|Can't install because the install window is too big?]]
}}

{{FAQ|1=text_too_small
| BGcolor=whitesmoke
| Question=Can't install because the text is too small?
| Answer=
In the event you come across this issue, you can look at adapting the solutions proposed in the forum post below.
:See [[forum:126453|Can't install because the text is too small?]]
}}
|}
{{#lst:Linux FAQ|problem_req_info}}

== Upgrading Ubuntu / Kodibuntu ==
<section begin="upgradeOS" />
{| width="100%"
{{FAQ|1=Upgrading_OS_base
| BGcolor=
| Question=How do I upgrade the Kodibuntu base OS?
| Answer=
To actually upgrade the underlying Linux which "Kodibuntu" is based on, it is possible to do so via release upgrade.

There are advantages and disadvantages to doing so. It's not a method recommended lightly to inexperienced users, doing so means you understand and accept responsibility for breaking your system.

{{redv|'''BACKUP!'''| Never attempt any upgrades without having proper backups of the files you consider important or value or have a full system image/backup of working system you can restore.}}
{{greenv|'''RECOMMENDED!'''|It is possible (in order to preserve systems tweaks) to just upgrade Kodi itself by treating it as a normal Linux package and update/install via: [[Team KODI PPA|Upgrading Kodi via ppa in Kodibuntu]]}}

<syntaxhighlighter lang=bash enclose="div">
sudo apt-get update
sudo apt-get install update-manager-core
sudo do-release-upgrade
</syntaxhighlighter><br />
This should upgrade your Base distribution, however if your current version is too old it may require repeating these steps until you reach the desired version.
'''
Do note''' that this is not recommended to inexperienced Linux users in case of breakages that you wont be able to resolve.
}}
|}
<section end="upgradeOS" />

[[Category:Kodibuntu]]

Keymap

2018-07-10T12:27:18Z

Kibje: syntaxhighligher fix

{{mininav| [[Remote controls]] }}
<section begin="intro" />Keymaps are XML base files that define the mappings of keys (keyboard keys, mouse/remote/joysticks buttons and more) to Kodi actions.<section end="intro" />

== Customizing keymaps through the GUI ==
{{main|Add-on:Keymap Editor}}
Users can customize keymaps for remotes in GUI by using the community [[Add-on:Keymap Editor|Keymap Editor]] add-on.

== Location of keymaps ==
User modified keymap files must be stored in the "'''keymaps'''" folder in the [[userdata]] folder:
{{#lsth:userdata|Location of the UserData folder}}

=== Defaults ===
Default keymaps are included when Kodi is installed, but users should not edit those install files directly. Instead, place user modified keymaps in the [[userdata]]/keymaps/ directory.

Kodi can process multiple keymap files and does so like this:

* All *.xml files from the default install settings and userdata/kemaps/ folders are applied as keymaps.
* All *.xml files are processed in alphabetical order.
* Keymaps defined in an .xml file add to or override mappings in previous .xml file.
* Keymaps defined in the userdata folder add to or override mappings in the global keymap.

By default there will be no files in these locations, so grab one from the link below to make a new one/over-ride:

* ''' https://github.com/xbmc/xbmc/tree/master/system/keymaps '''
* ''' https://github.com/kodi-game/peripheral.joystick/tree/master/peripheral.joystick/resources/buttonmaps/xml '''

== Structure ==

There is one '''global''' keymap and several '''window'''-specific keymaps.<br />
Kodi falls back to the global map when the window-specific map hasn't bound the key being pressed.

The format of keymapping files is as follows:

<syntaxhighlight lang=xml enclose="div">
<keymap>
<global>
<gamepad>
<A>Select</A>
[...]
</gamepad>

<remote>
<select>Select</select>
[...]
</remote>

<keyboard>
<enter>Select</enter>
[...]
</keyboard>

<mouse>
<leftclick>Select</leftclick>
[...]
</mouse>

<universalremote>
<obc25>XBMC.ActivateWindow(MyMusic)</obc25>
[...]
</universalremote>

<joystick name="PLAYSTATION(R)3 Controller (00:1B:FB:F6:E0:F2)">
<button id="15">Select</button>
[...]
</joystick>
</global>

<Home>
[...]
</Home>

[...]

</keymap>
</syntaxhighlight>

As you can see, it's divided into a <global> section, and a number of window sections (such as <Home>).<br />
A list of the available window names can be seen [[Window IDs|here]]. The WINDOW can also be a custom window formatted as <windowId#> (e. g. <window1113>). <br />
Each of these sections can contain Gamepad, Remote, Keyboard, Universal Remote, and custom Joystick sections.

The format for mapping a particular key under one of these device types is as follows:
<syntaxhighlight lang=xml enclose="div">
<keyname>action</keyname>
</syntaxhighlight>

== Keynames ==
Depending on your device you will need to use a specific "keyname".
=== Gamepads ===
An up to date list of the available actions can be found in the source code of Kodi in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp ButtonTranslator.cpp] where the ''TranslateGamepadString()'' function does the work.

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<gamepad>
<A>Select</A>
</gamepad>
</syntaxhighlight>

=== Remotes ===
An up to date list of the available actions can be found in the source code of Kodi in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp ButtonTranslator.cpp] where the ''TranslateRemoteString()'' (NOTE: not existing anymore) function does the work.

{{Note|Some remotes (e.g. FLIRC) are actually seen as "keyboards". Those will need to use the <keyboard> tag instead.}}

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<remote>
<play>Play</play>
</remote>
</syntaxhighlight>

=== Universal Remotes ===
To map Universal Remote buttons using the RCA infrared protocol, you may add '''<universalremote>''' sections to keymap.xml.<br />
In this case, the tags used are <obc#> where # is the original button code (OBC) of the button.<br />
You would put it inside a <universalremote> section in the <window> or <global> sections.

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<universalremote>
<obc148>Stop</obc148>
</universalremote>
</syntaxhighlight>

:Will map ''Stop Playback'' to the RCA DVD repeat button <obc148>, which is not used by Kodi by default.

* '''Note:''' ensure that the <universalremote> section is '''NOT''' added 'within' the <remote> section - it can appear before or after. Otherwise it will not be recognised and produces errors in the logfile.

Remote keys can be observed in the kodi.log file ('''~/.kodi/temp/kodi.log''' on Linux) when debugging is enabled in the GUI (Settings -> debugging ). The list of pre-defined OBC codes can be found at [https://github.com/xbmc/xbmc/blob/master/xbmc/input/XBIRRemote.h XBIRRemote.h].

=== Keyboards ===
Valid keyboard keymap syntax includes <keyname>, <key id="">, and <keyname mod="">.

Mapping for arbitrary key codes can be configured using the following syntax:
<syntaxhighlight lang=xml enclose="div">
<key id="123">
</syntaxhighlight>
where "123" is replaced by the key code.

A full list of valid keynames can be found in
* the ''TranslateKeyboardString()'' method in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp ButtonTranslator.cpp]
* or in [[List of Kodi keynames]].<br />

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<keyboard>
<key id="123">action</key> -- id is the keys keycode. >
<a mod="shift,alt">action</a> -- corresponds to shift-alt-a, the mod="" syntax is enabled since build 26407. >
<space>action</space> -- for a complete list of valid keynames, see ButtonTranslator.cpp or List of Kodi keynames above. >
</keyboard>
</syntaxhighlight>

;Modifiers
* shift
* alt
* ctrl

=== Mouse ===

As this highly depends on the mouse you are using and which kind of buttons are available, we only mention the most common buttons on a mouse:
<syntaxhighlight lang=xml enclose="div">
<keymap>
<mouse>
<global>
<leftclick>...</leftclick>
<middleclick>...</middleclick>
<rightclick>...</rightclick>
<wheelup>...</wheelup>
<wheeldown>...</wheeldown>
</global>
</mouse>
</keymap>
</syntaxhighlight>

'''''Example for changing the volume while on MusicOSD window using the mouse wheel'''''

<syntaxhighlight lang=xml enclose="div">
<keymap>
<MusicOSD>
<mouse>
<wheeldown>VolumeDown</wheeldown>
<wheelup>VolumeUp</wheelup>
</mouse>
</MusicOSD>
</keymap>
</syntaxhighlight>

=== Custom Joystick Configuration ===
Custom joysticks are defined using the following syntax:
<syntaxhighlight lang=xml enclose="div">
<joystick name="JOYSTICK NAME">
<button id="BUTTON ID">action</button>
</joystick>
</syntaxhighlight>

Getting the joystick name:
* On linux: 'cat /proc/bus/input/devices'
* or see your Kodi log file

Getting the button ids:
* 'id' is the button ID used by SDL. Joystick button ids of connected joysticks appear in kodi.log when they are pressed. Use your log to map custom buttons to actions.

'''Example:'''
<syntaxhighlight lang=xml enclose="div">
<joystick name="PLAYSTATION(R)3 Controller (00:1B:FB:F6:E0:F2)">
<button id="15">Select</button>
<button id="14">PreviousMenu</button>
</joystick>
</syntaxhighlight>

== Long-press ==
{{note| Longpress seems to only be working on keyboard keymaps at the moment }}
Depending on the device, many remotes, keyboards, and gamepads can use the long-press modifier. This allows a button to do a separate action when held for a short period of time. The syntax for this is as follows:

<pre><button mod="longpress">action</button></pre>

Not all devices will correctly work with the longpress action, but most should.

{{Note|Long-press will disable keyrepeat for that key/window.}}

=== Removing a long-press action from a default keymap ===
If you want to simply remove a long-press action, rather than override it, you can place an empty long-press tag in a keymap. This also has the effect of re-enabling keyrepeat for the short-press action.

For example, this will remove the context menu action from the default keyboard.xml keymap:

<pre>
<keymap>
<global>
<keyboard>
<return mod="longpress"></return>
<enter mod="longpress"></enter>
</keyboard>
</global>
</keymap>
</pre>

== Commands ==
The most recent available actions can be found in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/ActionTranslator.cpp ActionTranslator.cpp].

For those debugging integer action codes from the debug log, the mapping of action codes to constants is in [https://github.com/xbmc/xbmc/blob/master/xbmc/input/Key.h Key.h]

In addition to the following actions, you can also use '''[[Built-in scripting]]''' in Kodi.

=== Actions ===
{{Main|Action IDs}}
{{#lst:Action IDs|Action IDs}}

=== Functions ===
{{main|List of built-in functions|Built-in scripting}}
{{#lst:List of built-in functions|functions}}

== Windows ==
{{main|Window IDs}}
{{#lst:Window IDs|main content}}

== Additional keys ==
Other keys that can be mapped to actions.

=== Media keyboards/remotes ===
* browser_back
* browser_forward
* browser_refresh
* browser_stop
* browser_search
* browser_favorites
* browser_home
* volume_mute
* volume_down
* volume_up
* next_track
* prev_track
* stop
* play_pause
* launch_mail
* launch_media_select
* launch_app1
* launch_app2
* play
* pause
* fastforward
* rewind
* channelup
* channeldown

=== Mouse actions ===
* leftclick
* rightclick
* middleclick
* doubleclick
* wheelup
* wheeldown
* mousemove
* mousedrag
* mousedragstart
* mousedragend
* mouserdrag - right button drag
* mouserdragstart - start of right button drag
* mouserdragend - end of right button drag

== Examples and pre-made keymaps ==
{{see|:Category:Custom keymaps}}

== See also ==
* [[Remote controls]]
* [[Keyboard controls]]
'''Development:'''
* [[Add-on development]]
* [[Python development]]
* [[Skinning]]

{{Updated|16}}

[[Category:Development]]
[[Category:Manual]]
[[Category:Remotes]]
[[Category:Settings]]
[[Category:Controls]]

Archive:Karaoke

2018-07-10T12:26:28Z

Kibje: syntaxhighlighter fix

{{Karaoke note}}

<section begin="intro" />This page provides information about karaoke playback in Kodi and provides advanced setup details.<section end="intro" />

== Features ==
Kodi supports the following Karaoke features:
* Supports CDG, LRCv1 and LRCv2 lyrics formats;
* Supports UltraStar song lyrics and video formats;
* Supports MIDI music and KAR files;
* Plays directly from MP3+CDG archived together;
* Supports song numbering with permanent numbers, which means the song could be selected by number, even if another song is being played. The numbering information could be exported into HTML file and used to print catalogs.
* Supports real-time lyrics timing modification, allowing to modify the lyrics-music delay. The delay is associated to the song, and then restored when this song is played again.
* Supports different background modes, including visualization, still picture or video.

== Missing features ==
What is not currently supported:
* Playing CD-G disks directly. The suggested workaround is to rip them into MP3+CDG files using available software.
* Using digitized microphone input. The microphone should work in pass-through mode, but will not work in digitized mode, where the sound should be digitally processed by Kodi. This also means that any voice post-processing is not possible yet.
* Pitch modification.

== What will not be implemented ==
* Playing vendor-specific Karaoke disks (like California Electronics or LG). Those disks need to be converted to playable files set first.
* Automatic voice removal. This is not possible to do automatically without seriously degrading music quality.
* Scoring table, nicknames and other attributes of karaoke-based games.

== Supported formats ==
The following karaoke formats are supported by Kodi.

=== MP3+CDG ===
The karaoke song consist of two files: the music file (usually MP3 but could be any playable type), and a separate binary file with the same file name as the music file, but with .cdg extension. This is the most popular format in the NA/USA, with a lot of English language music in this format available both legally and illegally. The source of those files are usually original CD disks in CD-G formats designed for hardware karaoke players. Those disks got ripped by any of freely available CD rippers, repacked and shared via typical channels, or sold on multiple web sites around the world.

The main feature of this format is that the lyrics are stored in the binary format, in form of drawing instructions. This means the CDG file could contain text in any language, or even graphics, and will be properly rendered on any supported device no matter what fonts are installed. However those drawing instructions operate on a small 300x216 window, and therefore have to be upscaled. As a result, this format combines usually very good music quality with very poor graphics. Because of upscaling the lyrics visualization quality is the worst through all supported formats, especially on large screen TVs. Other problems of this format are inability for the ordinary user to fix the typos or synchronization issues in the song, and that software required to create .CDG files is not widely available. There are only two programs, and neither is cheap.

=== MP3+LRC ===
Same as with CDG, the karaoke song consist of two files: the music file (usually MP3 but could be any playable type), and a separate text file with the same file name as the music file, but with .lrc extension. This is the most popular format in the Asia, and the most widespread lyrics format in the Internet. The source of those files are either original karaoke CDs where text in CD-G format was replaced by text in LRC by the person who ripped it, or a home-made music often made from MIDI files. There is also a lot of legitimate lyrics web sites where the lyrics in LRC format are available for download, usually for free.

The main feature of this format is that the lyrics are stored in the text file, usually in UTF-8 encoding. This means nothing but text (i.e. no graphics), and that the rendering software (Kodi) must have all necessary fonts installed. However since the rendering device uses real scalable fonts to render the text, the lyrics visualization quality is very good, especially on large screens. Being a text file it could also contain meta information (artist and song name, overall song delay and so on), is easy to edit/fix, and easy to create. Under Linux such files could be [[HOW-TO: Create karaoke lyrics|created]] in five minutes using free software.

=== MP3+TXT (UltraStar) ===
Similar to CDG and LRC, the karaoke song consist of several files. Usually it's just two files - the music file (usually MP3 but could be any playable type), and a separate text file with the same file name as the music file, but with .txt extension. This is relatively new and a very popular format due to its usage in UltraStar game and its numerous clones. This format also supports pitch, which is now ignored but in future may be used to track the individual performance. Also the song archive often includes video and pictures. At this moment the pictures are ignored, however the video will be played at background if available.

There are several song packages available in Internet. For starters, the Performous web site, http://performous.org/, contains a few songs with a liberal license. A bunch of websites over Internet are also providing Ultrastar lyrics (only text, they do not provide music).

You can create your own MP3 and TXT files from Karaoke MIDI files or ABC files. Since the timing of lyrics is already in the Karaoke MIDI file, it's easier to programatically convert this information to the TXT format rather than trying to create lyrics files by hand. See the tips under the Karaoke MIDI section for creating Karaoke MIDI files from ABC files. To convert a Karaoke MIDI file to MP3, you can use Timidity itself. Timidity can take a MIDI file and convert it to WAV or other formats. If your version of Timidity doesn't support MP3, you can convert to WAV and then use a program like Audacity or Sox to convert to MP3. Many UltraStar files are also availabe in [http://www.vorbis.com/ Ogg Vorbis] (rather than MP3). Again, you can use tools like Audacity or Sox to convert audio file formats as necessary. To create a text file with lyrics automatically from a Karaoke MIDI file, so far, the only program I've found for this is [http://ultrastar.fr.free.fr/index.php?name=Forums&file=viewtopic&t=62 MidiKar2UltraStar]. It's written in Java and isn't Open Source. It would be nice to find some Open Source programs to automate the lyrics conversion.

=== MIDI/KAR ===
The karaoke song consist of a single MIDI file which usually has .kar or .mid extension. The MIDI file inside usually contains multiple tracks, and one of those tracks contains lyrics synchronized with the music. Because MIDI file only contains instructions for the music synthesizer (like //play note "A" using instrument "Grand Piano"//) and do not contain the music itself, the file is usually very small. Most song files are around 50K. Vast majority of MIDI files is created by amateurs, and legally offered for download for free. This format is very popular in Eastern Europe. But for any language it's usually much easier to find a MIDI karaoke song than MP3 karaoke song.

To play MIDI files, Kodi incorporates a MIDI synthesizer Timidity++. This is a full-featured synthesizer which supports soundfonts, but special configuration is required. Since the lyrics in the MIDI file are in text format, a good quality rendering is possible. However there is no standard which would require MIDI files to use only UTF8 encoding, and therefore some of them use UTF8, and some of them use local encoding. Kodi tries to auto-detect whether to use UTF-8 but it might not always succeed. The text in MIDI files is relatively hard to edit or modify, however a lot of editors are available on all platforms, and there is open-source free software like Rosegarden to edit MIDI files.

You can create your own Karaoke MIDI files using a standard text editor, ABC notation and the Open Source program [http://abc.sourceforge.net/abcMIDI/ abc2midi]. This will work on all platforms. If you're familiar with notes or can read sheet music, [http://abcnotation.com/ ABC Notation] should be easy to work with. You can also convert available ABC files to MIDI or Karaoke MIDI files to use with Kodi. If you have a MIDI file and want to edit it to add or tweak lyrics or change some notes, you can use [http://abc.sourceforge.net/abcMIDI/ midi2abc] to convert to ABC notation and then edit in a text editor. (You may lose some information in the conversion to ABC, but you can now change the music however you want.) After editing, you can convert back to Karaoke MIDI using abc2midi. If you want a more lossless way to edit MIDI files, try mf2t and t2mf or midicomp (combination of mf2t and t2mf available at [http://freepats.zenvoid.org/ Freepats site]). These Open Source programs let you convert a Karoake MIDI file directly into a text format that can edited in any standard text editor. You can easily edit Karaoke lyrics in this format. The programs then convert the text file back to Karaoke MIDI format.

== Configuration ==
Kodi needs to be configured to support karaoke. You need is to enable karaoke in the Setup -> Music -> Karaoke. I also suggest to disable "Music -> General -> Auto play next item" as it's usually not desirable for karaoke.

=== Skin selection ===
Skins other than default Confluence might require extra files to support Karaoke. Please make sure everything works with the default skin before switching to another, and if something does not work, please make sure it does not work on default skin too. The rule is the following: bugs in karaoke which happen using default skin, are assigned to me. Bugs which only happen using non-default skin, should be assigned to the team/person responsible for this skin.

=== Checking timings ===
You need to make sure there is no delay between audio and lyrics, or set up the appropriate value to compensate it. For this, get a couple of songs which you're sure are synchronized properly, and try to play it. If the lyrics are not synchronized, adjust delay through advancedsettings.xml. Note that there are two different delays for CDG and for LRC files. There is no delay for MIDI playback, it must be always synchronized.

=== MIDI playback ===
There are two ways to configure embedded Timidity synthesizer and enable MIDI playback - a simple way, and a more advanced way.

Simple way, you need a single soundfont file. Those are typically large (50Mb+) files with .sf2 extension, the most popular resource is http://www.sf2midi.com
I recommend using widespread and well-tested SGM-180 soundfont, google for it or get 2.01 version from http://www.geocities.jp/shansoundfont/ (this one is included into Arch linux in the soundfont-sgm180 package). Download the file, rename it to '''soundfont.sf2''' and put it into your Kodi directory:
* For revisions before 35301 copy it into '''system/players/paplayer/timidity''' subdirectory (you must create it first).
* For revisions after 35301 copy it into '''timidity''' subdirectory in your home '''userdata''' folder, i.e. something like .kodi/userdata/timidity/soundfont.sf2

Advanced way, you need to prepare timidity.cfg configuration file. Usually this is necessary when you use multiple soundfonts or want to add post-processing effects. This means you know enough of Timidity, and could handle it yourself. Kodi embeds [http://trac.kodi.tv/ticket/5490 version 2.13.2 of Timidity]. (Note: Versions of Timidity created in 2010 and after have better support for Karaoke midi files created by ABC notation and better timing for lyrics especially in the xaw part of the code.) Create timidity.cfg and put it in the '''system/players/paplayer/timidity''' subdirectory, and check Kodi log file for errors if it doesn't work. There's a soundfont configurator tool available online at [http://ocmnet.com/saxguru/Timidity.htm Tim Brechbill's Timidity site]. It's assumes you're on a Windows system, but should be okay with Posix systems too if you correct your paths appropriately. You can use it to generate the Timidity.cfg file for you. There are also links to other good soundfonts at this site.

Please note that for SGM-180 soundfont playback you need a decent machine with at least 256Mb of RAM and at least Pentium 2.4GHz CPU. Otherwise get a smaller soundfont.

If you want to use soundfonts with Open Source and/or Creative Commons licenses, check out the [http://freepats.zenvoid.org/ Freepats Project]. Many Linux distributions offer a Freepats package. The Freepats Project has Open Source and/or Creative Commons licensed soundfonts, instruments sounds and tools to create your own soundfonts.

=== Selection by number ===
To enable song selection by number, your music collection needs to be scanned (or rescanned if it was scanned already). During scan, the karaoke songs are detected, and the song numbers will be automatically assigned. After the scan is completed, you can export the numbered songs as HTML file (Setup -> Music -> Karaoke -> Export Karaoke titles... -> Export as HTML), open them in the OpenOffice Writer and print a song directory to have a professional Karaoke setup. Use two-column mode if you want to save space.

It is also possible to change the song numbering if you don't like it or if you want to maintain compatibility with your printed guide. For this you need to export numbered songs as CSV (Setup -> Music -> Karaoke -> Export Karaoke titles... -> Export as CSV), modify it as necessary, and import it back (Setup -> Music -> Karaoke -> Import Karaoke titles). The CSV format is TAB-separated, no quotes, no escape characters. The first field is song number, second field is artist name, third is song name, and fourth is path to the music file.

It is possible to select songs while a karaoke song is still played, by using numbers on your remote. This feature is enabled by default, however you need to make sure that the number buttons from your remote generate Number* events. By default they do not, so you need to modify your Keymap.xml. Put the following in your <remote> section:

<pre>
<zero>Number0</zero>
<one>Number1</one>
<two>Number2</two>
<three>Number3</three>
<four>Number4</four>
<five>Number5</five>
<six>Number6</six>
<seven>Number7</seven>
<eight>Number8</eight>
<nine>Number9</nine>
</pre>

When you start pressing numbers, a small dialog will pop up in a left top screen corner. It will show selected song number and song name or "Unknown" if there is no such song for this name. Once the song is selected, press "Select" on your remote to add it into the playlist.

=== Show song selector automatically ===
If the setting "Show song selector automatically" is enabled, the song selection dialog will pop up after the karaoke song ends if there are no more songs in the queue. It will not pop up after a non-Karaoke song. This dialog works exactly as the in-song dialog, however once the song is selected, it starts playing immediately.

=== Setting up default background mode ===
Default background mode is "no background". If you wish to use visualization, video or a picture as background, it should be enabled in [[AdvancedSettings.xml#.3Ckaraoke.3E|advancedsettings.xml]].

For video background the video file must be available in supported format. Currently all the formats which could be played by Kodi are supported with exception of DVD and DVD images. Video playback is in alpha phase, so currently only one video could be selected as background. Using highly compressed video is not recommended; MPEG2 is recommended for fast machines and MPEG1 for slow machines. Educational videos like National Geography look very good for background. Stripping audio is not needed, as any available audio stream will be ignored.

When playing CDG+MP3 files, note that they usually have their own background which you can turn on/off in [[AdvancedSettings.xml#.3Ckaraoke.3E|advancedsettings.xml]] as well.

== Where to get Karaoke files ==
'''MP3+CDG'''. CD-G disks are available from many online retailers such as http://www.shopkaraoke.com or http://www.mycdg.com, as well as from some high street shops. Since at this moment Kodi cannot play such disks, you're suggested to rip them using available tools. Once you have ripped the disks to MP3+G format, you can play the songs directly from your hard disk using Kodi.

Alternatively there are some online retailers offering downloadable MP3+G files. See http://www.tricerasoft.com for a good example. From sites like this you can download the files already in MP3+G format and play them directly using Kodi. There is also a bunch of web sites selling huge collections of MP3+G songs on multiple DVD disks.

'''MP3+LRC'''. At this moment we do not know about any vendor which would sell legit MP3 karaoke files with LRC lyrics. A lot of LRC karaoke files and music are available on Asian (mostly Chinese) web sites, either freely or commercially, but their legality is questionable. However, LRC lyrics alone are freely available at a lot of web sites, and relatively easy to create, see the article in this wiki on [[HOW-TO create LRC karaoke lyrics files]].

'''MP3+TXT'''. A few Creative Commons licensed songs come with UltraStar Deluxe. These will work on POSIX platforms as well as Windows. You can do a [http://search.creativecommons.org/ search on Creative Commons licensed MP3 files] to find songs you can legally share with others. You'll probably need to create your own lyrics files though. You can also check Ultrastar, Ultrastar Deluxe and Performous forums for more songs and/or lyrics. If you legally own songs on CD, you can rip them to WAV for personal use using Open Source tools like CDex or Asunder or K3B and then convert to MP3 with tools like Audacity or Sox. Some software may convert directly to MP3.

'''MIDI'''. MIDI karaoke files are mostly available for free as "public domain", while only a few of them are available commercially. (Note: Some freely available MIDI Karaoke files have copyright notifications embedded in them. Also, just because the MIDI file is available for free, doesn't mean it's public domain. If the song itself is under copyright, the midi file is not legally in the public domain.) They are often found in specialized musician/karaoke forums as well as on [http://www.midikaraoke.com dedicated websites]. The MIDI format was very popular before introduction of MP3, and tons of them could be found in the old newsgroups archives. There's also a search engine for Karaoke MIDI files at the VanBasco site, but the site isn't always available.

'''ABC'''. ABC Notation text files files can easily be converted to Karaoke MIDI files or even MP3 files with text lyrics. Many are free, in the public domain or have friendly licensing restrictions. There are several [http://abcnotation.com/search search engines] available for them. Another good place to look for them is [http://www.mudcat.org/ The Mudcat Cafe].

== Playing ==
Select the Karaoke song (either on disk or by number) and press "Select". The screen should change to visualization, and the song should start playing with the lyrics shown on screen. For us the best visualization for karaoke so far was Goom, but it is very resource-consuming so if your hardware is not top notch, you might want to switch to Project M instead, which is also very good.

If the lyrics for this specific song need to start earlier or later, press the button associated with SubtitleDelayPlus or SubtitleDelayMinus until lyrics are synchronized. Each press changes the delay by 50ms.

If you're in the middle of a song and decide you want to hear something else, press x to get back to your song listings. You can also move through your songs lists by pressing , or . to go backward or forward in your song listings.

== Advanced settings ==
The following advanced settings are added for karaoke support. All they must be stored in the advancedsettings.xml file in the <karaoke> section:
<syntaxhighlight lang=xml enclose="div">
<karaoke>

<syncdelaycdg>0.0</syncdelaycdg>

<syncdelaylrc>0.0</syncdelaylrc>

<alwaysreplacegenre>false</alwaysreplacegenre>

<storedelay>true</storedelay>

<autoassignstartfrom>1</autoassignstartfrom>

<nocdgbackground>true</nocdgbackground>

<defaultbackground type="video" path="special://masterprofile/karaokevideobg.avi"/>

<nextsongpopuptime>0.0</nextsongpopuptime>
</karaoke>
</syntaxhighlight>

== See also ==
{{#dpl: | category = Karaoke }}

[[Category:Karaoke]]

MySQL/Setting up Kodi

2018-07-10T12:24:56Z

Kibje: syntaxhighlighter fix

{{:MySQL/Contents}}
{{mininav| [[MySQL]] }}
Each device that will be sharing a library will need an [[Advancedsettings.xml|advancedsetting.xml]] file.

__TOC__
{{-}}
==Make files accessible over the network==
If you haven't already done so, you will need to make your media files accessible to all your Kodi devices by sharing them on the network through file sharing. Kodi itself or the MySQL server will not share the actual files for this setup. Most operating systems have built-in methods for sharing files to the network, or a [[NAS]] device can be used.

{{note|
*If you use passwords on your network shares then you will need to copy (or [[MySQL/Sync other parts of Kodi|sync]]) your passwords.xml file from the userdata folder to each Kodi device.
*Do not use mapped drives on the OS-level, as Kodi will see those as local drives.
*If you use smb:// paths, you may want to use static IP addresses rather than NetBIOS names, as not all your devices may be able to resolve the latter.
*'''Even if the media is on the same computer as one of the Kodi instances, you MUST use a network share path. You cannot use a local file path with MySQL.'''}}

See [[:Category:File Sharing]] for some of the file sharing methods that work with Kodi.

==Exporting==
{{see also|HOW-TO:Backup the video library|Import-export library}}

{{note|You only need to do the exporting steps if you are migrating an existing local library to a MySQL database. The MySQL setup creates an entirely new library on the MySQL server, so this step allows you to preserve your old library and restore it once MySQL is used in Kodi.}}

{{redv|'''Warning:''' |This will create individual ".nfo" and image files along side your video files. This is considered the safest way to backup and/or migrate a library (MySQL or otherwise), but some users might not want the file clutter. For an alternative method see '''[[why multiple files|here]]'''.}}

#Open Kodi on the computer that has the library you want to share
##Export the Video Library by doing the following:
###Go to '''Settings/Media/Library/Video Library''' and select '''Export library'''
###Select '''Multiple files'''

##Export the Music Library by doing the following:
###Go to ''''Settings/Media/Library/Music Library''' and select '''Export library'''
###Select '''Multiple files'''

==MySQL and advancedsettings.xml==
{| class=infobox
| advancedsettings.xml:
|-
|
<syntaxhighlight lang=xml>
<advancedsettings>
<videodatabase>
<type>mysql</type>
<host>***.***.***.***</host>
<port>3306</port>
<user>kodi</user>
<pass>kodi</pass>
</videodatabase>
<musicdatabase>
<type>mysql</type>
<host>***.***.***.***</host>
<port>3306</port>
<user>kodi</user>
<pass>kodi</pass>
</musicdatabase>
<videolibrary>
<importwatchedstate>true</importwatchedstate>
<importresumepoint>true</importresumepoint>
</videolibrary>
</advancedsettings>
</syntaxhighlight>
<small>''See also this note about using the <name> tag: [[#Name tag]]<br/><importwatchedstate> is only needed when you're importing a previous library from exported files.</small>
|}
#Create (or add to, if you already have one) an [[Advancedsettings.xml#.3Cmusicdatabase.3E.2F.3Cvideodatabase.3E|advancedsettings.xml]] file:
##Open up a plain text editor
##Copy and paste the text from the right-hand box into a new text document
##Replace the two instances of <code>***.***.***.***</code> with local network IP address of your MySQL server. If you installed MySQL on a Windows machine, do not use its NetBIOS name, as not all devices may be able to resolve them.
##Save the file as '''advancedsettings.xml'''
#Copy this ''advancedsettings.xml'' file you just created to the '''[[userdata folder]]''' of every Kodi install you want to sync with.
{{-}}

{{note|Sometimes it takes your dhcp too long before an ip-address is assigned to the local machine and the [https://github.com/samnazarko/osmc/issues/131 mysql driver are therefore not loaded]. In this case the library will appear empty and will not show resumepoints and watchedstates. In that case run <code>sudo systemctl enable connman-wait-for-network.service</code> on the shell or look for the option "wait for a network connection before loading" in the network options}}

==Importing==
At this point Kodi is using the MySQL server for the database, which means it has a new blank library. Now we can either import an old library (see below) or simply start a new library (see [[adding videos to the library]]). From this point on, Kodi behaves exactly like it would as if it had a local database, except that database is on the MySQL server and multiple installs can access that single database.

# Open any of your installs and re-import your library data, ''or'' simply set up a new library if you are starting fresh.
# Add (or just "set content" on) the networked video source to Kodi and scan it in as if you were setting up your library for the first time (see [[adding videos to the library]]). However, Kodi will read the exported nfo files and images and use those instead of rebuilding the library from scratch. The end result will be an identical library, and your watched status for videos will be preserved.
#:{{Note|You must add a network source using Kodi's standard formatting. For example, use "smb://192.168.1.20/Videos/" and not "\\BOBPC\Videos\". Try to use static IP addresses over NetBIOS names if using SMB.}}
# Import the Music Library by doing the following: Same idea as videos, but using the steps for [[adding music to the library]]. You'll end up with an identical library.
You can now add files and update the library from any of your devices and the library for all of them will stay in sync.

== Adding new Kodi devices to the MySQL setup ==
Since the database has now been set up on the MySQL server, all you need to do for any additional Kodi devices, is to copy a small number of files/folders.
* Copy the MySQL connections section for video and/or music databases into the '''advancedsettings.xml''' file on the other Kodi client(s). If you have identical Kodi devices, simply copy the whole advancedsettings.xml file from the initially setup Kodi device.
* Copy from the same userdata root folder the files, such as "'''favourites.xml'''", "'''sources.xml'''", "'''mediasources.xml'''", "'''passwords.xml'''" (if present).

To have the other Kodi client(s) also benefit from the already downloaded/cached art thumbnails:
* Copy the '''Textures13.db''' file from the '''userdata/Database folder''' to the other Kodi client(s).
* Copy the full '''Thumbnails''' subfolder from the userdata folder to other Kodi client(s). (This subfolder may contain several megabytes of small files when dealing with large video/music collections)

You don't need to do any of the other steps, such as rescanning or reimporting. Any fanart not already cached will be downloaded shortly after. If this method works on one device, it should work on all of them, as they are basically sharing the same "brain" for the video/music metadata.

If you however used a metadata collector add-on ([[scraper]]) that does not ship by default with new installations, such as the [[Add-on:Universal Movie Scraper|Universal Movie Scraper]] you will not be able to display the [[Basic_controls|media information screen]] on the new Kodi device. To fix that, you need to install the same metadata collector add-on on the new device.

==Name tag==
<section begin="name tag" />
An additional <code><name></code> tag can be used for both the <code><videodatabase></code> and <code><musicdatabase></code> entries in advancedsettings.xml file, if you want to change the name of the database. The <code><name></code> tag is not required. Kodi will use "MyVideos" and "MyMusic" as database names if the <code><name></code> tag is not specified.

You may want to do this if you want to have multiple separate libraries (with different content) on the same MySQL server. For example, if you want to create multiple profiles, each with their own shared library, so that each Kodi device can "log-into" that library. (a kids library, a guest library, etc)

{{note|Don't try to merge the video and music databases! You need to use different values in the <code><name></code> tag or you'll end up confusing Kodi leading to the library functionality not working at all. In other words, don't use <code><name>Kids</name></code> for both music and videos, but instead use something like <code><name>Kids-music</name></code> and <code><name>Kids-video</name></code>.}}

{{Krypton updated}}

MySQL/Advanced notes

2018-07-10T12:24:35Z

Kibje: syntaxhighligher fix

{{:MySQL/Contents}}
{{mininav| [[MySQL]] }}
__TOC__
{{-}}
==advancedsettings.xml==
For a full listing of the advancedsettings.xml parameters, see '''[[advancedsettings.xml#musicdatabase/videodatabase]]'''

== Other databases (PVR and ADSP) ==

{{MySQL warning}}

==MySQL speed-up tweaks==
For Kodi/XBMC ≤ v12 (Frodo) and/or MySQL 5.0 or lower: with MyISAM as the default storage engine, the following tweaks are necessary:<br />
[http://xbmcstuff.bossanova808.net/2011/03/summary-of-xbmc-mysql-database.html?m=1 MySQL speed-up tweaks for Kodi/XBMC] - See Comments for more information.<br />
[http://forum.kodi.tv/showthread.php?tid=212806&pid=1875330#pid1875330 More MySQL speed-up tweaks for Kodi/XBMC]<br />
<br />
For MySQL 5.5 or latest: with InnoDB as the default storage engine and/or v13 (Gotham)/Kodi+ only the following two tweaks are necessary.
=== In advancedsettings.xml: ===
Use the IP address and NOT the hostname of your MySQL server<br />
eg.: 192.168.1.105 <<IP address>> instead of \\SERVER

=== In my.cnf (my.ini for older versions): ===
The named file is located at /etc/mysql/my{{dot}}cnf<br />
1. $sudo nano /etc/mysql/my{{dot}}cnf<br />
2. Scroll down to '''[mysqld]''' section and add:<br />
# skip-name-resolve<br />
3. Press Ctrl+X, type y and hit Enter to validate changes and exit nano<br />
4. Restart your MySQL server. $sudo restart mysql

[[File:mysql.PNG|400px]]

==Automated Backup ==
=== Windows ===
This will allow you to make a regular backup of your MySQL database using the schedule of your choosing and saving the backups for however many days you choose. Recommend performing daily backups and saving for a minimum of 7 days. This will give you enough time to discover a problem with the DB and restore to a previous version that did not have problems.

To begin, go ahead and download the [http://www.7-zip.org/download.html command line version of 7zip]. We will use this to compress our MySQL dumps. Create a new folder in your C directory named KODISQLBACKUP. So you should have a C:\KODISQLBACKUP\ location now. In this location, create another new folder and name it zip. So you should now have C:\KODISQLBACKUP\zip. Extract the contents of the 7zip download to this location. Once complete you should have:
<br>
<pre>C:\KODISQLBACKUP\zip\7za.exe

C:\KODISQLBACKUP\zip\7-zip.chm

C:\KODISQLBACKUP\zip\license.txt

C:\KODISQLBACKUP\zip\readme.txt</pre>

We're going to create a down and dirty batch file to perform the actual backup, then we'll execute the batch script with the task scheduler built into Windows. For the purpose of these instructions, it is assumed that you are running MySQL 5.5 installed to the default location. If not, be sure to adjust your path(s) accordingly. It's also a good idea to save your backups to a network location to protect against local drive failure, so the paths here will reflect this. So here are the batch file contents:

<syntaxhighlight lang=winbatch enclose="div">
:: All lines that start with 2 colons are comments, they do not affect the script itself. These comments are explanations of each command, as well as instructions for the things that you will need to edit. Pay close attention to all comments.

:: These lines do not NEED to be edited
set year=%DATE:~10,4%
set day=%DATE:~7,2%
set mnt=%DATE:~4,2%
set hr=%TIME:~0,2%
set min=%TIME:~3,2%

IF %day% LSS 10 SET day=0%day:~1,1%
IF %mnt% LSS 10 SET mnt=0%mnt:~1,1%
IF %hr% LSS 10 SET hr=0%hr:~1,1%
IF %min% LSS 10 SET min=0%min:~1,1%

set backuptime=%mnt%-%day%-%year%-%hr%-%min%

:: User name for DB - NOTE that root credentials are needed for this script.
set dbuser=root

:: User password - NOTE that the root credentials are needed for this script.
set dbpass=password

:: Path to location where you would like to save the errors log file. For simplicity, I keep mine in the same location as the backups.
set errorLogPath="\\REMOTE\KODI_Database\backups\dumperrors.txt"

:: We need to switch to the data directory to enumerate the folders
pushd "C:\ProgramData\MySQL\MySQL Server 5.5\data"

:: We will dump each database to it's own .sql so you can easily restore ONLY what is needed in the future. We're also going to skip the performance_schema db as it is not necessary.

FOR /D %%F IN (*) DO (

IF NOT [%%F]==[performance_schema] (
SET %%F=!%%F:@002d=-!
"C:\Program Files\MySQL\MySQL Server 5.5\bin\mysqldump.exe" --user=%dbuser% --password=%dbpass% --databases --routines --log-error=%errorLogPath% %%F > "\\REMOTE\KODI_Database\backups\%%F.%backuptime%.sql"
) ELSE (
echo Skipping DB backup for performance_schema
)
)

::Now to zip all of the .sql files in this folder and move the resulting .zip files to our network location.

"c:\KODISQLBACKUP\zip\7za.exe" a -tzip "\\REMOTE\KODI_Database\backups\FullBackup.%backuptime%.zip" "\\REMOTE\KODI_Database\backups\*.sql"

::Now we'll delete the unzipped .sql files

del "\\REMOTE\KODI_Database\backups\*.sql"

::Now we'll delete all zip files older than 30 days. You can adjust the number of days to suit your needs, simply change the -30 to whatever number of days you prefer. Be sure you enter the path to your backup location.
Forfiles -p \\REMOTE\KODI_Database\backups\ -s -m *.* -d -30 -c "cmd /c del /q @path"

popd
</syntaxhighlight>

Save this as Kodibackup.bat at C:\KODISQLBACKUP
Make ''sure'' you include the .bat at the end.

After you have edited the above batch file to reflect your paths and saved it as a batch file, all that is left is scheduling it to run. Daily backups are best, but you can use whatever frequency you are comfortable with. To do this, open up the Windows Task Scheduler.

In the Task Scheduler click on "Create Task...", NOT "Create Basic Task...". In the new task window, in the Name box put Kodi MySQL backup (or whatever name you want).

Then click on the Triggers tab, followed by the New button. Select Daily (or whatever you want) and adjust the time you would like it to run. Click OK.

Click on the Actions tab and click New. In the Program/Script box enter C:\KODISQLBACKUP\Kodibackup.bat (or whatever you named your batch file) and in the start in box enter C:\KODISQLBACKUP

Click ok, then click ok in the task window. In the main task scheduler window, right click on the task you just created and select run. If everything works as it should, you should now have a zipped backup of your database(s) in your backup location. It will now do this for you automatically.

Enjoy!

=== Linux ===
[http://sourceforge.net/projects/automysqlbackup/ AutoMySQLBackup] is a script that is designed to keep daily, weekly and monthly backups of your databases. It is very customizable and reliable. There is useful information on installing and configuring the script here: http://www.linux.com/learn/tutorials/659107-how-to-do-painless-mysql-server-backups-with-automysqlbackup.
{{note|Detailed instructions on configuring AutoMySQLBackup should probably be added to this section as the linked page above could be deleted at any time and there is little beginner friendly information available on the web.}}

==Name tag==
{{#lst:MySQL/Setting up Kodi|name tag}}

==Multiple profiles with one MySQL database==
The idea is to share information on files in the library (only scrape once) but have individual watch status for every profile. For information see the forum thread [http://forum.kodi.tv/showthread.php?tid=196821 [MYSQL<nowiki>]</nowiki> HOW-TO: 5 User XBMC] and for a setup for Kodi v16 see [http://forum.kodi.tv/showthread.php?tid=196821&pid=2280431#pid2280431 this post]. An older setup can be found at: http://forum.kodi.tv/showthread.php?tid=81095&pid=840499#pid840499

{{Updated|16}}