Difference between revisions of "NFO files"

From Official Kodi Wiki
Jump to: navigation, search
(Updated for v18)
(Various updates and fixes)
Line 104: Line 104:
  
 
= Creating nfo =
 
= Creating nfo =
The following are the three methods that may be used to create nfo files for Kodi. The simplest method is using a Media Manager.
+
The following are the three methods that may be used to create nfo files for Kodi.
 
 
 
 
== Media Managers ==
 
The Media Manager can create nfo files in one of three ways:
 
#Scraping- This is the same process as performed by the Kodi scraper. The Media Manager will fetch metadata from the online scraper site and will create the nfo file which then needs to be scanned into the library, unlike Kodi that imports the metadata directly into the library.
 
#Manual- The Media Manager offers an interface that allows you to manually type in the data.
 
#Combination- A combination of both methods can be used. If you are not satisfied with the scraped metadata, then you are able to modify it.
 
 
 
 
 
The following is a list of Media Managers on the forum. Questions regarding their use should be directed to the media manager developers.
 
*[https://forum.kodi.tv/forumdisplay.php?fid=195  Ember Media Manager]
 
*[https://forum.kodi.tv/showthread.php?tid=142723  Tiny Media Manager aka TMM]
 
*[https://forum.kodi.tv/showthread.php?tid=129134  Media Companion 3]
 
*[https://forum.kodi.tv/showthread.php?tid=136333  MediaElch]
 
 
 
Be aware there are many other media managers available that claim to be Kodi compatible but have not been updated in many years, and are clearly not compatible. Use of these incompatible media managers can break your library and require rebuilding using the {{kodi}} scrapers.
 
 
 
 
 
{{red|'''Note''': While Media Managers offer some level of control for the more demanding user, there are limitations with their use. {{Kodi}} is in a constant state of development which may causes changes to nfo files to allow new types of data or features into the library. No media manager is 100% Kodi compatible. Media Managers are known to be slow in catching up to changes and, in many instances, these changes are never incorporated.}}
 
 
 
'''{{red|Kodi can create correct and accurate NFO's from the data already in the library which has been populated by a correct scraping process. See the next section for further details.}}'''
 
  
  
Line 164: Line 143:
  
 
Once created, the file must be saved with the ''.nfo'' extension in accordance with the details in the relevant sub-pages.
 
Once created, the file must be saved with the ''.nfo'' extension in accordance with the details in the relevant sub-pages.
 +
 +
 +
 +
== Media Managers ==
 +
The Media Manager can create nfo files in one of three ways:
 +
#Scraping- This is the same process as performed by the Kodi scraper. The Media Manager will fetch metadata from the online scraper site and will create the nfo file which then needs to be scanned into the library, unlike Kodi that imports the metadata directly into the library.
 +
#Manual- The Media Manager offers an interface that allows you to manually type in the data.
 +
#Combination- A combination of both methods can be used. If you are not satisfied with the scraped metadata, then you are able to modify it.
 +
 +
 +
The following is a list of Media Managers on the forum. Questions regarding their use should be directed to the media manager developers.
 +
*[https://forum.kodi.tv/forumdisplay.php?fid=195  Ember Media Manager]
 +
*[https://forum.kodi.tv/showthread.php?tid=142723  Tiny Media Manager aka TMM]
 +
*[https://forum.kodi.tv/showthread.php?tid=129134  Media Companion 3]
 +
*[https://forum.kodi.tv/showthread.php?tid=136333  MediaElch]
 +
 +
Be aware there are many other media managers available that claim to be Kodi compatible but have not been updated in many years, and are clearly not compatible. Use of these incompatible media managers can break your library and require rebuilding using the {{kodi}} scrapers.
 +
 +
 +
{{red|'''Note''': While Media Managers offer some level of control, there are limitations with their use. {{Kodi}} is in a constant state of development. Changes to allow new types of data or features into the library must be expected. Media Managers are known to be slow in catching up to these changes and, in many instances, these changes are never incorporated. No media manager is 100% Kodi compatible.}}
 +
 +
'''{{red|Kodi can create correct and accurate NFO's from the data already in the library which has been populated by a correct scraping process.}}'''
  
  
  
 
= Scanning nfo files =
 
= Scanning nfo files =
There is no special procedure to scrape nfo files. Performing the usual '''''[[Updating_or_removing_videos|Library Update]]''''', or selecting '''''[[Updating_or_removing_videos#Refresh_Library|Refresh]]''''' for individual items, will scrape the nfo files into the library.  
+
There is no special procedure to scrape nfo files. Performing the usual '''''[[Updating_or_removing_videos|Library Update]]''''', or selecting '''''[[Updating_or_removing_videos#Refresh_Library|Refresh]]''''' for individual items, will scan the nfo files into the library.  
  
 
Be aware that nfo files are not easily interchangeable between Movies, TV Shows, Music Videos, Artists and Albums. Although they all share common tags, each also has its own specific tags that won't be recognised in other parts of the library.  
 
Be aware that nfo files are not easily interchangeable between Movies, TV Shows, Music Videos, Artists and Albums. Although they all share common tags, each also has its own specific tags that won't be recognised in other parts of the library.  

Revision as of 23:09, 18 August 2019

NFO Contents

See also:


Return to:

Home icon grey.png   ▶ Video library
▶ Music library
▶ NFO files


NFO files are used to populate the music and video library using locally stored information. They are helpful if data for your particular title does not exist, such as for home movies and sporting events. They can also be used to control the search behaviour of scrapers when problematic and ambiguous titles prevent your preferred title from being fetched.


1 What is nfo

nfo is a contraction of Info or Information. It is a Filename Extension - mymovie.nfo and the contents of the file are written in XML. The file itself does nothing except hold information. It is basically a text document with special tags inserted around the information. These tags are recognised by Kodi which enables data importing.

Kodi uses nfo files as one way of importing metadata into the library. It is also be used as a method of exporting the library for various reasons, including backup. See: Import & Export

Kodi uses Artwork, and Extended Information to display your media. This information includes Actors, Directors, Plots, Taglines, Ratings, Run Times and more. All this data, known as metadata, is stored in the Kodi Library. The Library is stored in an SQLite database.

There are two primary methods to load metadata into your library:

  1. Use the online scraper
  2. Create a nfo file, from which Kodi is able to import the metadata

For information on how to use the online scraper within Kodi:

See: Adding Music to Library
See: Adding Video Sources

The remainder of this wiki topic will provide the required information to create and use nfo files.


2 Types of nfo

Kodi can use the nfo file in one of three ways depending on the contents of the nfo file, as explained in the following sub-sections.


2.1 Metadata nfo

This is the most common use of the nfo file. The Metadata nfo contains the metadata for the movie/tv show/music video/album/artist within the file. Kodi will scan this file and import its contents into the library.

For more details on creating and using the common Metadata NFO file, see the following sections...

2.1.1 Movie nfo

See: Movie nfo

2.1.2 TV Show nfo

See: TV Show nfo

2.1.3 Music nfo

See: Music nfo

2.1.4 Music Video nfo

See: Music Videos nfo


2.2 Parsing nfo

A Parsing nfo does not contain any metadata that Kodi can use to import into the library. Instead it contains the URL to the the information at the site of the information provider.

As an example, searching for The Mummy on TMDB returns 65 titles. If you are attempting to add one of the more obscure versions to your library, chances are that Kodi will scrape the incorrect title. The Parsing nfo offers an easy solution to this problem by pointing Kodi to the correct title.

Note: Most online Movie and TV Show databases include an IMDB field that contains the IMDB ID. This allows the use of the IMDB address in the Parsing NFO for Movies and TV Shows. This does NOT mean the title will be scraped from IMDB. The scraper simply recognises the ttxxxxx ID and uses it to search for the title at the online database of the currently active scraper. If your preference is for IMDB data, then you will need to install the appropriate scraper.


To create and use the parsing nfo, follow these steps:

  1. Locate the title at the appropriate site of the information provider, eg TheMovieDB
  2. Ensure you have correctly named your media files/folder. See: Kodi naming conventions
  3. Open a text file and copy the entire URL address of the movie from the address bar and paste it into the text file. No tags or code is required. See example below
  4. Save the file and ensure it is correctly named. See the nfo sub-pages listed above for correct naming. Ensure the extension is *.nfo and not *.nfo.txt or *.nfo.doc
  5. Run an Update Library or a Scan item to library. Kodi will parse the URL and locate the title and scrape the correct metadata.


Example of Parsing Movie NFO :

https://www.themoviedb.org/movie/15849-the-mummy

Note: Parsing NFO files cannot be used for episodes


2.3 Combination nfo

It is possible to combine the above two types of nfo files into one nfo file. An example use would be to override data from the scraper site such as the title, runtime, movieset etc. It will scan the metadata located between the <movie></movie> XML tags and the omitted data will be scraped at the provided URL. An example:

Note: Cannot be used for Episode nfo files


Example: Contents of Combination NFO file:

 <movie>
    <title>Star Wars (99 second cut)</title>
    <runtime>2</runtime>
    <set>Star Wars Saga</set>
    <sorttitle>Star Wars 01</sorttitle>
    <genre clear="true">SciFi</genre>
    <genre>Romance</genre>
    <genre>Action</genre>
 </movie>
 http://www.imdb.com/title/tt0076759/


Various tags allow multiple entries, eg multiple <genre> and <director> tags. If you use these tags in a Combination nfo, these tags will have their data added to the scraped entry in the database and, in some cases, may result in duplicate entries. To avoid this, use the clear attribute to clear out the downloaded metadata for those particular tags. See the <genre> tag in the above example.

A listing of which tags allow multiple entries can be found in the appropriate sub-pages. Does not apply to muic.


3 Creating nfo

The following are the three methods that may be used to create nfo files for Kodi.


3.1 Kodi Created nfo

This option requires that your library has already been scraped with metadata. Using the built in Import & Export function of Kodi, you can export the library metadata into individual nfo files which are correctly created and saved. This is useful if you have an existing library and would like to backup the library or to import the library into another Kodi installation.

See: Import & Export


3.2 Manual Creation

NFO files are simple text files containing XML tags. Creating your own nfo files is simple, and templates and examples are provided in the sub-pages of this wiki topic. They can be created using a simple text editor such as Notepad in Windows, or the equivelant in other operating systems. There are dedicated code editors that can also be used. They will not provide the required Kodi tags, but they will avoid glitches when saving the nfo file, which is commonly experienced with text editors.

Two common code editors that can be used:


Structure of the nfo file:

1. The file must be saved as Unicode Transformation Format-8 (UTF-8). The first line of the file will contain the following...

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>


2. The second line and the last line of the file contains the nfo category opening and closing tags. Avaliable category tags are...

<movie></movie>, <tvshow></tvshow>, <episodedetails></episodedetails>, <artist></artist>, <album></album> and <musicvideo></musicvideo>


3. Between the opening and closing category tags are the tags for the media metadata. Each tag must have an opening tag and a closing tag. eg...

<title>Blade Runner 2049</title>

<title> = opening tag 
Blade Runner 2049 = metadata 
</title> = closing tag

4. Available tags are listed in the relevant sub-pages along with a sample and template nfo file.

Once created, the file must be saved with the .nfo extension in accordance with the details in the relevant sub-pages.


3.3 Media Managers

The Media Manager can create nfo files in one of three ways:

  1. Scraping- This is the same process as performed by the Kodi scraper. The Media Manager will fetch metadata from the online scraper site and will create the nfo file which then needs to be scanned into the library, unlike Kodi that imports the metadata directly into the library.
  2. Manual- The Media Manager offers an interface that allows you to manually type in the data.
  3. Combination- A combination of both methods can be used. If you are not satisfied with the scraped metadata, then you are able to modify it.


The following is a list of Media Managers on the forum. Questions regarding their use should be directed to the media manager developers.

Be aware there are many other media managers available that claim to be Kodi compatible but have not been updated in many years, and are clearly not compatible. Use of these incompatible media managers can break your library and require rebuilding using the Kodi scrapers.


Note: While Media Managers offer some level of control, there are limitations with their use. Kodi is in a constant state of development. Changes to allow new types of data or features into the library must be expected. Media Managers are known to be slow in catching up to these changes and, in many instances, these changes are never incorporated. No media manager is 100% Kodi compatible.

Kodi can create correct and accurate NFO's from the data already in the library which has been populated by a correct scraping process.


4 Scanning nfo files

There is no special procedure to scrape nfo files. Performing the usual Library Update, or selecting Refresh for individual items, will scan the nfo files into the library.

Be aware that nfo files are not easily interchangeable between Movies, TV Shows, Music Videos, Artists and Albums. Although they all share common tags, each also has its own specific tags that won't be recognised in other parts of the library.

After the NFO files are scanned into the library, they are no longer used and only serves as a backup. If you make changes to the NFO file you will need to Refresh that library entry for the changes to be loaded into Kodi. An Update Library will not capture the change as this only looks for new items.


5 Troubleshooting

If you have followed the guidelines of this wiki topic, and the NFO File still does not scan into the library, then check the following:

  1. Ensure your NFO File is encoded correctly. The NFO File must be encoded as a UTF-8 type file. ANSI, has also been known to work.
  2. Check the setting Movies are in separate folders that match the movie title in the scraper settings is correctly set for your folder structure.
  3. If TV Shows are being mixed, this is most likely caused by using outdated or incorrectly created NFO Files. Ensure at least one of the following tags is in the tvshow.nfo file. If there are no ID's at the scraper site (eg home movies) then any random alpha-numeric entry will suffice.
   <uniqueid type="" default="true"></uniqueid>
 
   <!-- Where type="" contains the identifier for the ID. eg imdb, tvdb, tmdb, or other as chosen by the user. eg type="home" for home movies -->


6 References




Return to top