Favourites.xml: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
m (syntaxhighlighter fix)
(Updated for v20)
 
Line 1: Line 1:
{{mininav| [[Userdata]] {{l2| [[Favourites]] }} }}
{{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==
= Introduction =
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''''' file contains the data of all items added to the '''[[Favourites]]''' listing.


The '''''favourites.xml''''' is located in the '''''[[Userdata]]''''' folder.
For advanced users, the ''favourites.xml'' file can be edited manually, rather than using the {{kodi}} interface to create and edit the listing.
 
See also: '''[[Favourites]]'''
 
 
 
= Favourites.xml =
The '''''favourites.xml''''' file is located in the '''''[[Userdata]]''''' folder.
 
The '''User preference order''' of the Favourites screen is determined by the order of the entries in the xml file, which is the order they were added to the Favourites list.
 
To change the order, simply move the entries to the desired order.




'''Example: '''
'''Example: '''
The format of the favourites.xml is as follows. The example shows Playlist, TV Show, TV Episode, Artist, Album and Add-on.
The format of the favourites.xml is as follows.
<syntaxhighlight lang=xml enclose="div">
<syntaxhighlight lang=xml enclose="div">
<favourites>
<favourites>
     <favourite name="Marvel Universe">ActivateWindow(10025,&quot;special://profile/playlists/video/Marvel Universe.xsp&quot;,return)</favourite>
     <favourite name="The Big Bang Theory" thumb="smb://HTPC-PC/J/TV Complete AK/Big Bang Theory (2007)/poster.jpg">ActivateWindow(10025,&quot;videodb://tvshows/titles/1/&quot;,return)</favourite>
    <favourite name="Continuum" thumb="E:\TV Show- TEST\Continuum\thumb.jpg">ActivateWindow(10025,&quot;E:\\TV Show- TEST\\Continuum\\&quot;,return)</favourite>
     <favourite name="Artwork Dump" thumb="C:\Kodi\KODI- v20 Release\portable_data\addons\script.artwork.dump\icon.png">RunAddon(&quot;script.artwork.dump&quot;)</favourite>
     <favourite name="1x02. Fast Times" thumb="E:\TV Show- TEST\Continuum\Continuum S01E02-thumb.jpg">PlayMedia(&quot;E:\\TV Show- TEST\\Continuum\\Continuum S01E02.mkv&quot;)</favourite>
     <favourite name="U2" thumb="C:\Kodi\Test- Music\U2\Best Of 1980-1990, The\discart.png">ActivateWindow(10502,&quot;C:\\Kodi\\Test- Music\\U2\\&quot;,return)</favourite>
     <favourite name="Era" thumb="F:\Music\ArtistInfoKodi\Era\folder.jpg">ActivateWindow(10502,&quot;musicdb://artists/113/?albumartistsonly=false&quot;,return)</favourite>
     <favourite name="Open Space" thumb="C:\Kodi\Test- Music\Open Space\discart.png">ActivateWindow(10502,&quot;C:\\Kodi\\Test- Music\\Open Space\\&quot;,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,&quot;E:\\TV Show- TEST\\&quot;,return)</favourite>
    <favourite name="Artist Albums">ActivateWindow(10502,&quot;F:\\Music\\FLAC\\Artist Albums\\&quot;,return)</favourite>
</favourites>
</favourites>
</syntaxhighlight >
</syntaxhighlight >
'''Note:''' When adding library items to Favourites, some items are linked by their ID's contained in the library databases. If these items are deleted and rescraped or refreshed, the ID's will most likely change and the favourites entry becomes invalid.






==Renaming a favourite via xml==
= Format of Favourite Item =
Change the name of any item by amending the ''<fabourite name="">'' section.


<syntaxhighlight lang=xml enclose="div">
<syntaxhighlight lang=xml enclose="div">
<favourites>
<favourites>
     <favourite name="Enter Desired name here" thumb="http://static.ddmcdn.com/gif/videos/120x90/52447.jpg">PlayMedia(&quot;plugin://plugin.video.howstuffworks_com/?url=52447&amp;mode=playVideo&quot;)</favourite>
     <favourite name="Enter name here" thumb="URL (local or online)">Action</favourite>
</favourites>
</favourites>
</syntaxhighlight >
</syntaxhighlight >




{{Top}}
{{Top}}


{{updated|18}}
{{updated|20}}
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Development]]
[[Category:Development]]
[[Category:General topics]]
[[Category:General topics]]

Latest revision as of 03:59, 25 January 2023

Home icon grey.png   ▶ Userdata
▶ Favourites
▶ Favourites.xml


Introduction

The favourites.xml file contains the data of all items added to the Favourites listing.

For advanced users, the favourites.xml file can be edited manually, rather than using the Kodi interface to create and edit the listing.

See also: Favourites


Favourites.xml

The favourites.xml file is located in the Userdata folder.

The User preference order of the Favourites screen is determined by the order of the entries in the xml file, which is the order they were added to the Favourites list.

To change the order, simply move the entries to the desired order.


Example: The format of the favourites.xml is as follows.

<favourites>
    <favourite name="The Big Bang Theory" thumb="smb://HTPC-PC/J/TV Complete AK/Big Bang Theory (2007)/poster.jpg">ActivateWindow(10025,&quot;videodb://tvshows/titles/1/&quot;,return)</favourite>
    <favourite name="Artwork Dump" thumb="C:\Kodi\KODI- v20 Release\portable_data\addons\script.artwork.dump\icon.png">RunAddon(&quot;script.artwork.dump&quot;)</favourite>
    <favourite name="U2" thumb="C:\Kodi\Test- Music\U2\Best Of 1980-1990, The\discart.png">ActivateWindow(10502,&quot;C:\\Kodi\\Test- Music\\U2\\&quot;,return)</favourite>
    <favourite name="Open Space" thumb="C:\Kodi\Test- Music\Open Space\discart.png">ActivateWindow(10502,&quot;C:\\Kodi\\Test- Music\\Open Space\\&quot;,return)</favourite>
</favourites>

Note: When adding library items to Favourites, some items are linked by their ID's contained in the library databases. If these items are deleted and rescraped or refreshed, the ID's will most likely change and the favourites entry becomes invalid.


Format of Favourite Item

<favourites>
    <favourite name="Enter name here" thumb="URL (local or online)">Action</favourite>
</favourites>


Return to top