NFO files/Movies: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(Add metacritic)
No edit summary
Line 169: Line 169:
|<basepath></basepath> || No || No || Not used on Import. Exported in Single File Export only
|<basepath></basepath> || No || No || Not used on Import. Exported in Single File Export only
|-
|-
|<id></id> || No || No || IMDB Id
|<id></id> || No || No || The default ID. See next item. This is a Kodi generated tag from the next item.
|-
|-
|<uniqueid type="unknown" default="true"></uniqueid> || No || No || IMDB Id
|<uniqueid type="xxxx" default="true"></uniqueid> || Yes || Yes || Unique Id. The ID from the scraper site, and normally IMDB ID is set as default.
''xxxx'' = Identifier of the ID eg IMDB, TMDB. For non-scraped items, use a simple values like "home", "sport", "doco" etc<br>
''true'' = This will be set as the default ID. Multiple ID's are allowed<br>
The value can be alpha-numeric. Typical entries ''tt3480556'' for imdb, ''286668'' for tmdb, ''home001'' for home movies etc
|-
|-
|<genre clear="true"></genre> || No || Yes || Supports "clear" attribute
|<genre clear="true"></genre> || No || Yes || Supports "clear" attribute
Line 191: Line 194:
|<director clear="true"></director> || No || Yes || Supports "clear" attribute
|<director clear="true"></director> || No || Yes || Supports "clear" attribute
|-
|-
|<premiered></premiered> || No || No || Date when the movie was premiered. Most likely it's the same year as in the <year>-tag and therefore used for importing.
|<premiered></premiered> || No || No || Release date. Format as ''2019-01-31''
|-
|-
|<year></year> || No || No || Year of the movie. Used at exporting the library but not used while importing it.<br />
|<year></year> || No || No || Replaced by <premiered> tag, but exists for compatibility with older versions. Use <premiered> instead<br />
The date displayed in Kodi comes from the <premiered> tag.
|-
|-
|<status></status> || No || No || Unknown
|<status></status> || No || No || Unknown

Revision as of 22:29, 5 February 2019

NFO Contents
Home icon grey.png   ▶ NFO_files ▶ Movies


Requirements

The order of importing metadata is as follows:

  1. nfo file. If no nfo file exists then
  2. Depending on your scraper settings for your source, either
    1. Online scraper sites- if a scraper is set in your source settings
    2. Nothing- if Local Info Only is set

When Kodi locates the nfo file it will load the *.nfo file and:

  1. If the file is a metadata nfo, Kodi will import the meta-data directly into the library from the .nfo file or
  2. 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. See: Parsing NFO
  3. 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. See: Combination NFO



Known Issues

Bookmarks have no XML tags and cannot be exported or imported.
<year></year> is exported but not used on import

The following tags are available, but not used in Movies

  • <status></status>
  • <aired></aired>


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:

  1. Scrape the metadata from the online source set in your scraper or,
  2. If you have Local Info Only set as your scraper, then no entry will be made into the library.


Movies require one nfo file saved as follows:

Naming & Saving conventions for your Movie *.nfo files:

Saved movies as File Name Save Location
BluRay Structure:
index.nfo
f:\MyMovies\Big Buck Bunny (2008)\BDMV\index.nfo
DVD Structure:
VIDEO_TS.nfo
f:\MyMovies\Big Buck Bunny (2008)\VIDEO_TS\VIDEO_TS.nfo
Single movie in directory: <MovieFileName>.nfo f:\MyMovies\Big Buck Bunny (2008)\Big Buck Bunny (2008).nfo
or:
movie.nfo
f:\MyMovies\Big Buck Bunny (2008)\movie.nfo
All movies in single directory:
<MovieFileName>.nfo
f:\MyMovies\Big Buck Bunny (2008)\Big Buck Bunny (2008).nfo
Multi-part / file stacking: <MovieFileName>.nfo f:\MyMovies\Avatar (2009)\Avatar (2009).nfo
or:
<MovieFileName> <StackExt>.nfo
f:\MyMovies\Avatar (2009)\Avatar (2009) cd1.nfo

Note: Use of the movie.nfo requires enabling the option Movies are in separate folders that match the movie title See: Set Content


Movie nfo Tags

The only required tag is indicated below in the table. 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.

The following table lists the XML tags available for movie nfo's in Kodi. Children tags are displayed correctly with parent tags. The list is ordered in the same manner as it should be ordered in the nfo file.

