Group List Control, Import-export library

From XBMC
(Difference between pages)
Jump to: navigation, search
(Example)
 
m (Music nfo files)
 
Line 1: Line 1:
The group list control is a special case of the group control. It is used for placing a set of controls into a list (either horizontally or vertically) and handles all the navigation within the list and placement within the list for you. It will be scrollable if the number of items exceeds the size of the list, and you can assign a scrollbar to it just like you can to any of the containers (list, panel, etc.).
+
{{Incomplete}}
===Example===
+
{{XBMC faq toc Inline}}
 +
XBMC offers the capability to import and export data manually into/from the  [[Library|Media Library]].
 +
 
 +
==Import / Export options==
 +
The Import / Export options can be found in Relevant [[Music Settings|Music]] / [[Videos Settings|Videos]] Settings.
 +
 
 +
'''Video Library:'''<br>
 +
;Export Video Library
 +
:Exports the Library [[The_XBMC_Database|database]] to either one, or multiple XML files.  When you initiate an export, XBMC will ask if you want to export to separate or a single file.
 +
:If you choose to export to separate files you will also be asked if you want to export [[thumbnails]] and [[fanart]] as well.
 +
:The resulting XML nfo file and associated image files will then be exported to the location of the corresponding video files.
 +
 
 +
;Import Video Library
 +
:Imports an XML file into the Library database. If the entry does not exist it is appended.
 +
:If it exists:
 +
#It removes all current info for that entry from the database.
 +
#Inserts the info for that entry from the XML file.
 +
 
 +
*'''Note:''' If you wish to import a movie, TV show, music video or episode into the library, use the corresponding format in the exported xml file and enclose it with the <videodb></videodb> tags. Examples can be seen below, as nfo files.
 +
 
 +
'''Music Library:'''<br>
 +
;Export Music Library
 +
:Exports the Library [[The_XBMC_Database|database]] to XML files.
 +
;Import Music / Video Library
 +
:Imports a XML file into the Library database. If the entry does not exist it is skipped.
 +
:If it exists:
 +
#It removes all current info for that entry from the database.
 +
#Inserts the info for that entry from the XML file.
 +
 
 +
==Video nfo Files==
 +
Nfo files can be used to provide data for a video file in XBMC or influence the search behavior of scrapers. In particular they are helpful if the information fetched from a web site does not match the video file, or data for that particular file does not exist.
 +
 
 +
By default at the time of scanning, if the media folder contains a correctly named *.nfo file, then XBMC will load the *.nfo file and attempt to either, in the case of it containing XML data get the metadata directly from the nfo file or will parse it for a direct URL to the scraper info page.  This allows XBMC to skip it's normal lookup and/or search procedures, useful if a file's information is not available on any of the scraper sites, or if the filematching criteria fails for the particular file.
 +
 
 +
===Video nfo Files containing XML data===
 +
1.  The *.nfo file is an XML file containing the data for inclusion in the library.
 +
 
 +
====Movies====
 +
Movie.nfo will override all and any nfo files in the same folder as the media files.
 +
