NFO files/TV shows: Difference between revisions
No edit summary |
(Knowin Issues) |
||
Line 37: | Line 37: | ||
== Known Issues == | == Known Issues == | ||
The parsing nfo requires the URL to be '''''http''''' only (no '''s'''). Currently '''''https''''' addresses are not recognised during parsing. The bug has been reported and | The parsing nfo requires the URL to be '''''http''''' only (no '''s'''). Currently '''''https''''' addresses are not recognised during parsing. The bug has been reported. This affects all releases upto, and including, v17. This will be fixed in v18 and, for earlier versions, will be fixed in the new TVDB v2.0 API. It is suggested you try the '''''https''''' address initially, if this fails then use the '''''http''''' address. | ||
Revision as of 20:22, 16 October 2017
NFO Contents |
---|
NFO_files | TV shows |
Requirements
TV Shows require the following nfo files
- One nfo file for the TV Show. This file holds the overall show information
- One nfo file for each Episode. This file holds information specific to that episode
For one TV Show with 10 episodes, you will require 11 nfo files.
TV Shows and Episodes must abide by the standard naming conventions even if you are using nfo files.
The order of importing metadata is as follows:
- nfo file. If no nfo file exists, then
- Depending on your scraper settings for your source, either
- Online scraper sites- if a scraper is set in your source settings
- Nothing- if Local Info Only is set
When Kodi locates the nfo file it will load the *.nfo file and:
- If the file is a metadata nfo, Kodi will import the meta-data directly into the library from the .nfo file or
- If the file is a parsing nfo, Kodi will parse the nfo file for a direct URL to the scraper info page, then scrape the online metadata.
- If the file is a combination nfo, Kodi will parse the nfo file and scrape the online metadata, then import the metadata from the nfo file.
Known Issues
The parsing nfo requires the URL to be http only (no s). Currently https addresses are not recognised during parsing. The bug has been reported. This affects all releases upto, and including, v17. This will be fixed in v18 and, for earlier versions, will be fixed in the new TVDB v2.0 API. It is suggested you try the https address initially, if this fails then use the http address.
nfo Placement
Correct placement of the nfo file is essential. Regardless of what settings you have set for the source and scraper, Kodi will always search for and scrape a nfo file if it is available. Failing to save the file in the correct location, as detailed below, will force Kodi to either:
- Scrape the metadata from the online source set in your scraper or,
- If you have Local Info Only set as your scraper, then no entry will be made into the library.
TV Show
One TV Show nfo is required. Be aware the nfo filename is actually tvshow.nfo. This is not meant to indicate that it is replaced with the name of the show.
Naming & Saving conventions for your TV Show *.nfo files:
Saved TV Show as | File Name | Save Location |
All formats | tvshow.nfo | f:\MyTVShows\iZombie\tvshow.nfo |
TV Episode
One nfo file for every episode is required.
Naming & Saving conventions for your TV Episode *.nfo files:
Saved Episodes as | File Name | Save Location |
BluRay Structure: | index.nfo | f:\MyTVShows\iZombie\iZombie S01E01\BDMV\index.nfo |
DVD Structure: | VIDEO_TS.nfo | f:\MyTVShows\iZombie\iZombie S01E01\VIDEO_TS\VIDEO_TS.nfo |
Single Episode file in directory: | <EpisodeFileName>.nfo | f:\MyTVShows\iZombie\iZombie S01E01\<EpisodeFileName>.nfo |
All episodes in TV Show directory: | <EpisodeFileName>.nfo | f:\MyTVShows\iZombie\<EpisodeFileName>.nfo |
TV nfo Tags
The only required tags are indicated below in the tables. All other tags are optional. Of course, the less tags used, the less information that will be scraped into the library unless you are using a parsing or combination nfo.
- See also: Databases
TV Show Tags
The following table lists the XML tags available for the TV Show in Kodi. Children tags are displayed correctly with parent tags.
NFO (xml) Tag | Required | Multiple | Notes |
---|---|---|---|
<tvshow></tvshow> | Yes | No | The top level parent tag for the nfo file. All other tags must be contained within these two tags |
<title></title> | No | No | |
<originaltitle></originaltitle> | No | No | |
<showtitle></showtitle> | No | No | |
<sorttitle></sorttitle> | No | No | Allows alternate title sort without modifying show title in library. |
<ratings> <rating name="default" max="10" default="true"> <value></value> <votes></votes> </rating> </ratings> |
No | No | |
<userrating></userrating> | No | No | |
<top250></top250> | No | No | |
<season></season> | No | No | |
<episode></episode> | No | No | Number of episodes in TV Show |
<displayepisode></displayepisode> | No | No | Not used in TV Shows |
<displayseason></displayseason> | No | No | Not used in TV Shows |
<outline></outline> | Not Used | ||
<plot></plot> | Can contain more information on multiple lines, will be wrapped | ||
<tagline></tagline> | No | No | |
<runtime></runtime> | No | No | Minutes only |
<thumb aspect="" type="" season=""></thumb> | No | Yes | Path to TV Show and Season artwork |
<fanart url=""> <thumb dim="" colors="" preview=""></thumb> </fanart> |
No | No | Path to available TV Show fanart. Multible <thumb> entries allowed. dim=Dimensions |
<mpaa></mpaa> | No | No | |
<playcount></playcount> | Setting this to 1, or greater, will mark the TV Show as watched if the importwatchedstate flag is set in advancedsettings.xml | ||
<lastplayed></lastplayed> | No | No | |
<file></file> | No | No | Not Used. Exported in Single File Export only |
<path></path> | Yes | No | Exported in Single File Export only |
<filenameandpath></filenameandpath> | Yes | No | Exported in Single File Export only |
<basepath></basepath> | Yes | No | Exported in Single File Export only |
<episodeguide> <url cache=""></url> </episodeguide> |
Yes/No | No | Required if no or missing episode nfo's |
<id></id> | No | No | Scraper site ID |
<uniqueid type="unknown" default="true"></uniqueid> | No | No | Scraper site ID |
<genre></genre> | No | Yes | Supports "clear" attribute |
<tag></tag> | No | Yes | TV Show tags |
<premiered></premiered> | No | No | |
<year></year> | No | No | |
<status></status> | No | No | Continuing or Ended show |
<aired></aired> | No | No | Used for TV Episodes |
|
Unknown | ||
<studio></studio> | No | Yes | Supports "clear" attribute |
<trailer></trailer> | No | No | Path to TV Show trailer |
<actor> <name></name> <role></role> <order></order> <thumb></thumb> </actor> |
No | Yes | The <order> tag determines where in the list the actor will appear. 0 = first in the list
Supports "clear" attribute |
<resume> <position></position> <total></total> </resume> |
No | No | Not used for TV Show |
<dateadded></dateadded> | No | No | Date the file was added to library. Can be altered in advancedsettings.xml |
TV Episode Tags
The following table lists the XML tags available for TV Episodes in Kodi. Children tags are displayed correctly with parent tags.
For multi-part episodes, simply add multiple <episodedetails> XML blocks in succession.
NFO (xml) Tag | Required | Multiple | Notes |
---|---|---|---|
<episodedetails></episodedetails> | Yes | No | The top level parent tag for the nfo file. All other tags must be contained within these two tags |
<title></title> | No | No | |
<originaltitle></originaltitle> | No | No | |
<showtitle></showtitle> | No | No | |
<ratings> <rating name="default" max="10" default="true"> <value></value> <votes></votes> </rating> </ratings> |
No | No | |
<userrating></userrating> | No | No | |
<top250></top250> | No | No | |
<season></season> | No | No | Season the episode belongs to |
<episode></episode> | No | No | Episode numbering |
<displayepisode></displayepisode> | No | No | Used to place Special Episodes in the correct viewing order |
<displayseason></displayseason> | No | No | Used to place Special Episodes in the correct viewing order |
<outline></outline> | |||
<plot></plot> | Can contain more information on multiple lines, will be wrapped | ||
<tagline></tagline> | No | No | |
<runtime></runtime> | No | No | Minutes only |
<thumb></thumb> | No | Yes | Path to episode artwork |
<mpaa></mpaa> | No | No | |
<playcount></playcount> | Setting this to 1, or greater, will mark the TV Show as watched if the importwatchedstate flag is set in advancedsettings.xml | ||
<lastplayed></lastplayed> | No | No | |
<file></file> | No | No | Not Used. Exported in Single File Export only |
<path></path> | Yes | No | Exported in Single File Export only |
<filenameandpath></filenameandpath> | Yes | No | Exported in Single File Export only |
<basepath></basepath> | Yes | No | Exported in Single File Export only |
<id></id> | No | No | Scraper site ID |
<uniqueid type="unknown" default="true"></uniqueid> | No | No | Scraper site ID |
<genre></genre> | No | Yes | Supports "clear" attribute |
<credits></credits> | No | Yes | Writers |
<director></director> | No | No | |
<premiered></premiered> | No | No | |
<year></year> | No | No | |
<status></status> | No | No | Not used in Episodes |
|
Unknown | ||
<aired></aired> | No | No | Original air date of the episode |
<studio></studio> | No | Yes | Supports "clear" attribute |
<trailer></trailer> | No | No | Path to TV Show trailer |
<fileinfo> <streamdetails> <video> <codec>h264</codec> <aspect>1.777778</aspect> <width>1920</width> <height>1080</height> <durationinseconds>2626</durationinseconds> <stereomode></stereomode> </video> <audio> <codec>mp2</codec> <language>eng</language> <channels>2</channels> </audio> </streamdetails> </fileinfo> |
No | No | While it is possible to manually set the information contained within the <streamdetails> tag, there is little point in doing so.
Kodi will always overwrite this data when it plays back the video file. |
<actor> <name></name> <role></role> <order></order> <thumb></thumb> </actor> |
No | Yes | The <order> tag determines where in the list the actor will appear. 0 = first in the list
Supports "clear" attribute |
<resume> <position></position> <total></total> </resume> |
No | No | |
<dateadded></dateadded> | No | No | Date the file was added to library. Can be altered in advancedsettings.xml |
<art> <fanart></fanart> <poster></poster> </art> |
Yes | No | Art in use. Exported in Single File Export only |
Sample nfo Files
Provided below is a sample nfo file for the TV Show and for Episodes to assist with the manual creation process.
Press Expand at right edge of the green bar to view
TV Show nfo
Sample TV Show nfo. Extract from Single File Export
TV Show nfo file (click 'expand' to view) |
---|
<tvshow>
<title>Angels</title>
<originaltitle>TtvshowC09</originaltitle>
<showtitle>Angels</showtitle>
<sorttitle>TtvshowC15</sorttitle>
<ratings>
<rating name="default" max="10" default="true">
<value>8.600000</value>
<votes>88</votes>
</rating>
</ratings>
<userrating>3</userrating>
<top250>0</top250>
<season>5</season>
<episode>110</episode>
<displayseason>-1</displayseason>
<displayepisode>-1</displayepisode>
<outline></outline>
<plot>Angel is an American television series, a spin-off from the television series Buffy the Vampire Slayer. Angel (David Boreanaz), a 240-year old vampire cursed with a conscience, haunts the dark streets of Los Angeles alone</plot>
<tagline></tagline>
<runtime>45</runtime>
<thumb aspect="banner">http://thetvdb.com/banners/graphical/71035-g7.jpg</thumb>
<thumb aspect="banner">http://thetvdb.com/banners/graphical/71035-g2.jpg</thumb>
<thumb aspect="banner">http://thetvdb.com/banners/graphical/12-g.jpg</thumb>
<thumb aspect="banner">http://thetvdb.com/banners/graphical/71035-g8.jpg</thumb>
<thumb aspect="banner">http://thetvdb.com/banners/graphical/71035-g6.jpg</thumb>
<thumb aspect="banner">http://thetvdb.com/banners/graphical/71035-g3.jpg</thumb>
<thumb aspect="banner">http://thetvdb.com/banners/graphical/71035-g4.jpg</thumb>
<thumb aspect="banner">http://thetvdb.com/banners/graphical/71035-g10.jpg</thumb>
<thumb aspect="banner">http://thetvdb.com/banners/graphical/71035-g.jpg</thumb>
<thumb aspect="banner">http://thetvdb.com/banners/graphical/71035-g9.jpg</thumb>
<thumb aspect="banner">http://thetvdb.com/banners/graphical/71035-g5.jpg</thumb>
<thumb aspect="banner">http://thetvdb.com/banners/text/71035.jpg</thumb>
<thumb aspect="banner">http://thetvdb.com/banners/text/12.jpg</thumb>
<thumb aspect="poster" type="season" season="0">http://thetvdb.com/banners/seasons/71035-0-2.jpg</thumb>
<thumb aspect="poster" type="season" season="5">http://thetvdb.com/banners/seasons/71035-5-2.jpg</thumb>
<thumb aspect="poster" type="season" season="3">http://thetvdb.com/banners/seasons/71035-3-3.jpg</thumb>
<thumb aspect="poster" type="season" season="4">http://thetvdb.com/banners/seasons/71035-4-2.jpg</thumb>
<thumb aspect="poster" type="season" season="2">http://thetvdb.com/banners/seasons/71035-2-2.jpg</thumb>
<thumb aspect="poster" type="season" season="2">http://thetvdb.com/banners/seasons/12-2.jpg</thumb>
<thumb aspect="poster" type="season" season="3">http://thetvdb.com/banners/seasons/71035-3-2.jpg</thumb>
<thumb aspect="poster" type="season" season="4">http://thetvdb.com/banners/seasons/12-4.jpg</thumb>
<thumb aspect="poster" type="season" season="4">http://thetvdb.com/banners/seasons/71035-4-3.jpg</thumb>
<thumb aspect="poster" type="season" season="5">http://thetvdb.com/banners/seasons/71035-5-3.jpg</thumb>
<thumb aspect="poster" type="season" season="3">http://thetvdb.com/banners/seasons/71035-3-4.jpg</thumb>
<thumb aspect="poster" type="season" season="2">http://thetvdb.com/banners/seasons/71035-2-3.jpg</thumb>
<thumb aspect="poster" type="season" season="5">http://thetvdb.com/banners/seasons/12-5.jpg</thumb>
<thumb aspect="poster" type="season" season="1">http://thetvdb.com/banners/seasons/71035-1-3.jpg</thumb>
<thumb aspect="poster" type="season" season="1">http://thetvdb.com/banners/seasons/12-1.jpg</thumb>
<thumb aspect="poster" type="season" season="1">http://thetvdb.com/banners/seasons/71035-1.jpg</thumb>
<thumb aspect="poster" type="season" season="3">http://thetvdb.com/banners/seasons/12-3.jpg</thumb>
<thumb aspect="poster" type="season" season="4">http://thetvdb.com/banners/seasons/71035-4.jpg</thumb>
<thumb aspect="poster" type="season" season="2">http://thetvdb.com/banners/seasons/71035-2.jpg</thumb>
<thumb aspect="poster" type="season" season="3">http://thetvdb.com/banners/seasons/71035-3.jpg</thumb>
<thumb aspect="poster" type="season" season="0">http://thetvdb.com/banners/seasons/71035-0.jpg</thumb>
<thumb aspect="poster" type="season" season="5">http://thetvdb.com/banners/seasons/71035-5.jpg</thumb>
<thumb aspect="poster" type="season" season="1">http://thetvdb.com/banners/seasons/71035-1-5.jpg</thumb>
<thumb aspect="poster" type="season" season="1">http://thetvdb.com/banners/seasons/71035-1-2.jpg</thumb>
<thumb aspect="poster" type="season" season="1">http://thetvdb.com/banners/seasons/71035-1-4.jpg</thumb>
<thumb aspect="poster" type="season" season="4">http://thetvdb.com/banners/seasons/71035-4-4.jpg</thumb>
<thumb aspect="poster" type="season" season="5">http://thetvdb.com/banners/seasons/71035-5-4.jpg</thumb>
<thumb aspect="poster" type="season" season="2">http://thetvdb.com/banners/seasons/71035-2-4.jpg</thumb>
<thumb aspect="poster" type="season" season="3">http://thetvdb.com/banners/seasons/71035-3-5.jpg</thumb>
<thumb aspect="banner" type="season" season="5">http://thetvdb.com/banners/seasonswide/71035-5.jpg</thumb>
<thumb aspect="banner" type="season" season="3">http://thetvdb.com/banners/seasonswide/71035-3.jpg</thumb>
<thumb aspect="banner" type="season" season="4">http://thetvdb.com/banners/seasonswide/71035-4.jpg</thumb>
<thumb aspect="banner" type="season" season="1">http://thetvdb.com/banners/seasonswide/71035-1.jpg</thumb>
<thumb aspect="banner" type="season" season="2">http://thetvdb.com/banners/seasonswide/71035-2.jpg</thumb>
<thumb aspect="poster">http://thetvdb.com/banners/posters/71035-1.jpg</thumb>
<thumb aspect="poster">http://thetvdb.com/banners/posters/71035-2.jpg</thumb>
<thumb aspect="poster">http://thetvdb.com/banners/posters/71035-5.jpg</thumb>
<thumb aspect="poster">http://thetvdb.com/banners/posters/71035-8.jpg</thumb>
<thumb aspect="poster">http://thetvdb.com/banners/posters/71035-3.jpg</thumb>
<thumb aspect="poster">http://thetvdb.com/banners/posters/71035-4.jpg</thumb>
<thumb aspect="poster" type="season" season="-1">http://thetvdb.com/banners/posters/71035-1.jpg</thumb>
<thumb aspect="poster" type="season" season="-1">http://thetvdb.com/banners/posters/71035-2.jpg</thumb>
<thumb aspect="poster" type="season" season="-1">http://thetvdb.com/banners/posters/71035-5.jpg</thumb>
<thumb aspect="poster" type="season" season="-1">http://thetvdb.com/banners/posters/71035-8.jpg</thumb>
<thumb aspect="poster" type="season" season="-1">http://thetvdb.com/banners/posters/71035-3.jpg</thumb>
<thumb aspect="poster" type="season" season="-1">http://thetvdb.com/banners/posters/71035-4.jpg</thumb>
<fanart url="http://thetvdb.com/banners/">
<thumb dim="1920x1080" colors="" preview="_cache/fanart/original/71035-6.jpg">fanart/original/71035-6.jpg</thumb>
<thumb dim="1920x1080" colors="|182,161,96|51,49,50|154,46,33|" preview="_cache/fanart/original/71035-3.jpg">fanart/original/71035-3.jpg</thumb>
<thumb dim="1920x1080" colors="" preview="_cache/fanart/original/71035-5.jpg">fanart/original/71035-5.jpg</thumb>
<thumb dim="1280x720" colors="|87,86,55|6,1,7|118,106,84|" preview="_cache/fanart/original/71035-12.jpg">fanart/original/71035-12.jpg</thumb>
<thumb dim="1920x1080" colors="|45,29,30|126,67,49|179,127,116|" preview="_cache/fanart/original/71035-4.jpg">fanart/original/71035-4.jpg</thumb>
<thumb dim="1920x1080" colors="" preview="_cache/fanart/original/71035-15.jpg">fanart/original/71035-15.jpg</thumb>
<thumb dim="1280x720" colors="" preview="_cache/fanart/original/71035-2.jpg">fanart/original/71035-2.jpg</thumb>
<thumb dim="1920x1080" colors="" preview="_cache/fanart/original/71035-10.jpg">fanart/original/71035-10.jpg</thumb>
<thumb dim="1920x1080" colors="|251,223,201|65,52,78|36,29,36|" preview="_cache/fanart/original/71035-1.jpg">fanart/original/71035-1.jpg</thumb>
<thumb dim="1920x1080" colors="" preview="_cache/fanart/original/71035-17.jpg">fanart/original/71035-17.jpg</thumb>
<thumb dim="1280x720" colors="|253,251,254|0,0,8|219,153,119|" preview="_cache/fanart/original/71035-11.jpg">fanart/original/71035-11.jpg</thumb>
<thumb dim="1280x720" colors="" preview="_cache/fanart/original/71035-9.jpg">fanart/original/71035-9.jpg</thumb>
<thumb dim="1280x720" colors="" preview="_cache/fanart/original/71035-8.jpg">fanart/original/71035-8.jpg</thumb>
<thumb dim="1280x720" colors="" preview="_cache/fanart/original/71035-13.jpg">fanart/original/71035-13.jpg</thumb>
<thumb dim="1920x1080" colors="" preview="_cache/fanart/original/71035-7.jpg">fanart/original/71035-7.jpg</thumb>
<thumb dim="1920x1080" colors="" preview="_cache/fanart/original/71035-14.jpg">fanart/original/71035-14.jpg</thumb>
<thumb dim="1920x1080" colors="" preview="_cache/fanart/original/71035-16.jpg">fanart/original/71035-16.jpg</thumb>
<thumb dim="1920x1080" colors="" preview="_cache/fanart/original/71035-19.jpg">fanart/original/71035-19.jpg</thumb>
<thumb dim="1920x1080" colors="" preview="_cache/fanart/original/71035-18.jpg">fanart/original/71035-18.jpg</thumb>
</fanart>
<mpaa>TV-PG</mpaa>
<playcount>0</playcount>
<lastplayed></lastplayed>
<file></file>
<path>E:\TV Shows-Test - Copy\Angel\</path>
<filenameandpath></filenameandpath>
<basepath>E:\TV Shows-Test - Copy\Angel\</basepath>
<episodeguide>
<url cache="71035-en.xml">http://thetvdb.com/api/439DFEBA9D3059C6/series/71035/all/en.zip</url>
</episodeguide>
<id>71035</id>
<uniqueid type="unknown" default="true">71035</uniqueid>
<genre>Action</genre>
<genre>Adventure</genre>
<genre>Comedy</genre>
<genre>Drama</genre>
<genre>Fantasy</genre>
<genre>Horror</genre>
<tag>BestTag</tag>
<premiered>1999-10-05</premiered>
<year>1999</year>
<status>Ended</status>
|
TV Episode nfo
Sample TV Episode nfo. Extract from Single File Export
TV Episode nfo file (click 'expand' to view) |
---|
<episodedetails>
<title>City of</title>
<originaltitle>TepisodeC14</originaltitle>
<showtitle>Angels</showtitle>
<ratings>
<rating name="default" max="10" default="true">
<value>7.500000</value>
<votes>29</votes>
</rating>
</ratings>
<userrating>10</userrating>
<top250>0</top250>
<season>1</season>
<episode>1</episode>
<displayseason>-1</displayseason>
<displayepisode>-1</displayepisode>
<outline></outline>
<plot>Newly arrived in Los Angeles, Angel is befriended by a half-demon named Doyle whose visions lead him to a powerful vampire whose next victim just may be Cordelia Chase.</plot>
<tagline></tagline>
<runtime>43</runtime>
<thumb>http://thetvdb.com/banners/episodes/71035/31099.jpg</thumb>
<mpaa>TV-PG</mpaa>
<playcount>0</playcount>
<lastplayed></lastplayed>
<file></file>
<path>E:\TV Shows-Test - Copy\Angel\</path>
<filenameandpath>E:\TV Shows-Test - Copy\Angel\Angel S01E01.mkv</filenameandpath>
<basepath>E:\TV Shows-Test - Copy\Angel\Angel S01E01.mkv</basepath>
<id>31099</id>
<uniqueid type="unknown" default="true">31099</uniqueid>
<genre>Action</genre>
<genre>Adventure</genre>
<genre>Comedy</genre>
<genre>Drama</genre>
<genre>Fantasy</genre>
<genre>Horror</genre>
<credits>Joss Whedon</credits>
<credits>David Greenwalt</credits>
<director>Joss Whedon</director>
<premiered>1999-10-05</premiered>
<year>1999</year>
<status></status>
|
Technical Notes
There are differences in tags used by Single File Export and Separate File Export. Though testing reveals that transposing tages between the two has no detrimental affect on the scrape.
TV Show | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
XML Tag | Exported in
Single File |
Exported in
Separate File |
Notes | |||||||||||||||||||
<file></file> | Yes | No | ||||||||||||||||||||
<path></path> | Yes | No | ||||||||||||||||||||
<filenameandpath></filenameandpath> | Yes | No | ||||||||||||||||||||
<basepath></basepath> | Yes | No | ||||||||||||||||||||
<art> <banner></banner> <fanart></fanart> <poster></poster> <season num=""></season> </art> |
Yes | No | ||||||||||||||||||||
TV Episode | ||||||||||||||||||||||
<file></file> | Yes | No | ||||||||||||||||||||
<path></path> | Yes | No | ||||||||||||||||||||
<filenameandpath></filenameandpath> | Yes | No | ||||||||||||||||||||
<basepath></basepath> | Yes | No | ||||||||||||||||||||
<actor></actor> | Yes | Yes | Separate File saves in seemingly random order. | |||||||||||||||||||
<art> <thumb></thumb> </art> |
Yes | No |
Return to top |
---|