NFO files/TV shows: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
(Updated for v19)
(29 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{NFO_content}}
{{mininav|[[NFO files]]}}
{{mininav|[[NFO files]]}}


{{note|This page describes the NFO file format for the over-all TV show entry. For individual episode NFO files see '''[[NFO files/TV episodes]]'''.}}
__TOC__
 
 
= Introduction =
NFO files for TV Shows are a little bit more complex as they require the following NFO files:
* One nfo file for the TV Show. This file holds the overall TV show information
* One nfo file for '''each''' Episode. This file holds information specific to that episode
For one TV Show with 10 episodes, 11 nfo files are required.
 


__TOC__


=== Video .nfo Files containing XML data ===
= episodeguide URL =
1. The *.nfo file is an XML file containing the data for inclusion in the library.
The <episodeguide> is the tag that allows the scrapers to find the episodes belonging to the TV Show at the site of the information provider. It is a complex item and its format depends on which information provider is being accessed, and whether a Python or XML based scraper is being used.
 
It is not normal to manually create a tvshow.nfo that require an <episodeguide>. If the TV show and episodes exist at the site of an information provider, then you should use the {{kodi}} scrapers to scrape the TV show and episodes
 
If you find that you need to create nfo files, then it is assumed that the tv show does not exist at any of the information provider sites, so the <episodeguide> URL does not exist either and the tag is not needed.
 
 
 
= nfo Name and Location =
'''{{resize|1.2em|Regardless of what settings you have set for the source and scraper, {{Kodi}} will always search for and scan the nfo file first where available.}}'''
 
The tvshow.nfo file is placed inside the TV Show folder. The NFO filename is actually '''tvshow.nfo'''. Do not rename it with the title of the tv show. See image for example
 
<gallery mode="packed" widths="1000px" heights="562px">
File:LocalTVShowArtwork01.jpg|'''''Location of tvshow.nfo along with artwork'''''
</gallery>
 
 
 
= nfo Tags =
The following table lists available XML tags for TV Shows. <ref>https://github.com/xbmc/xbmc/blob/master/xbmc/video/VideoInfoTag.cpp</ref>
 
