User:Karellen/scratchpad: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 16: Line 16:


= Requirements =
= Requirements =
{|class="prettytable"
The order of importing metadata is as follows:
! XML Tag || Note
#nfo file. If no nfo file exists then
|-
#Depending on your scraper settings for your source, either
|<credits> || Library export uses this field for writers. Multiple entries allowed
##Online scraper sites- if a scraper is set in your source settings
|-
##Nothing- if Local Info Only is set
|<outline> || Should be short, will be displayed on a single line
|-
|<playcount> || setting this to 1, or greater, will mark the movie as watched if the ''importwatchedstate'' flag is set in advancedsettings.xml
|-
|<plot> || Can contain more information on multiple lines, will be wrapped
|-
|<runtime> || Minutes only
|-
|<streamdetails> || Is a parent tag. While it is possible to manually set the information contained within the "streamdetails" tag,there is little point in doing so, as the software will always overwrite this data when it plays back the video file. In other words, no matter how many times you try to manually set it, it will be undone the moment the video is played
|}


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.
<br />




Line 39: Line 34:
#If you have ''Local Info Only'' set as your scraper, then no entry will be made into the library.
#If you have ''Local Info Only'' set as your scraper, then no entry will be made into the library.


The order of importing metadata is as follows:
#nfo file. If no nfo file exists then
#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 attempt to:
#If the nfo file contains XML data (tags), Kodi will import the meta-data directly into the library from the .nfo file or
#Will parse the nfo file for a direct URL to the scraper info page.
<br />
Movies require one nfo file saved as follows:
Movies require one nfo file saved as follows:


Line 107: Line 94:


= Movie nfo Tags =
= Movie nfo Tags =
The following table lists the XML tags available for movie nfo's in Kodi. Children tags are displayed correctly with parent tags.
{|class="prettytable"
! NFO (xml) Tag || Required || Multiple || Notes
|-
|
<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
|-
|<aired></aired> || No || No || Date aired. Normally used for TV Shows
|-
| <code></code> ||  ||  || Unknown
|-
|<country></country> || No || Yes || Country of origin
|-
|<credits></credits> || No || Yes ||  Library export uses this field for writers. Supports "clear" attribute
|-
|<director></director> || No || Yes || Supports "clear" attribute
|-
|<dateadded></dateadded> || No || No || Date the file was added to library. Can be altered in advancedsettings.xml
|-
|
<fanart>
    <thumb preview=""></thumb>
</fanart>
|| No || No || Path to available movie fanart. Multible <thumb> entries allowed
|-
|
<fileinfo>
    <streamdetails>
      <video>
        <codec></codec>
        <aspect></aspect>
        <width></width>
        <height></height>
        <durationinseconds></durationinseconds>
        <stereomode></stereomode>
      </video>
      <audio>
        <codec></codec>
        <language></language>
        <channels></channels>
      </audio>
      <audio>
        <codec></codec>
        <language></language>
        <channels></channels>
      </audio>
      <audio>
        <codec></codec>
        <language></language>
        <channels></channels>
      </audio>
      <subtitle>
        <language></language>
      </subtitle>
      <subtitle>
        <language></language>
      </subtitle>
      <subtitle>
        <language></language>
      </subtitle>
    </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.
In other words, no matter how many times you try to manually set it, it will be overwritten the moment the video is played
|-
|<id></id> || No || No || IMDB Id
|-
|<genre></genre> || No || Yes || Supports "clear" attribute
|-
|<lastplayed></lastplayed> || No || No ||
|-
|<mpaa></mpaa> || No || No ||
|-
|<originaltitle></originaltitle> || No || No ||
|-
|<outline></outline> ||  ||  || Should be short, will be displayed on a single line
|-
|<playcount></playcount> ||  ||  || Setting this to 1, or greater, will mark the movie as watched if the ''importwatchedstate'' flag is set in advancedsettings.xml
|-
|<plot></plot> ||  ||  || Can contain more information on multiple lines, will be wrapped
|-
|<premiered></premiered> || No || No ||
|-
|
  <ratings>
    <rating name="default" max="10" default="true">
      <value></value>
      <votes></votes>
    </rating>
  </ratings>
|| No || No ||
|-
|
<resume>
  <position></position>
  <total></total>
</resume>
|| No || No || Movie resume point in Seconds
|-
|<runtime></runtime> || No || No || Minutes only
|-
|
<set>
    <name></name>
    <overview></overview>
</set>
|| No || No || Movie set tags
|-
|<showlink></showlink> || No || No || Connect movie to TV Show
|-
|<sorttitle></sorttitle> || No || No || Allows alternate title sort without modifying movie title. Used for Canonical Ordering of movie sets
|-
|<status></status> || No || No || Unknown
|-
|<studio></studio> || No || Yes || Supports "clear" attribute
|-
|<tag></tag> || No || Yes || Movie tags
|-
|<tagline></tagline> || No || No ||
|-
|<thumb aspect="poster" preview=""></thumb> || No || Yes || Path to Movie Posters
|-
|<title></title> || No || No ||
|-
|<top250></top250> || No || No ||
|-
|<trailer></trailer> || No || No || Path to movie trailer
|-
|<uniqueid type="unknown" default="true"></uniqueid> || No || No || IMDB rating
|-
|<userrating></userrating> || No || No ||
|-
|<year></year> || No || No ||
|}