If there is only one nfo file in a folder, The scraper will use it for all media files in that folder. If there are multiple media files in a folder, the *.nfo must be named exactly the same as the video file it is representing (ie. '''moviename.avi''' and '''moviename.nfo'''). In the case of multi-part (stacked) video [[Videos#Stacking_in_XBMC|stacking]], name the file either '''moviename.nfo''' or '''moviename-CD1.nfo''' where the first filename is '''moviename-CD1.avi'''.
 +
 
 
<xml>
 
<xml>
<control type="grouplist" id="17">
+
    <movie>
      <description>My first group list control</description>
+
        <title>Who knows</title>
      <posx>80</posx>
+
        <originaltitle>Who knows for real</originaltitle>
      <posy>60</posy>
+
        <rating>6.100000</rating>
      <width>250</width>
+
        <year>2008</year>
      <height>300</height>
+
        <top250>0</top250>
      <itemgap>10</itemgap>
+
        <votes>50</votes>
      <pagecontrol>25</pagecontrol>
+
        <outline>A look at the role of the Buckeye State in the 2004 Presidential Election.</outline>
      <scrolltime>200</scrolltime>
+
        <plot>A look at the role of the Buckeye State in the 2004 Presidential Election.</plot>
      <orientation>vertical</orientation>
+
        <tagline></tagline>
      <usecontrolcoords>false</usecontrolcoords>
+
        <runtime>90 min</runtime>
      <visible>true</visible>
+
        <thumb>http://ia.ec.imdb.com/media/imdb/01/I/25/65/31/10f.jpg</thumb>
      <onup>2</onup>
+
        <mpaa>Not available</mpaa>
      <ondown>3</ondown>
+
        <playcount>0</playcount>
      <onleft>1</onleft>
+
        <watched>false</watched>
      <onright>1</onright>
+
        <id>tt0432337</id>
      ... more controls go here ...
+
        <filenameandpath>c:\Dummy_Movie_Files\Movies\...So Goes The Nation.avi</filenameandpath>
</control>
+
        <trailer></trailer>
 +
        <genre></genre>
 +
        <credits></credits>
 +
        <director>Adam Del Deo</director>
 +
        <actor>
 +
            <name>Paul Begala</name>
 +
            <role>Himself</role>
 +
        </actor>
 +
        <actor>
 +
            <name>George W. Bush</name>
 +
            <role>Himself</role>
 +
        </actor>
 +
        <actor>
 +
            <name>Mary Beth Cahill</name>
 +
            <role>Herself</role>
 +
        </actor>
 +
        <actor>
 +
            <name>Ed Gillespie</name>
 +
            <role>Himself</role>
 +
        </actor>
 +
        <actor>
 +
            <name>John Kerry</name>
 +
            <role>Himself</role>
 +
        </actor>
 +
    </movie>
 
</xml>
 
</xml>
  
===Available Tags===
+
====TV Shows====
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.
+
The filename of the NFO should be "tvshow.nfo" (Exact, NOT the name of the actual TV show) and it should be in the root folder of the TV show.<br>
{| class="dtable"
+
The nfo xml file may contain a valid <episodeguideurl> to allow online updates. If not, only episodes with nfo files will be added.
|- class="userrow"
+
 
| class="usercell" | '''itemgap'''
+
<xml>
| class="usercell" | Specifies the gap (in pixels) between controls in the list.
+
    <tvshow>
|- class="userrow"
+
        <title>My TV Show</title>
| class="usercell" | '''orientation'''
+
        <episodeguideurl>http://www.thetvdb.com/api/1D62F2F90030C444/series/seriesid/all/language.zip<episodeguideurl>
| class="usercell" | Specifies whether the list is horizontal or vertical.  Defaults to vertical.
+
        <!-- select the correct seriesid and language (en.zip) -->
|- class="userrow"
+
        <rating>9.900</rating>
| class="usercell" | '''pagecontrol'''
+
    <episode>0</episode>
| class="usercell" | Specifies the page control used to scroll up and down the list. Set the page control's id here.
+
        <plot>The best TV show in the world</plot>
|- class="userrow"
+
    <genre>Action and Adventure / Drama</genre>
| class="usercell" | '''scrolltime'''
+
    <premiered>2000-01-01</premiered>
| class="usercell" | The time (in ms) to scroll from one item to another. By default, this is 200ms.  The list will scroll smoothly from one item to another as needed. Set it to zero to disable the smooth scrolling.
+
    <studio></studio>
|- class="userrow"
+
        <actor>
| class="usercell" | '''usecontrolcoords'''
+
            <name>Big John</name>
| class="usercell" | Specifies whether the list should use the control's coordinates as an offset location from the coordinates it would normally use to draw the control. Defaults to falseUseful for staggering a control in from the edge of the grouplist, or for having more space around a control than <itemgap> gives.
+
            <role>Jack of all trades</role>
|}
+
            <thumb></thumb>
[[category:Skin Development]]
+
        </actor>
 +
    </tvshow>
 +
</xml>
 +
 
 +
====TV Episodes====
 +
The *.nfo must be named exactly as the episode filename (i.e. '''episodename.avi''' and '''episodename.nfo''') and in the same folder, allowing multiple episode and *.nfo files within the same folder.<br>
 +
For multi-part episodes, simply add multiple <episodedetails> XML blocks in succession.
 +
 
 +
<xml>
 +
    <episodedetails>
 +
        <title>My TV Episode</title>
 +
        <rating>10.00</rating>
 +
        <season>2</season>
 +
        <episode>1</episode>
 +
        <plot>he best episode in the world</plot>
 +
        <credits>Writer</credits>
 +
        <director>Mr. Vision</director>
 +
        <aired>2000-01-01</aired>
 +
        <actor>
 +
            <name>Little Suzie</name>
 +
            <role>Pole Jumper/Dancer</role>
 +
        </actor>
 +
</episodedetails>
 +
</xml>
 +
 
 +
====Music Videos====
 +
The filename of the NFO should be the same as the music video file, only replacing the original extension with .nfo.<br>
 +
i.e. '''Bestartistintheworld - Bestsongintheworld.avi''' should have the corresponding nfo filename '''Bestartistintheworld - Bestsongintheworld.nfo'''.
 +
 
 +
<xml>
 +
    <musicvideo>
 +
        <title>Bestsongintheworld</title>
 +
        <artist>Bestartistintheworld</artist>
 +
        <album>Me</album>
 +
        <genre>Pop</genre>
 +
        <runtime>3:20</runtime>
 +
        <plot>Scantly clad women hoing about</plot>
 +
        <year>2000</year>
 +
        <director>and I</director>
 +
        <studio>Ego prod.</studio>
 +
    </musicvideo>
 +
</xml>
 +
 
 +
===Video nfo files containing an URL===
 +
2.  The *.nfo file contains a URL of the information page to scrape.
 +
The file can include other information (i.e. scene info), XBMC will scan through it and use a relevant URL if a match is found.
 +
 
 +
The scraper tries to match url's to all scrapers of the content type a dir is set to. E.g. if you set the content type to movies all movie scrapers check nfo files for a matching url. This means that nfo's override the scraper setting. I.e. a directory is set to use the imdb scraper but you have a german movie in it. Simply create a nfo for that movie with the ofdb link in it and you are sorted!
 +
 
 +
====Movies====
 +
Movie.nfo will override all and any nfo files in the same folder as the media files.
 +
 
 +
Moviename.nfo where Moviename is the name of the movie file that points to a movie on [[IMDb (Video Library)|IMDb.com]].
 +
 
 +
If you use the "Use Foldername for Lookups" [[Set_Contents_%28Video_Library%29#Options_After_Selecting_Scraper|scraper setting]] XBMC will use the first nfo file it finds in the folder and apply it to any valid video file it finds in the same folder.
 +
<nowiki>http://www.imdb.com/title/tt0333766</nowiki>
 +
 
 +
====TV Shows====
 +
Filename should be tvshow.nfo (Exact, NOT the name of the TV show) in the root folder of the TV Show that points to a show on [[TheTVDB.com (Video Library)|TheTVDB.com]].
 +
<nowiki>http://thetvdb.com/index.php?tab=series&id=73545</nowiki>
 +
 
 +
====TV Episodes====
 +
Episodename.nfo where Episodename is the name of the episode file.<br>
 +
'''Not currently supported!'''
 +
<nowiki>http://thetvdb.com/?tab=episode&seriesid=73545&seasonid=5950&id=117847&lid=7</nowiki>
 +
 
 +
====Music Videos====
 +
Mvideo.nfo where Mvideo is the name of the music video file that points to a music video on MTV.com
 +
<nowiki>http://www.mtv.com/overdrive/?artist=983&vid=222165</nowiki>
 +
 
 +
===Video nfo files containing a mix of XML and URL===
 +
You can also create nfo files that contain both XML data and an URL.
 +
This is useful for instance, if you want the entry in your database to have another name than the one officially provided by the scraper.
 +
 
 +
Example:
 +
<xml>
 +
<movie>
 +
    <title>Sin City (Recut, Extended, Unrated)</title>
 +
    <runtime>147 min.</runtime>
 +
</movie>
 +
http://www.imdb.com/title/tt0401792/
 +
</xml>
 +
 
 +
By default the xml entry is added to the scraped entry in the database and may result in some duplicates. If you want to completely override the scraped result you need to set a clear attribute for the relevant xml tag in the nfo file.
 +
 
 +
Example:
 +
<xml>
 +
    <genre clear="true">Action</genre> <genre>Horror</genre> <genre>Thriller</genre>
 +
    <director clear="true">Frank Miller</director> <director>Robert Rodriguez</director> <director>Quentin Tarantino</director>
 +
</xml>
 +
 
 +
Currently supported tags for the clear attribute are genre, director, studio, actor, credits and artist for Music Videos.
 +
 
 +
==Importing library information from "My Movies" media management software==
 +
[http://www.mymovies.name/ My Movies (www.mymovies.name)] is an online database for profiling DVD-Video movies. [http://www.mymovies.name/ My Movies] saves an XML file and a poster cover image which with this patch will get scanned by XBMC in the same way as XBMC's own XML formatted NFO files are scanned/scraped.
 +
 
 +
XBMC have the ability to the import movie library information from "[http://www.mymovies.name/ My Movies]" via the mymovies.xml files that it generates, and these mymovies.xml are prioritized over NFO files.
 +
 
 +
 
 +
==Music nfo files==
 +
 
 +
===Music nfo Files containing XML data===
 +
 
 +
====Artists====
 +
This information is missing, please help by contributing the relevant information.
 +
 
 +
====Albums====
 +
This information is missing, please help by contributing the relevant information.
 +
 
 +
===Music nfo files containing an URL===
 +
 
 +
====Artists====
 +
Artist.nfo in the artis folder that points to the corresponding artist page on  [http://www.allmusic.com Allmusic.com].
 +
  <nowiki>http://www.allmusic.com/cg/amg.dll?p=amg&sql=11:gifoxqwkldae</nowiki>
 +
Artist.nfo assumes an artist/album directory layout
 +
 
 +
====Albums====
 +
Album.nfo in the album folder that points to the corresponding album page on  [http://www.allmusic.com Allmusic.com].
 +
<nowiki>http://www.allmusic.com/cg/amg.dll?p=amg&sql=10:kifoxqualdde</nowiki>
 +
 
 +
[[category:Scraper]]
 +
[[category:nfo]]
 +
[[Category:To-Do]]
 +
[[category:Usage]]
 +
[[category:Library]]
 +
[[category:Video Library]]
 +
[[category:Music Library]]

Revision as of 08:06, 15 July 2009

Incomplete.png INCOMPLETE:
This page or section is incomplete. Please add information or correct uncertain data which is marked with a ?
Home icon grey.png   ▶ Import-export library

XBMC offers the capability to import and export data manually into/from the Media Library.

Contents

1 Import / Export options

The Import / Export options can be found in Relevant Music / Videos Settings.

Video Library:

Export Video Library
Exports the Library database to either one, or multiple XML files. When you initiate an export, XBMC will ask if you want to export to separate or a single file.
If you choose to export to separate files you will also be asked if you want to export thumbnails and fanart as well.
The resulting XML nfo file and associated image files will then be exported to the location of the corresponding video files.
Import Video Library
Imports an XML file into the Library database. If the entry does not exist it is appended.
If it exists:
  1. It removes all current info for that entry from the database.
  2. Inserts the info for that entry from the XML file.
  • Note: If you wish to import a movie, TV show, music video or episode into the library, use the corresponding format in the exported xml file and enclose it with the <videodb></videodb> tags. Examples can be seen below, as nfo files.

Music Library:

Export Music Library
Exports the Library database to XML files.
Import Music / Video Library
Imports a XML file into the Library database. If the entry does not exist it is skipped.
If it exists:
  1. It removes all current info for that entry from the database.
  2. Inserts the info for that entry from the XML file.

2 Video nfo Files

Nfo files can be used to provide data for a video file in XBMC or influence the search behavior of scrapers. In particular they are helpful if the information fetched from a web site does not match the video file, or data for that particular file does not exist.

By default at the time of scanning, if the media folder contains a correctly named *.nfo file, then XBMC will load the *.nfo file and attempt to either, in the case of it containing XML data get the metadata directly from the nfo file or will parse it for a direct URL to the scraper info page. This allows XBMC to skip it's normal lookup and/or search procedures, useful if a file's information is not available on any of the scraper sites, or if the filematching criteria fails for the particular file.

2.1 Video nfo Files containing XML data

1. The *.nfo file is an XML file containing the data for inclusion in the library.

2.1.1 Movies

Movie.nfo will override all and any nfo files in the same folder as the media files. If there is only one nfo file in a folder, The scraper will use it for all media files in that folder. If there are multiple media files in a folder, the *.nfo must be named exactly the same as the video file it is representing (ie. moviename.avi and moviename.nfo). In the case of multi-part (stacked) video stacking, name the file either moviename.nfo or moviename-CD1.nfo where the first filename is moviename-CD1.avi.

<xml>

   <movie>
       <title>Who knows</title>
       <originaltitle>Who knows for real</originaltitle>
       <rating>6.100000</rating>
       <year>2008</year>
       <top250>0</top250>
       <votes>50</votes>
       <outline>A look at the role of the Buckeye State in the 2004 Presidential Election.</outline>
       <plot>A look at the role of the Buckeye State in the 2004 Presidential Election.</plot>
       <tagline></tagline>
       <runtime>90 min</runtime>
       <thumb>http://ia.ec.imdb.com/media/imdb/01/I/25/65/31/10f.jpg</thumb>
       <mpaa>Not available</mpaa>
       <playcount>0</playcount>
       <watched>false</watched>
       <id>tt0432337</id>
       <filenameandpath>c:\Dummy_Movie_Files\Movies\...So Goes The Nation.avi</filenameandpath>
       <trailer></trailer>
       <genre></genre>
       <credits></credits>
       <director>Adam Del Deo</director>
       <actor>
           <name>Paul Begala</name>
           <role>Himself</role>
       </actor>
       <actor>
           <name>George W. Bush</name>
           <role>Himself</role>
       </actor>
       <actor>
           <name>Mary Beth Cahill</name>
           <role>Herself</role>
       </actor>
       <actor>
           <name>Ed Gillespie</name>
           <role>Himself</role>
       </actor>
       <actor>
           <name>John Kerry</name>
           <role>Himself</role>
       </actor>
   </movie>

</xml>

2.1.2 TV Shows

The filename of the NFO should be "tvshow.nfo" (Exact, NOT the name of the actual TV show) and it should be in the root folder of the TV show.
The nfo xml file may contain a valid <episodeguideurl> to allow online updates. If not, only episodes with nfo files will be added.

<xml>

   <tvshow>
       <title>My TV Show</title>
       <episodeguideurl>http://www.thetvdb.com/api/1D62F2F90030C444/series/seriesid/all/language.zip<episodeguideurl>
       <rating>9.900</rating>
   	<episode>0</episode>
       <plot>The best TV show in the world</plot>
   	<genre>Action and Adventure / Drama</genre>
   	<premiered>2000-01-01</premiered>
   	<studio></studio>
       <actor>
           <name>Big John</name>
           <role>Jack of all trades</role>
           <thumb></thumb>
       </actor>
   </tvshow>

</xml>

2.1.3 TV Episodes

The *.nfo must be named exactly as the episode filename (i.e. episodename.avi and episodename.nfo) and in the same folder, allowing multiple episode and *.nfo files within the same folder.
For multi-part episodes, simply add multiple <episodedetails> XML blocks in succession.

<xml>

   <episodedetails>
       <title>My TV Episode</title>
       <rating>10.00</rating>
       <season>2</season>
       <episode>1</episode>
       <plot>he best episode in the world</plot>
       <credits>Writer</credits>
       <director>Mr. Vision</director>
       <aired>2000-01-01</aired>
       <actor>
           <name>Little Suzie</name>
           <role>Pole Jumper/Dancer</role>
       </actor>
</episodedetails>

</xml>

2.1.4 Music Videos

The filename of the NFO should be the same as the music video file, only replacing the original extension with .nfo.
i.e. Bestartistintheworld - Bestsongintheworld.avi should have the corresponding nfo filename Bestartistintheworld - Bestsongintheworld.nfo.

<xml>

   <musicvideo>
       <title>Bestsongintheworld</title>
       <artist>Bestartistintheworld</artist>
       <album>Me</album>
       <genre>Pop</genre>
       <runtime>3:20</runtime>
       <plot>Scantly clad women hoing about</plot>
       <year>2000</year>
       <director>and I</director>
       <studio>Ego prod.</studio>
   </musicvideo>

</xml>

2.2 Video nfo files containing an URL

2. The *.nfo file contains a URL of the information page to scrape. The file can include other information (i.e. scene info), XBMC will scan through it and use a relevant URL if a match is found.

The scraper tries to match url's to all scrapers of the content type a dir is set to. E.g. if you set the content type to movies all movie scrapers check nfo files for a matching url. This means that nfo's override the scraper setting. I.e. a directory is set to use the imdb scraper but you have a german movie in it. Simply create a nfo for that movie with the ofdb link in it and you are sorted!

2.2.1 Movies

Movie.nfo will override all and any nfo files in the same folder as the media files.

Moviename.nfo where Moviename is the name of the movie file that points to a movie on IMDb.com.

If you use the "Use Foldername for Lookups" scraper setting XBMC will use the first nfo file it finds in the folder and apply it to any valid video file it finds in the same folder.

http://www.imdb.com/title/tt0333766

2.2.2 TV Shows

Filename should be tvshow.nfo (Exact, NOT the name of the TV show) in the root folder of the TV Show that points to a show on TheTVDB.com.

http://thetvdb.com/index.php?tab=series&id=73545

2.2.3 TV Episodes

Episodename.nfo where Episodename is the name of the episode file.
Not currently supported!

http://thetvdb.com/?tab=episode&seriesid=73545&seasonid=5950&id=117847&lid=7

2.2.4 Music Videos

Mvideo.nfo where Mvideo is the name of the music video file that points to a music video on MTV.com

http://www.mtv.com/overdrive/?artist=983&vid=222165

2.3 Video nfo files containing a mix of XML and URL

You can also create nfo files that contain both XML data and an URL. This is useful for instance, if you want the entry in your database to have another name than the one officially provided by the scraper.

Example: <xml> <movie>

   <title>Sin City (Recut, Extended, Unrated)</title>
   <runtime>147 min.</runtime>

</movie> http://www.imdb.com/title/tt0401792/ </xml>

By default the xml entry is added to the scraped entry in the database and may result in some duplicates. If you want to completely override the scraped result you need to set a clear attribute for the relevant xml tag in the nfo file.

Example: <xml>

   <genre clear="true">Action</genre> <genre>Horror</genre> <genre>Thriller</genre>
   <director clear="true">Frank Miller</director> <director>Robert Rodriguez</director> <director>Quentin Tarantino</director>

</xml>

Currently supported tags for the clear attribute are genre, director, studio, actor, credits and artist for Music Videos.

3 Importing library information from "My Movies" media management software

My Movies (www.mymovies.name) is an online database for profiling DVD-Video movies. My Movies saves an XML file and a poster cover image which with this patch will get scanned by XBMC in the same way as XBMC's own XML formatted NFO files are scanned/scraped.

XBMC have the ability to the import movie library information from "My Movies" via the mymovies.xml files that it generates, and these mymovies.xml are prioritized over NFO files.


4 Music nfo files

4.1 Music nfo Files containing XML data

4.1.1 Artists

This information is missing, please help by contributing the relevant information.

4.1.2 Albums

This information is missing, please help by contributing the relevant information.

4.2 Music nfo files containing an URL

4.2.1 Artists

Artist.nfo in the artis folder that points to the corresponding artist page on Allmusic.com.

http://www.allmusic.com/cg/amg.dll?p=amg&sql=11:gifoxqwkldae

Artist.nfo assumes an artist/album directory layout

4.2.2 Albums

Album.nfo in the album folder that points to the corresponding album page on Allmusic.com.

http://www.allmusic.com/cg/amg.dll?p=amg&sql=10:kifoxqualdde
Personal tools
Namespaces

Variants
Actions
Navigation
Wiki help
Toolbox