Two XML tags are required and are indicated in the table below. All other tags are optional. Of course the less tags used, the less information scanned into the library.
 
 
{|class="prettytable"
! 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> || {{Yes}} || No || The title of the TV Show
|-
|<originaltitle></originaltitle> || No || No || The original title, usually in the language of the country of origin.
|-
|<showtitle></showtitle> || No || No || Not in common use, but some skins may display an alternate title
|-
|<sorttitle></sorttitle> || No || No || Allows alternate title sort without modifying the TV Show title. Not displayed in any library listing.
|-
|
  <ratings>
    <rating name="" max="10" default="">
      <value></value>
      <votes></votes>
    </rating>
  </ratings>
|| No || No || ''default="true"''  ''default="false"''<br>
::Only one rating can be set as ''default="true"'', additional ratings must be set as ''default="false"'' or ommitted<br>
 
''name="identifier"''. Do not use "default". Examples of identifier include...<br>
::''<rating name="imdb" max="10">''<br>
::''<rating name="trakt" max="10">''<br>
::''<rating name="tvmaze" max="10">''<br>
::''<rating name="metacritic" max="10">''<br>
::''<rating name="tomatometerallcritics" max="10">''<br>
::''<rating name="tomatometerallaudience" max="10">''<br>
 
Example of complete entry...
::''<rating name="themoviedb" max="10" default="true">''<br>
::''<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">''<br>
|-
|<userrating></userrating> || No || No || Personal rating set by the user
|-
|<top250></top250> || No || No || Ranking in IMDB Top 250
|-
|<season></season> || No || No ||Number of seasons of this TV Show in the library
|-
|<episode></episode> || No || No || Number of episodes of this TV Show in the library
|-
|<displayepisode></displayepisode> || No || No || Not used
|-
|<displayseason></displayseason> || No || No || Not used
|-
|<outline></outline> || No || No || Not Used
|-
|<plot></plot> || No || No || Can contain more information on multiple lines, will be wrapped
|-
|<tagline></tagline> || No || No || Short TV Show slogan
|-
|<runtime></runtime> || No || No || Not used
|-
|<thumb aspect="" preview=""></thumb>
<thumb aspect="poster" type="season" season="" preview=""></thumb>
|| No || Yes || Path to available TV Show Posters. Not needed when using local artwork<br>
Example use of ''aspect=""''
:<thumb aspect="banner"
:<thumb aspect="clearart"
:<thumb aspect="clearlogo"
:<thumb aspect="landscape"
:<thumb aspect="poster"<br>
''type="season"'' used for season specific artwork<br>
''season="2"'' nominates season number eg. season 2
|-
|
<fanart>
    <thumb preview=""></thumb>
</fanart>
|| No || Yes^ || Path to available TV Show fanart.<br>
:^ Multiple <thumb> entries allowed between the <fanart></fanart> tags
|-
|<mpaa></mpaa> || No || No || Country specific mpaa rating system. Check with skin author which prefix is required to diplay your country local rating system
|-
|<playcount></playcount> || No || No || Number of times TV show has been played. Will only ever show 0 or 1. Episodes track playcounts<br>See... [[Import-export_library/Video#Watched.2C_PlayCount.2C_ResumePoints|Import-Export]]
|-
|<lastplayed></lastplayed> || No || No || Date TV Show was last played
|-
|
<episodeguide>
  <url cache=""></url>
</episodeguide>
|| Yes/No || No || Read section ''1.1 episodeguide URL'' above<br>
When using TVDB scraper, Kodi will only read the URL created by the TVDB v2 API <ref>https://forum.kodi.tv/showthread.php?tid=323588</ref><br>
When a URL is used, the corresponding scraper must be set.
|-
|<id></id> || No || No || The default ID. <br>
Do not use as this is a Kodi generated tag. See next item.
|-
|<uniqueid type="" default=""></uniqueid> || {{Yes}} || Yes ||The ID from the scraper site.<br>
''type=""'' Identifier of the ID. Do not use "default". Examples of identifier include...<br>
::''<uniqueid type="imdb"''<br>
::''<uniqueid type="tvdb"''<br>
::''<uniqueid type="tmdb"''<br>
::For non-scraped items, use simple values like ''"home", "sport", "doco"'' etc<br>
::The value can be alpha-numeric eg ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies, etc<br>
''default="true"''  ''default="false"''<br>
::Only one uniqueID can be set as ''default="true"'', additional uniqueID's must be set as ''default="false"'' or ommit the default attribute<br>
Example of complete entry...
::''<uniqueid type="tmdb" default="true">''<br>
::''<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">''<br>
|-
|<genre></genre> || No || Yes || Genre
|-
|<tag></tag> || No || Yes || Tags. See: ''[[Video library tags]]''
|-
|<premiered></premiered> || No || No || Release date of TV Show. Comes from Aired Date of the first episode.<br>
Format as ''2019-01-31''
|-
|<year></year> || No || No || Release Year.<br>
Do not use. Use <premiered> instead
|-
|<status></status> || No || No || Continuing or Ended show
|-
| <code><code></code></code> || No || No || Not used
|-
|<aired></aired> || No || No || Not used
|-
|<studio></studio> || No || Yes || Production studio
|-
|<trailer></trailer> || No || No || Local or online 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
|-
| <namedseason number=""></namedseason> || No || Yes || Allows naming of Seasons- eg Game of Thrones named seasons<br>
''number=""'' = Season number to be renamed
|-
|
<resume>
  <position></position>
  <total></total>
</resume>
|| No || No || Not used for TV Show
|-
|<dateadded></dateadded> || No || No || mTime of the playable video file. Can be altered in advancedsettings.xml<br>See... '''[[Advancedsettings.xml#videolibrary]]'''
|}
 


The filename of the NFO should be <code>tvshow.nfo</code> (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 <code><episodeguideurl></code> to allow online updates. If not, only episodes with .nfo files will be added.


<syntaxhighlight lang="xml" enclose="div">
= References =
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<references />
<tvshow>
    <title>House</title>
    <showtitle>House</showtitle>
    <rating>9.200000</rating>
    <votes>42</votes>
    <epbookmark>0.000000</epbookmark>
    <year>0</year>
    <top250>0</top250>
    <season>-1</season>
    <episode>176</episode>
    <uniqueid></uniqueid>
    <displayseason>-1</displayseason>
    <displayepisode>-1</displayepisode>
    <outline></outline>
    <plot>Go deeper into the medical mysteries of House, TV&apos;s most compelling drama. Hugh Laurie stars as the brilliant but sarcastic Dr. Gregory House, a maverick physician who is devoid of bedside manner. While his behavior can border on antisocial, Dr. House thrives on the challenge of solving the medical puzzles that other doctors give up on. Together with his hand-picked team of young medical experts, he&apos;ll do whatever it takes in the race against the clock to solve the case.</plot>
    <tagline></tagline>
    <runtime>0</runtime>
    <mpaa>TV-14</mpaa>
    <playcount>0</playcount>
    <lastplayed>1969-12-31</lastplayed>
    <episodeguide>
        <url cache="73255.xml">http://www.thetvdb.com/api/1D62F2F90030C444/series/73255/all/en.zip</url>
    </episodeguide>
    <id>73255</id>
    <genre>Comedy</genre>
    <genre>Drama</genre>
    <set></set>
    <premiered>2004-11-16</premiered>
    <status></status>
    <code></code>
    <aired>1969-12-31</aired>
    <studio>FOX</studio>
    <trailer></trailer>
    <actor>
        <name>Hugh Laurie</name>
        <role>Dr. Gregory House</role>
        <thumb>http://thetvdb.com/banners/actors/23839.jpg</thumb>
    </actor>
    <actor>
        <name>Robert Sean Leonard</name>
        <role>Dr. James Wilson</role>
        <thumb>http://thetvdb.com/banners/actors/23842.jpg</thumb>
    </actor>
    <resume>
        <position>0.000000</position>
        <total>0.000000</total>
    </resume>
    <dateadded>2013-01-28 23:33:03</dateadded>
</tvshow>
</syntaxhighlight>


=== Video .nfo files containing a URL ===
2. The *.nfo file contains a URL of the information page to scrape.
The file can include other information (i.e. scene info), Kodi 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 directory 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 files 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 an .nfo for that movie with the OFDB link in it and you are sorted!




Filename should be <code>tvshow.nfo</code> (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>


{{Updated|15}}
{{top}}
{{updated|19}}


[[Category:Scraper]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:Video library]]
[[Category:Manual]]

Revision as of 00:12, 23 April 2021

NFO Contents

NFO Main Page


See also:


Return to:

Home icon grey.png   ▶ NFO files ▶ TV shows


Introduction

NFO files for TV Shows are a little bit more complex as they require the following NFO files:

  • One nfo file for the TV Show. This file holds the overall TV show information
  • One nfo file for each Episode. This file holds information specific to that episode

For one TV Show with 10 episodes, 11 nfo files are required.


episodeguide URL

The <episodeguide> is the tag that allows the scrapers to find the episodes belonging to the TV Show at the site of the information provider. It is a complex item and its format depends on which information provider is being accessed, and whether a Python or XML based scraper is being used.

It is not normal to manually create a tvshow.nfo that require an <episodeguide>. If the TV show and episodes exist at the site of an information provider, then you should use the Kodi scrapers to scrape the TV show and episodes

If you find that you need to create nfo files, then it is assumed that the tv show does not exist at any of the information provider sites, so the <episodeguide> URL does not exist either and the tag is not needed.


nfo Name and Location

Regardless of what settings you have set for the source and scraper, Kodi will always search for and scan the nfo file first where available.

The tvshow.nfo file is placed inside the TV Show folder. The NFO filename is actually tvshow.nfo. Do not rename it with the title of the tv show. See image for example


nfo Tags

The following table lists available XML tags for TV Shows. [1]

Two XML tags are required and are indicated in the table below. All other tags are optional. Of course the less tags used, the less information scanned into the library.


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> Yes No The title of the TV Show
<originaltitle></originaltitle> No No The original title, usually in the language of the country of origin.
<showtitle></showtitle> No No Not in common use, but some skins may display an alternate title
<sorttitle></sorttitle> No No Allows alternate title sort without modifying the TV Show title. Not displayed in any library listing.
 <ratings>
   <rating name="" max="10" default="">
      <value></value>
      <votes></votes>
   </rating>
 </ratings>
No No default="true" default="false"
Only one rating can be set as default="true", additional ratings must be set as default="false" or ommitted

name="identifier". Do not use "default". Examples of identifier include...

<rating name="imdb" max="10">
<rating name="trakt" max="10">
<rating name="tvmaze" max="10">
<rating name="metacritic" max="10">
<rating name="tomatometerallcritics" max="10">
<rating name="tomatometerallaudience" max="10">

Example of complete entry...

<rating name="themoviedb" max="10" default="true">
<rating name="imdb" max="10" default="false"> or <rating name="themoviedb" max="10">
<userrating></userrating> No No Personal rating set by the user
<top250></top250> No No Ranking in IMDB Top 250
<season></season> No No Number of seasons of this TV Show in the library
<episode></episode> No No Number of episodes of this TV Show in the library
<displayepisode></displayepisode> No No Not used
<displayseason></displayseason> No No Not used
<outline></outline> No No Not Used
<plot></plot> No No Can contain more information on multiple lines, will be wrapped
<tagline></tagline> No No Short TV Show slogan
<runtime></runtime> No No Not used
<thumb aspect="" preview=""></thumb>

<thumb aspect="poster" type="season" season="" preview=""></thumb>

No Yes Path to available TV Show Posters. Not needed when using local artwork

Example use of aspect=""

<thumb aspect="banner"
<thumb aspect="clearart"
<thumb aspect="clearlogo"
<thumb aspect="landscape"
<thumb aspect="poster"

type="season" used for season specific artwork
season="2" nominates season number eg. season 2

<fanart>
    <thumb preview=""></thumb>
</fanart>
No Yes^ Path to available TV Show fanart.
^ Multiple <thumb> entries allowed between the <fanart></fanart> tags
<mpaa></mpaa> No No Country specific mpaa rating system. Check with skin author which prefix is required to diplay your country local rating system
<playcount></playcount> No No Number of times TV show has been played. Will only ever show 0 or 1. Episodes track playcounts
See... Import-Export
<lastplayed></lastplayed> No No Date TV Show was last played
<episodeguide>
  <url cache=""></url>
</episodeguide>
Yes/No No Read section 1.1 episodeguide URL above

When using TVDB scraper, Kodi will only read the URL created by the TVDB v2 API [2]
When a URL is used, the corresponding scraper must be set.

<id></id> No No The default ID.

Do not use as this is a Kodi generated tag. See next item.

<uniqueid type="" default=""></uniqueid> Yes Yes The ID from the scraper site.

type="" Identifier of the ID. Do not use "default". Examples of identifier include...

<uniqueid type="imdb"
<uniqueid type="tvdb"
<uniqueid type="tmdb"
For non-scraped items, use simple values like "home", "sport", "doco" etc
The value can be alpha-numeric eg tt3480556 for imdb, 286668 for tmdb, home001 for home movies, etc

default="true" default="false"

Only one uniqueID can be set as default="true", additional uniqueID's must be set as default="false" or ommit the default attribute

Example of complete entry...

<uniqueid type="tmdb" default="true">
<uniqueid type="imdb" default="false"> or <uniqueid type="imdb">
<genre></genre> No Yes Genre
<tag></tag> No Yes Tags. See: Video library tags
<premiered></premiered> No No Release date of TV Show. Comes from Aired Date of the first episode.

Format as 2019-01-31

<year></year> No No Release Year.

Do not use. Use <premiered> instead

<status></status> No No Continuing or Ended show
No No Not used
<aired></aired> No No Not used
<studio></studio> No Yes Production studio
<trailer></trailer> No No Local or online 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

<namedseason number=""></namedseason> No Yes Allows naming of Seasons- eg Game of Thrones named seasons

number="" = Season number to be renamed

<resume>
  <position></position>
  <total></total>
</resume>
No No Not used for TV Show
<dateadded></dateadded> No No mTime of the playable video file. Can be altered in advancedsettings.xml
See... Advancedsettings.xml#videolibrary


References



Return to top