Line 113: Line 243:
Provided below is a sample nfo file to assist with the manual creation process. It includes MovieSet XML tags
Provided below is a sample nfo file to assist with the manual creation process. It includes MovieSet XML tags


 
'''Press Expand at right edge of the green bar to view'''
Sample Movie nfo file


{{collapse top| Movie nfo file  (click 'expand' to view)}}
{{collapse top| Movie nfo file  (click 'expand' to view)}}
Line 454: Line 583:


{{collapse bottom}}
{{collapse bottom}}
{{Top}}
{{updated|17}}
[[Category:Guides]]
[[Category:First time user]]
[[Category:FAQ]]
[[Category:Manual]]
[[Category:Index]]
[[Category:Video library]]
[[Category:Quick Start Guide]]
[[Category:Advanced topics]]

Revision as of 23:08, 11 September 2017

NFO Contents

Report NFO corrections:
[https:// here in the forum]

Home icon grey.png   ▶ NFO_files ▶ scratchpad


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.
  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.



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


Movie nfo Tags

The following table lists the XML tags available for movie nfo's in Kodi. Children tags are displayed correctly with parent tags.

NFO (xml) Tag Required Multiple Notes
<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

<aired></aired> No No Date aired. Normally used for TV Shows
Unknown
<country></country> No Yes Country of origin
<credits></credits> No Yes Library export uses this field for writers. Supports "clear" attribute
<director></director> No Yes Supports "clear" attribute
<dateadded></dateadded> No No Date the file was added to library. Can be altered in advancedsettings.xml
<fanart>
    <thumb preview=""></thumb>
</fanart>
No No Path to available movie fanart. Multible <thumb> entries allowed
<fileinfo>
   <streamdetails>
     <video>
       <codec></codec>
       <aspect></aspect>
       <width></width>
       <height></height>
       <durationinseconds></durationinseconds>
       <stereomode></stereomode>
     </video>
     <audio>
       <codec></codec>
       <language></language>
       <channels></channels>
     </audio>
     <audio>
       <codec></codec>
       <language></language>
       <channels></channels>
     </audio>
     <audio>
       <codec></codec>
       <language></language>
       <channels></channels>
     </audio>
     <subtitle>
       <language></language>
     </subtitle>
     <subtitle>
       <language></language>
     </subtitle>
     <subtitle>
       <language></language>
     </subtitle>
   </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. In other words, no matter how many times you try to manually set it, it will be overwritten the moment the video is played

<id></id> No No IMDB Id
<genre></genre> No Yes Supports "clear" attribute
<lastplayed></lastplayed> No No
<mpaa></mpaa> No No
<originaltitle></originaltitle> No No
<outline></outline> Should be short, will be displayed on a single line
<playcount></playcount> Setting this to 1, or greater, will mark the movie as watched if the importwatchedstate flag is set in advancedsettings.xml
<plot></plot> Can contain more information on multiple lines, will be wrapped
<premiered></premiered> No No
 <ratings>
   <rating name="default" max="10" default="true">
      <value></value>
      <votes></votes>
   </rating>
 </ratings>
No No
<resume>
  <position></position>
  <total></total>
</resume>
No No Movie resume point in Seconds
<runtime></runtime> No No Minutes only
<set>
   <name></name>
   <overview></overview>
</set>
No No Movie set tags
<showlink></showlink> No No Connect movie to TV Show
<sorttitle></sorttitle> No No Allows alternate title sort without modifying movie title. Used for Canonical Ordering of movie sets
<status></status> No No Unknown
<studio></studio> No Yes Supports "clear" attribute
<tag></tag> No Yes Movie tags
<tagline></tagline> No No
<thumb aspect="poster" preview=""></thumb> No Yes Path to Movie Posters
<title></title> No No
<top250></top250> No No
<trailer></trailer> No No Path to movie trailer
<uniqueid type="unknown" default="true"></uniqueid> No No IMDB rating
<userrating></userrating> No No
<year></year> No No


Sample Movie nfo File

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

Press Expand at right edge of the green bar to view


Return to top