Knowledge Base/Troubleshooting FAQ & Other

Creating an NFO file

marcel hass
posted this on March 29, 2011 04:26 AM

Please note that NFO files will only work with Boxee version.1.1.0.18xxx and above (Settings > System)

NFO files can be used to provide data for a video file in Boxee. In particular they are helpful if the information fetched from a web site does not match the video file or data for that particular file does not exist such as home movies or media that can not be located in IMDB or TVDB.

The NFO files are based on an XML structure, different for each media content.
NFO file will be implemented into the library on an automatic scan. If you manually identify a movie it will take first the folder.jpg if available otherwise it will take the relevant information from IMDB/TVDB.

Movie NFO files:

Movie NFO is used to describe movies, it can contain only your data or a mix between your added data and information from IMDB, depends on the use of the tags.
The use of the movie.nfo depends on your file structure. If you keep all your movies in one folder then the NFO should be name exactly as the movie, for example: 
avatar.mkv = avatar.nfo

If you are using separate folders for each movie then you can name the NFO file as movie.nfo, Boxee will know to take it from the folder, for example: 

Folder Avatar - avatar.mkv - movie.nfo 

Example of a Movie NFO file: 

<movie>
 <title>Avatar</title>
 <rating>8.2</rating>
 <year>2009</year>
 <outline>A paraplegic marine dispatched to the moon Pandora on a unique mission becomes torn between following his orders and protecting the world he feels is his home.</outline>
 <runtime>162min</runtime>    
<thumb>http://ia.media-imdb.com/images/M/MV5BMTYwOTEwNjAzMl5BMl5BanBnXkFtZ... </thumb>
 <mpaa>PG-13</mpaa>
 <id>tt0499549</id>
 <genre>ACTION</genre>
 <director>James Cameron</director>
 <actor>
     <name>Paul Begala</name>
     <role>Himself</role>
 </actor>
 <actor>
     <name>John Kerry</name>
     <role>Himself</role>
 </actor>
</movie>

Explanation about structure and tags: 

This list contains the important tags in the NFO file, not all of them are mandatory, please read about the tags before implementing them: 

<movie></movie> - Mandatory tag, required to identify the NFO as a movie NFO.
<title></title> - Not a mandatory tag, contains the name of the movie, if you leave this tag blank you must specify the id tag or the movie won’t get resolved.
<thumb></thumb> - Contains the thumbnail location for the NFO. Can be a URL OR a local file. It doesn’t matter if you decided to use local thumbnail or from the web you will need to add the full path for it (absolute path). 
URL example: http://ia.media-imdb.com/images/M/MV5BMTYwOTEwNjAzMl5BMl5BanBnXkFtZ...
Absolute path: smb://drobo/shows/game of thrones.jpg
<mpaa></mpaa> - Provided in order to limit the content. If you check the “hide adult feed” Only Adult content can be blocked if you check the “hide adult feeds and applications”option under the settings -> parental control and add this tag with one of the supported descriptors, the movie won’t appear in the library.
<id></id> - If you set an IMDB ID (for example tt0499549) then it will get the details from the IMDB page, if you remove the tag or leave it blank (<id></id>) it will use only the details in the NFO itself.
<genre></genre> - Can contain only the supported descriptors, designed to identify the movie genre. See list below for supported descriptors.  

The genres tag can include only the supported descriptors, they should be separated be space and comma. “,”.

Genre List: ACTION, ADVENTURE, ANIMATION, COMEDY, CRIME, DOCUMENTARY, DRAMA, FAMILY, FANTASY, FILM_NOIR, HISTORY, MUSIC, MUSICAL, MYSTERY, NEWS, ROMANCE, SCI_FI, SHORT, SPORT, THRILLER, WAR, WESTERN

MPAA list: The descriptors we support are:  "x", "nc17" and "nc-17" tags.

Note: Please note that the <genre></genre> tag needs to be in capital letters.


NFO for TV Shows / Episodes: 

The TVshow NFO is used to describe a series, not specific episodes. In order to describe a specific episode you will use the episode.nfo. 

tvshow nfo; 

The TV show NFO is used to describe a series, not a specific episode. You need to place it in the root folder of the series, for example: 


There should be only one tvshow.nfo. If there are several, Boxee will take the one closest to the root folder.


* It’s highly recommended that there will be only one tvshow.nfo per series. 

tvshow.nfo example: 