See also: Databases
NFO (xml) Tag Required Multiple Notes
<movie></movie> 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 The title for the movie
<originaltitle></originaltitle> No No Displays the original title of the movie. For example, if the scraper is set to german language and the scraped movie in german is "Der mit dem Wolf tanzt" the original title will be "Dances with Wolves"
<sorttitle></sorttitle> No No Allows alternate title sort without modifying movie title.
 <ratings>
   <rating name="" max="10" default="">
      <value></value>
      <votes></votes>
   </rating>
 </ratings>
No No Examples...

<rating name="imdb" max="10">
<rating name="metacritic" max="10">
<rating name="themoviedb" max="10" default="true">

<userrating></userrating> No No Personal rating set by the user
<top250></top250> No No IMDB rating of Top 250. Can be used in Smart playlists
<outline></outline> Should be short, will be displayed on a single line
<plot></plot> Can contain more information on multiple lines, will be wrapped
<tagline></tagline> No No Short movie slogan. "The true story of a real fake" is the tagline for "Catch me if you can
<runtime></runtime> No No Minutes only. Overwritten when movie played
<thumb aspect="poster" preview=""></thumb> No Yes Path to Movie Posters
<fanart>
    <thumb preview=""></thumb>
</fanart>
No No Path to available movie fanart. Multiple <thumb> entries allowed
<mpaa></mpaa> No No mpaa rating system. See: MPAA film ratings
<playcount></playcount> Setting this to 1, or greater, will mark the movie as watched if the importwatchedstate flag is set in advancedsettings.xml
<lastplayed></lastplayed> No No Date movie was last played
<file></file> No No Not Used. Exported in Single File Export only
<path></path> No No Not used on Import. Exported in Single File Export only
<filenameandpath></filenameandpath> No No Not used on Import. Exported in Single File Export only
<basepath></basepath> No No Not used on Import. Exported in Single File Export only
<id></id> No No The default ID. See next item. This is a Kodi generated tag from the next item.
<uniqueid type="xxxx" default="true"></uniqueid> Yes Yes Unique Id. The ID from the scraper site, and normally IMDB ID is set as default.

xxxx = Identifier of the ID eg IMDB, TMDB. For non-scraped items, use a simple values like "home", "sport", "doco" etc
true = This will be set as the default ID. Multiple ID's are allowed
The value can be alpha-numeric. Typical entries tt3480556 for imdb, 286668 for tmdb, home001 for home movies etc

<genre clear="true"></genre> No Yes Supports "clear" attribute
<country></country> No Yes Country of origin
<set>
   <name></name>
   <overview></overview>
</set>
No No Movie set tags

The <overview> tag allows a short summary of the movie set. It can be displayed by some skins.

<tag></tag> No Yes Movie tags
<credits clear="true"></credits> No Yes Library export uses this field for writers. Supports "clear" attribute
<director clear="true"></director> No Yes Supports "clear" attribute
<premiered></premiered> No No Release date. Format as 2019-01-31
<year></year> No No Replaced by <premiered> tag, but exists for compatibility with older versions. Use <premiered> instead
<status></status> No No Unknown
Unknown
<aired></aired> No No Date aired. Normally used for TV Shows
<studio clear="true"></studio> No Yes Supports "clear" attribute
<trailer></trailer> No No Path to movie trailer
<fileinfo>
   <streamdetails>
     <video>
       <codec></codec>
       <aspect></aspect>
       <width></width>
       <height></height>
       <durationinseconds></durationinseconds>
       <stereomode></stereomode>
     </video>
     <audio>
       <codec></codec>
       <language></language>
       <channels></channels>
     </audio>
     <subtitle>
       <language></language>
     </subtitle>
   </streamdetails>
</fileinfo>
No Yes Multiple entries of <audio> and <subtitles> accepted

Not used on Import.

<actor clear="true">
  <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

<showlink></showlink> No No Connect movie to TV Show
<resume>
  <position></position>
  <total></total>
</resume>
No No Movie resume point in Seconds
<dateadded></dateadded> No No Date the file was added to library. Not used on Import. Can be altered in advancedsettings.xml
<art>
  <fanart></fanart>
  <poster></poster>
</art>
No No Art in use. Exported in Single File Export only


Sample Movie nfo File

Provided below is a sample nfo file to assist with the manual creation process. It includes MovieSet XML tags and TV Show links.

Press Expand at right edge of the green bar to view


Technical Notes

There are differences in tags used by Single File Export and Separate File Export. Though testing reveals that transposing tags between the two has no detrimental affect on the scrape.

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>
  <fanart></fanart>
  <poster></poster>
</art>
Yes No


Return to top