XBMC will be renamed to Kodi for v14. Read here for more details
Various pages on the wiki might contain old references to "XBMC", but will most often still apply to "Kodi". Find out how you can help here.

Import-export library, XBMC Online Manual

From Kodi
(Difference between pages)
Jump to: navigation, search
(Artists)
 
 
Line 1: Line 1:
{{Incomplete}}
+
{{XBMC wiki toc Inline}}
{{XBMC faq toc Inline}}
+
__NOEDITSECTION__
XBMC offers the capability to import and export data manually into/from the [[Library|Media Library]].
+
__NOTOC__
 +
The '''XBMC Online Manual''' is composed solely of contributions by the members of the XBMC community, and so remains incomplete. This manual may document functionality that appears only in the XBMC [[SVN]], and not yet in point releases. If your version seems to be missing a feature, check the full [http://xbmc.svn.sourceforge.net/viewvc/xbmc/trunk/XBMC/?view=log changelog] to see whether the feature is newer than the build of XBMC that you are currently running.
  
==Import / Export options==
+
XBMC always has been and always will be a community effort, and so with its documentation. Created to consolidate vast amounts of information accrued over the years, this manual was created and is updated through the perspiration of many. Feel free to contribute in any way that you can. If something's missing, add it. If something's jacked up, fix it.  
The Import / Export options can be found in Relevant [[Music Settings|Music]] / [[Videos Settings|Videos]] Settings.
+
  
'''Video Library:'''<br>
+
We have disabled anonymous editing and creating of wiki articles because of vandalism. Please register to edit existing pages, then follow our editing and formatting standards, as described in the [[Help:Contents|wiki help section]]. Editors may want to keep an eye on the [[Special:Recentchanges|Recent Changes]] and [[Special:Newpages|Newest Pages]] articles. Check the [[Special:Wantedpages|Wanted Pages]] to see what is most needed. If you are unsure whether you should put some information in here, feel free to drop by [irc://irc.freenode.net/xbmc #xbmc on freenode].  
;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
+
This manual was written using the default skin, Confluence, and uses the default keymapping for consistency.
: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.
+
'''Questions, comments, insults? See the [[Team XBMC and Others|Management]].'''
  
'''Music Library:'''<br>
+
The following table of contents is duplicated on the right side of each page.
;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==
+
==[[Introduction]]==
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.
+
*[[Introduction|About XBMC and The XBMC Project]]
 +
*[[XBMC Features and Supported Formats/Codecs|XBMC Features and Supported Formats/Codecs]]
 +
*[[XBMC Quick Start Guide]]
 +
*[[Team XBMC and Others|Team-XBMC (The people behind XBMC)]]
 +
==[[Setting Up XBMC]]==
 +
*[[Install XBMC|Install XBMC]]
 +
**[[Supported hardware]]
 +
**[[Installing XBMC for Linux]]
 +
**[[XBMC Live|Installing XBMC Live]]
 +
***[[Installing Gentoo-XBMC on AppleTV]]
 +
**[[Installing XBMC for Mac]]
 +
**[[XBMC for Mac on Apple TV|Installing XBMC for Mac on Apple TV]]
 +
**[[Install XBMC on ATV2|Installing XBMC for iOS on 2nd gen Apple TV]]
 +
**[[Install XBMC on iPhone/iPad|Installing XBMC for iOS on iPhone/iPad]]
 +
**[[Installing XBMC for Windows]]
 +
*[[Media Sources]]
 +
**[[Adding Media Sources|Add Media Sources]]
 +
**[[Types of Media Sources|Types of Media Sources]]
 +
**[[Configuring PC Shares|Sharing Media from Your PC]]
 +
*[[Profiles|User Profiles]]
 +
*[[The UserData Folder]]
 +
*[[Advanced Configuration]]
 +
*[[Add-ons]]
 +
**[[HOW-TO install and use plugins in XBMC|Installing Plugins]]
 +
**[[HOW-TO install and use scripts in XBMC|Installing Scripts]]
 +
**[[HOW-TO install and switch between skins in XBMC|Installing Skins]]
 +
==[[General Usage]]==
 +
*[[Default Controls]]
 +
*[[The User Interface]]
 +
**[[General]]
 +
**[[Programs]]
 +
**[[Pictures]]
 +
**[[Videos]]
 +
**[[Music]]
 +
**[[Weather]]
 +
**[[Settings]]
 +
**[[Plugins]]
 +
**[[Scripts]]
 +
**[[Filemanager]]
 +
*[[The Web Interface]]
 +
==[[Frequently Asked Questions]]==
 +
*[[What is XBMC & What Can it Do?|What is XBMC and what can XBMC do?]]
 +
*[[Obtaining XBMC]]
 +
*[[Installing/Running/Updating/Uninstalling XBMC]]
 +
*[[Using XBMC]]
 +
*[[Troubleshooting|Troubleshooting problems in XBMC]]
 +
*[[XBMC Forum FAQ]]
 +
**[[Forum Usage Guidelines]]
 +
*[[XBMC Live specific FAQ]]
 +
*[[XBMC for Linux specific FAQ]]
 +
*[[XBMC for Mac OS X specific FAQ]]
 +
*[[XBMC for iOS specific FAQ]]
 +
*[[XBMC for Windows specific FAQ]]
 +
*[[XBMC for Xbox specific FAQ]]
 +
==[[XBMC's Inner Workings]]==
 +
*[[XBMC development|XBMC development (in general)]]
 +
*[[XBMC for Linux|XBMC for Linux development]]
 +
*[[XBMC for Mac|XBMC for Mac development]]
 +
*[[XBMC for Windows|XBMC for Windows development]]
 +
*[[Python Development|XBMC Python Development]]
 +
**[[HOW-TO write plugins for XBMC|Creating Plugins]]
 +
**[[HOW-TO write Python Scripts|Creating Scripts]]
 +
**[[HOW-TO_debug_Python_Scripts_with_Eclipse|Debugging Python Scripts with Eclipse (multi-platform)]]
 +
**[[HOW-TO_debug_Python_Scripts|Debugging Python Scripts on Linux with WinPDB]]
 +
*[[Skinning XBMC|Skinning XBMC (making or modifying GUI skins)]]
 +
*[[WebServerHTTP-API|The HTTP API (XBMC's Web Server HTTPAPI)]]
 +
*[[EventServer|The EventServer API (and EventClients for it)]]
 +
*[[The XBMC Database|XBMC's SQL databases (database libraries)]]
 +
*[[Audio Players|Audio Players (and audio codecs/demuxers)]]
 +
*[[Video Players|Video Players (and video codecs/demuxers)]]
 +
==[[Appendices]]==
 +
*[[Appendix A: References|References]]
 +
*[[Appendix B: Troubleshooting|Troubleshooting]]
 +
*[[Tips And Tricks|HOW-TOs / Tips & Tricks]]
 +
*[[Appendix D: Development Notes|Development Notes]]
 +
*[[Remote Control Reviews]]
 +
*[[Disclaimer]]
 +
*[[Thanks]]
  
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.
+
=[[Current events]]=
 +
Actively ongoing sub-projects. Note that the information in these articles may change rapidly as the events progresses.  
 +
*[[Google Summer of Code 2010|Google Summer of Code 2010 (GSoC 2010)]]
 +
**[[GSoC Qualification Tasks]]
 +
**[[GSoC Proposal Ideas from Team-XBMC]]
 +
*[[Google Summer of Code 2008]]
 +
**[[GSoC - Unified PVR Frontend|GSoC - Unified PVR front-end with EPG]]
 +
**[[GSoC - GPU Assisted Video Decoding]]
 +
*[[Hardware Accelerated Video Decoding|GPU Hardware Accelerated Video Decoding]]
 +
*[[Games Library Ideas|Games Library Ideas (Emulator Launcher)]]
  
===Video nfo Files containing XML data===
+
[[category:XBMC Manual]]
1.  The *.nfo file is an XML file containing the data for inclusion in the library.
+
[[category:Introduction]]
 
+
====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>
+
    <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>
+
 
+
====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.<br>
+
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>
+
        <!-- select the correct seriesid and language (en.zip) -->
+
        <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>
+
 
+
====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====
+
<xml><artists>
+
  <name>Artist/Band Name</name>
+
  <genre clear=true>First Genre</genre>
+
  <genre>Second Genre</genre>
+
  ...
+
  <genre>Nth Genre</genre>
+
  <style clear=true>First Style</style>
+
  <style>Second Style</style>
+
  ...
+
  <style>Nth Style<style>
+
  <mood clear=true>First Mood</mood>
+
  <mood>Second Mood</mood>
+
  ...
+
  <mood>Nth Mood</mood>
+
  <yearsactive clear=true>First year active (1993)</theme>
+
  <yearsactive>Second year active (1995)</yearsactive>
+
  ...
+
  <yearsactive>Nth year active (2000)</yearsactive>
+
  <born>Birth date of artist</born>
+
  <formed>Date band formed</formed>
+
  <instruments>Musical instruments used by artist/band</instruments>
+
  <biography>Artist/Band biography text</biography>
+
  <died>Date artist died</died>
+
  <disbanded>Date band broke up<disbanded>
+
  <thumbs>
+
    <thumb>/path/to/unix/style/artist/thumb1.tbn</thumb>
+
    <thumb>C:\path\to\win32\style\artist\thumb2.png</thumb>
+
    <thumb>http://path.to/www/remote/artist/thumb3.jpg</thumb>
+
    ...
+
    <thumb>smb://path/to/smb/remote/artist/thumbN.tbn</thumb>
+
  </thumbs>
+
  <album>
+
    <title>First Album Title</title>
+
    <year>Release year of first album</year>
+
  </album>
+
  ...
+
  <album>
+
    <title>Nth Album Title</title>
+
    <year>Release year of Nth album</year>
+
  </album>
+
</artists></xml>
+
 
+
NOTE: Where indicated, tags can accept an optional "clear" boolean (true/false) attribute which clears scraped data and all values of similar tags up to that point.
+
 
+
====Albums====
+
<xml><albums>
+
  <title>The Album Title</title>
+
  <artist clear=true>First Artist</artist>
+
  <artist>Second Artist</artist>
+
  ...
+
  <artist>Nth Artist</artist>
+
  <genre clear=true>First Genre</genre>
+
  <genre>Second Genre</genre>
+
  ...
+
  <genre>Nth Genre</genre>
+
  <style clear=true>First Style</style>
+
  <style>Second Style</style>
+
  ...
+
  <style>Nth Style<style>
+
  <mood clear=true>First Mood</mood>
+
  <mood>Second Mood</mood>
+
  ...
+
  <mood>Nth Mood</mood>
+
  <theme clear=true>First Theme</theme>
+
  <theme>Second Theme</theme>
+
  ...
+
  <theme>Nth Theme</theme>
+
  <review>Album review text</review>
+
  <releasedate>Album release date</releasedate>
+
  <label>Record label the album was released under</label>
+
  <type>Erm...EP/LP? CD,Vinyl,DVDA,etc? I dunno</type>
+
  <year>Year album was released</year>
+
  <rating>Rating out of 5?<rating>
+
  <thumbs>
+
    <thumb>/path/to/unix/style/album/thumb1.tbn</thumb>
+
    <thumb>C:\path\to\win32\style\album\thumb2.png</thumb>
+
    <thumb>http://path.to/www/remote/album/thumb3.jpg</thumb>
+
    ...
+
    <thumb>smb://path/to/smb/remote/thumbN.tbn</thumb>
+
  <thumbs>
+
  <track>
+
    <position>Track Number (1)</position>
+
    <title>Title of first track</title>
+
    <duration>Length of first track (XXX min, MM:SS)</duration>
+
  <track>
+
  ...
+
  <track>
+
    <position>Track Number (N)</posistion>
+
    <title>Title of Nth track</title>
+
    <duration>Length of Nth track</duration>
+
  <track>
+
</albums></xml>
+
 
+
NOTE: Where indicated, tags can accept an optional "clear" boolean (true/false) attribute which clears corresponding scraped data and all values of similar tags up to that point.
+
 
+
===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 02:19, 26 March 2011

Home icon grey.png   XBMC Online Manual


The XBMC Online Manual is composed solely of contributions by the members of the XBMC community, and so remains incomplete. This manual may document functionality that appears only in the XBMC SVN, and not yet in point releases. If your version seems to be missing a feature, check the full changelog to see whether the feature is newer than the build of XBMC that you are currently running.

XBMC always has been and always will be a community effort, and so with its documentation. Created to consolidate vast amounts of information accrued over the years, this manual was created and is updated through the perspiration of many. Feel free to contribute in any way that you can. If something's missing, add it. If something's jacked up, fix it.

We have disabled anonymous editing and creating of wiki articles because of vandalism. Please register to edit existing pages, then follow our editing and formatting standards, as described in the wiki help section. Editors may want to keep an eye on the Recent Changes and Newest Pages articles. Check the Wanted Pages to see what is most needed. If you are unsure whether you should put some information in here, feel free to drop by #xbmc on freenode.

This manual was written using the default skin, Confluence, and uses the default keymapping for consistency.

Questions, comments, insults? See the Management.

The following table of contents is duplicated on the right side of each page.

1 Introduction

2 Setting Up XBMC

3 General Usage

4 Frequently Asked Questions

5 XBMC's Inner Workings

6 Appendices

7 Current events

Actively ongoing sub-projects. Note that the information in these articles may change rapidly as the events progresses.

Personal tools
Namespaces

Variants
Actions
Navigation
Wiki help
Toolbox