<tvshow>
<title>MythBusters</title>
<plot>So exactly how hard is it to find a needle in a haystack, anyway? And can water dripping on your forehead really drive you nuts? Those are the kinds of questions, myths and urban legends that are put to the test in this humorous series to find out which ones hold water (and keep it from dripping on your forehead and driving you insane).</plot>
<thumb>http://thetvdb.com/banners/graphical/73388-g3.jpg </thumb>
<id>73388</id>
<genre>REALITY</genre>
<actor>
    <name>Robert Lee</name>
    <role>USA Narrator</role>
    <thumb></thumb>
</actor>
<actor>
    <name>Adam Savage</name>
    <role></role>
    <thumb></thumb>
</actor>
</tvshow>

Explanation about structure and tags: 

<tvshow></tvshow> - Mandatory tag,  required to identify the NFO as a TV show NFO.
<title></title> - Not a mandatory tag. Contains the name of the TV show. If you leave this tag blank you must specify the id tag or it won’t get resolved.
<thumb></thumb> - Contains the thumbnail location for the NFO. Can be a URL OR a local file. It doesn’t matter if you decided to use local thumbnail or from he web you will need to add the full path for it (absolute path). 
URL example:http://ia.media-imdb.com/images/M/MV5BMTYwOTEwNjAzMl5BMl5BanBnXkFtZ...
Absolute path: smb://drobo/shows/game of thrones.jpg
<id></id> - Not a mandatory tag unless you didn’t specify a title tag, supports only TVDB tags in the form of URLs or just the number.
If you add this tag Boxee will complete the missing information from TVDB. If you didn’t state a title tag you must add a TVDB tag.  
<genre></genre> - Not a mandatory tag, multiple tags need to be separated with a comma “, see supported genres list in the end.
<mpaa></mpaa> - Provided in order to limit the content. If you check the “hide adult feed” Only Adult content can be blocked if you check the “hide adult feeds and applications” option under the settings -> parental control and add this tag with one of the supported descriptors, the movie won’t appear in the library.
* Please note that if you use ID the content won’t be filtered by the tags retrieved from our database.

Notes for tvshow:
* The id is the number from TVDB e.g http://thetvdb.com/banners/graphical/73388-g3.jpg or <id>73388</id>
* When creating an NFO file for a TV show, it must be named as “tvshow.nfo” (exact), and it must be located in the root directory of the TV Show.
* You can now add the MPAA tag with the same descriptors ("x", "nc17" and "nc-17") in order to limit the content of the show. Note that if you use the TVDB rating it will not work, only with the descriptors from above.

Genre List: ACTION, ADVENTURE, ANIMATION, COMEDY, CRIME, DOCUMENTARY, DRAMA, FAMILY, FANTASY, GAME_SHOW, HISTORY, HORROR, MUSIC, MUSICAL, MYSTERY, NEWS, REALITY_TV, ROMANCE, SCI_FI, SHORT, SPORT, TALK_SHOW, THRILLER, WAR, WESTERN
Note: please note that the <genre></genre> tag needs to be in capital letters.


Episode NFO:

The *.nfo must be named exactly as the episode file name (i.e. episodename.avi and episodename.nfo) and in the same folder, allowing multiple episode and *.nfo files within the same folder. Episode names must still follow the naming conventions even though you are using a custom NFO file.  

Episode NFO example:

<episodedetails>
 <title>My TV Episode</title>
    <id>73886</id>
 <rating>10.00</rating>
 <season>2</season>
 <episode>1</episode>
 <plot>the best episode in the world</plot>
 <runtime>21 min</runtime>
 <aired>2000-12-31</aired>
</episodedetails>


episode nfo example: 

<episodedetails></episodedetails> -  Mandatory tag, required to identify the NFO as a episode  NFO.
<title></title> - Not a mandatory tag, name of the TV episode you  must  add a id tag if in the tvshow nfo in order for the episode to be recognized. 

General Notes for NFO:

* The file format should be UTF-8 (In order to support languages that are not English).
* If you didn’t add certain tags and added the ID tag, Boxee will auto-complete the missing information. 
* Please note the folder structure, if you are using multiple files in the same root folder you need to  name the NFOs exactly as the media itself.
* DVD rips: When creating a NFO file for a DVD rip you need to place it in the video_ts folder.
* Bluray - When creating an NFO file for Blurry you need to place it in the root folder.
* For costume cover art please review the article about Costume cover Art
* Forum thread containing NFO creators and more guides: http://forums.boxee.tv/showthread.php?t=37197 
* More information about NFO click here

 
Topic is closed for comments