Difference between revisions of "Adding video sources"

From Official Kodi Wiki
Jump to: navigation, search
(Fix Sections)
(Updated for v18)
 
(3 intermediate revisions by 3 users not shown)
Line 4: Line 4:
  
 
= Introduction =
 
= Introduction =
<section begin="intro" />The '''Source''' is the main folder on your hard drive which contains your collection of Movies or TV Shows or Music Videos or Music. These four classes of media cannot be mixed in the one Source. Once {{Kodi}} is pointed to the Source, it can perform the appropriate actions to display your media. There is no limit to the number of Sources that can be added to {{Kodi}} for each media class.<section end="intro" />
+
<section begin="intro" />The '''Source''' is the main folder on your hard drive which contains your collection of Movies or TV Shows or Music Videos or Music. These four classes of media cannot be mixed in the one Source. Once the Sources are set up, {{Kodi}} can perform the appropriate actions to display your media. There is no limit to the number of Sources that can be added to {{Kodi}} for each media class.<section end="intro" />
  
This module of the guide will enable you to complete the following actions:
+
This step of the guide will enable you to complete the following actions:
 
#'''Adding Sources''' - Add the Source folder to {{Kodi}}
 
#'''Adding Sources''' - Add the Source folder to {{Kodi}}
 
#'''Set Media Type''' - Advise {{kodi}} what type of media is in the Source
 
#'''Set Media Type''' - Advise {{kodi}} what type of media is in the Source
Line 18: Line 18:
  
 
'''{{red|[[UPnP]] does not work with the library features of {{kodi}} (scanning data in like summaries and movie covers). It is recommended that you share your media using another protocol such as SMB}}'''
 
'''{{red|[[UPnP]] does not work with the library features of {{kodi}} (scanning data in like summaries and movie covers). It is recommended that you share your media using another protocol such as SMB}}'''
{{-}}
+
 
 +
 
 +
 
 +
= Scraper and Settings =
 +
The default scraper used by {{kodi}} for TV Shows is the '''TheMovieDB-TV Shows'''. Other scrapers are available and can be found by searching the {{kodi}} site '''''[https://kodi.tv/addons/browse?keyword=&category=1187&author=&sort=title+ASC here]'''''
 +
:'''''See: [https://www.themoviedb.org/ TheMovieDB]'''''
 +
:'''''See: [[Add-on:The_Movie_Database|TheMovieDB Add-on]]'''''
 +
 
 +
Check the settings of the scraper are configured to your preference. The default settings are usually good enough, but you may have different preferences or needs.
 +
 
 +
When checking settings, ensure you access the scraper settings from the '''[[Basic_controls#Context_Menu|Context Menu]]''' of the TV Show Source. Accessing it through the add-ons menu only adjusts the default settings, and won't adjust settings on the currently active sources.
 +
 
 +
'''Note:'''
 +
*TVDB was the default {{Kodi}} scraper until 19 November 2018 when the scraper changed to the current TheMovieDB-TV Shows scraper <ref>https://github.com/xbmc/xbmc/pull/14898</ref>. Due to a lack of communication from the TVDB, the high level of complaints on their forum, and the sudden changes to their API, it was deemed necessary to change provider to ensure a more stable user experience.
 +
*Enable the setting '''''[[Settings/Media/Videos#Show_empty_TV_shows|Show empty TV shows]]''''' in ''Settings > Media > Videos''. This will make it easier to find tv shows in your library that failed the scraping process.
 +
 
  
  
Line 28: Line 43:
 
File:Quick-start-2.1.png|'''{{big|Step 3}}:''' Select '''ADD VIDEOS...'''.<br />
 
File:Quick-start-2.1.png|'''{{big|Step 3}}:''' Select '''ADD VIDEOS...'''.<br />
 
{{note|For Android users with devices running Android 7 & up (possibly Android 6) and attached storage, do not select '''ADD VIDEOS''' as attached storage will not display in the '''Browse for new shares''' list.  Instead, select the storage which should display in '''FILES''', or navigate to the folder you wish to add on the storage,  then press {{keypress|C}} on a keyboard or long press the {{keypress|Enter/OK}} button on a remote to pull up the '''Context Menu''' and select '''SET CONTENT'''. Skip to '''Step 7'''}}  
 
{{note|For Android users with devices running Android 7 & up (possibly Android 6) and attached storage, do not select '''ADD VIDEOS''' as attached storage will not display in the '''Browse for new shares''' list.  Instead, select the storage which should display in '''FILES''', or navigate to the folder you wish to add on the storage,  then press {{keypress|C}} on a keyboard or long press the {{keypress|Enter/OK}} button on a remote to pull up the '''Context Menu''' and select '''SET CONTENT'''. Skip to '''Step 7'''}}  
File:Quick-start-3.png|'''{{big|Step 4}}:''' Select the '''BROWSE''' button from the '''ADD VIDEO SOURCE''' window.
+
File:Quick-start-3.png|'''{{big|Step 4}}:''' Select the '''BROWSE''' button from the '''ADD VIDEO SOURCE''' window.  
File:Quick-start-4.png|'''{{big|Step 5}}:''' Locate your Source folder and Enter that folder. Select '''OK''' <br />{{note|You must Enter the source/folder for the correct path to be added}}. <br />To add Network Sources, see ''Section 6- Adding Remote Sources'' below
+
File:Quick-start-4.png|'''{{big|Step 5}}:''' Browse to locate your Source folder and Enter that folder. Select '''OK''' <br>{{note|Network browsing is no longer possible with Samba v2 and upwards. Samba v1 was deprecated May 2018. To add Network Sources, see ''Section 6- Adding Remote Sources'' below}}
 
File:Quick-start-5.png|'''{{big|Step 6}}:''' Either use the default name or rename the Source. The name doesn't matter to Kodi, but keep the names unique for ease of maintenance. Then select '''OK'''.
 
File:Quick-start-5.png|'''{{big|Step 6}}:''' Either use the default name or rename the Source. The name doesn't matter to Kodi, but keep the names unique for ease of maintenance. Then select '''OK'''.
 
</gallery>
 
</gallery>
 
 
  
 
= Set Content =
 
= Set Content =
 
<gallery widths=500px heights=283px>
 
<gallery widths=500px heights=283px>
File:Quick-start-6.png|'''{{big|Step 7}}:''' The set content window will display. This is where the media type is set. Select '''This directory contains'''.
+
File:Quick-start-6.png|'''{{big|Step 7}}:''' The set content window will display. This is where the media type is set. <br>Select the option '''This directory contains'''.
File:Quick-start-6.1.png|'''{{big|Step 8}}:''' Select the type of media that is in the Source that is to be added to the library.
+
File:Quick-start-6.1.png|'''{{big|Step 8}}:''' Select the type of media that is in the Source.
 
</gallery>
 
</gallery>
  
  
  
The left image is the '''Set Content''' screen for '''Movies'''. The right image is the '''Set Content''' screen for '''TV Shows'''. Select the appropriate one, not both.
+
The left image is the '''Set Content''' screen for '''Movies'''. The right image is the '''Set Content''' screen for '''TV Shows'''. Continue these steps using the appropriate one, not both.
  
 
<gallery widths=500px heights=283px>
 
<gallery widths=500px heights=283px>
File:Quick-start-7.png|'''{{big|Step 9a}}:''' Select '''Choose information provider'''. <br />Use '''The Movie Database''' for movies (automatically selected)<br />For the remaining settings see '''Movies- Content scanning options''' below
+
File:Quick-start-7.png|'''{{big|Step 9a}}:''' '''The Movie Database''' for movies is the default scraper and is automatically selected.<br>* Select '''Choose information provider''' to install another scraper if required<br>* For the Scraper Settings, see the next section ''Movie Scraper'' <br>* For the remaining settings see '''Movies- Content scanning options''' below
File:Set content.TV shows.png|'''{{big|Step 9b}}:''' Select '''Choose information provider'''. <br />Use '''The TVDB''' for TV Shows (automatically selected)<br />For the remaining settings see '''TV Show- Content scanning options''' below
+
File:Set content.TV shows.png|'''{{big|Step 9b}}:''' '''The Movie Database''' for TV Shows is the default scraper and is automatically selected.<br>* Select '''Choose information provider''' to install another scraper if required<br>* For the Scraper Settings, see the next section ''TV Show Scraper'' <br>* For the remaining settings see '''TV Show- Content scanning options''' below
 
</gallery>
 
</gallery>
  
Line 54: Line 67:
 
:'''Movies are in separate folders that match the movie title'''
 
:'''Movies are in separate folders that match the movie title'''
 
::*If '''Enabled''' {{Kodi}} will use the '''folder''' name to scrape the movie
 
::*If '''Enabled''' {{Kodi}} will use the '''folder''' name to scrape the movie
 +
:::*Kodi will [[NFO files/Movies#nfo Placement| load NFO files]] from NFO files named '''movie.nfo''', but will fallback to ''<videofilename>.nfo'' as required
 +
:::*Kodi will load artwork files using the short format ''<artworktype>.jpg/png'' filenames, but will fallback to the longer ''<NameOfVideoFile>-<artworktype>.jpg/png'' format as required.
 
::*If '''Disabled''' {{kodi}} will use the '''filename''' to scrape the movie
 
::*If '''Disabled''' {{kodi}} will use the '''filename''' to scrape the movie
 +
:::*NFO files must be named the long format ''<MovieFileName>.nfo'' filename.
 +
:::*Artwork files must be named using the long format ''<NameOfVideoFile>-<artworktype>.jpg/png'' filenames.
  
 
:'''Scan Recursively'''
 
:'''Scan Recursively'''
Line 60: Line 77:
  
 
:'''Selected folder contains a single video'''
 
:'''Selected folder contains a single video'''
::Normally greyed out unless you have selected a single movie folder within an existing source. It allows you to change the Content settings for a particular movie without affecting the entire Source
+
::Normally greyed out unless you have selected a single movie folder within an existing source. Disabled when a Source is selected. Becomes Enabled when a Movie folder is selected.
  
 
:'''Exclude path from library updates'''
 
:'''Exclude path from library updates'''
::Prevents the Source from being scanned when an Update Library is running
+
::Prevents the Source from being scanned when an Update Library is running. When '''Enabled''' it will speed up the Update Library process in large libraries if the Source no longer has content added to it.
  
  
 
;{{big|TV Show- Content scanning options}}
 
;{{big|TV Show- Content scanning options}}
 
:'''Selected folder contains a single TV show'''
 
:'''Selected folder contains a single TV show'''
::Allows you to change the Content settings for a particular TV Show without affecting the entire Source
+
::Allows you to change the Content settings for a particular TV Show without affecting the entire Source. Disabled when a Source is selected. Becomes Enabled when a TV Show folder is selected.
 
:'''Exclude path from library updates'''
 
:'''Exclude path from library updates'''
::Prevents the Source from being scanned when an Update Library is running
+
::Prevents the Source from being scanned when an Update Library is running. When '''Enabled''' it will speed up the Update Library process in large libraries if the Source no longer has content added to it.
  
  
Alternate scrapers are available, and can be installed using the '''''Get More''''' button from the '''''Choose information provider''''' screen in Step 9 (not pictured). Only change the default scraper if you have a particular reason to.
+
Alternate scrapers are available, and can be installed using the '''''Get More''''' button from the '''''Choose information provider''''' option shown in Step 9. Only change the default scraper if you have a particular reason to.
  
  
Line 88: Line 105:
  
 
== TV Show Scraper ==
 
== TV Show Scraper ==
{{see also|Add-on:The_TVDB}}
+
{{see also|Add-on:The MovieDB}}
  
  
 
From Step 9b above select '''Settings''' to access the settings page for the scraper
 
From Step 9b above select '''Settings''' to access the settings page for the scraper
{{#lst:Add-on:The_TVDB|Scraper settings}}
+
{{#lst:Add-on:The MovieDB|TMDB-TVShow Settings}}
  
 
Press OK to accept the changes. The screen in '''Step 10''' will be offered
 
Press OK to accept the changes. The screen in '''Step 10''' will be offered
 
 
  
 
= Add to Library =
 
= Add to Library =
Line 109: Line 124:
  
  
<center>'''{{big|{{green|At this point, you should now have a fully functioning video library. Repeat the steps on this page to add the remainder of your media.}}}}</center>
+
<center>'''{{big|{{green|At this point, you should now have a fully functioning video library. Repeat the steps on this page to add the remainder of your media.}}}}'''</center>
  
  
 
----
 
----
'''{{big|{{red|The remainder of this page deals with Special Use cases and can be safely ignored.}}}}'''
+
'''<center>{{big|{{red|The remainder of this page deals with Special Use cases and can be safely ignored.}}}}</center>'''
 
----
 
----
  
Line 136: Line 151:
  
 
<gallery widths=500px heights=283px >
 
<gallery widths=500px heights=283px >
File:Add-Network-Location.png | Select '''Add network location...''' from the '''Browse for new shares'''' list.  
+
File:Add-Network-Location.png |Image 1- Select '''Add network location...''' from the '''Browse for new shares'''' list.  
File:Add-Network-Location_2.png|In the new window select the correct '''Protocol''' for your '''Network Share''', then select '''Server Name'''.
+
File:Add-Network-Location_2.png|Image 2- In the new window select the correct '''Protocol''' for your '''Network Share''', then select '''Server Name'''.
File:Add-Network-Location_3.png|Type in either the '''IP Address''' or the '''Device name''' of your server. {{note| if you use a dynamic IP for your NAS you could lose access to your shares if the IP changes.  It is recommended that you use a static IP if adding your share this way.}}
+
File:Add-Network-Location_3.png|Image 3- Type in either the '''IP Address''' or the '''Device name''' of your server. <br>{{note| if you use a dynamic IP for your NAS you could lose access to your shares if the IP changes.  It is recommended that you use a static IP if adding your share this way.}}
File:Add-Network-Location_4.png|In the '''Share folder''' section, type in the name of the folder you wish to add. Then if your share requires a '''Username''' and '''Password''' enter them in the appropriate sections. Then select '''OK''' and your share should appear in the '''Browse for new share''' list.
+
File:Add-Network-Location_4.png|Image 4- <br> '''4.1''' In the '''Shared folder''' section, type in the name of the folder you wish to add. You will be required to add the drive letter ''eg f/Movies''.<br>'''4.2''' If your share requires a '''Username''' and '''Password''' enter them in the appropriate sections.<br>'''4.4''' Select '''OK''' and your share should appear in the '''Browse for new share''' list shown in image 1
 
</gallery>
 
</gallery>
  
Line 151: Line 166:
 
Kodi will also combine the subfolders within the source/locations. For example, if you had a hard drive for TV shows, but ran out of space, you could make a second hard drive with the same folder paths and Kodi would merge them together to a single directory path. Such as
 
Kodi will also combine the subfolders within the source/locations. For example, if you had a hard drive for TV shows, but ran out of space, you could make a second hard drive with the same folder paths and Kodi would merge them together to a single directory path. Such as
  
:<code>Hard drive 1/TV shows/<br />
+
:<code>Hard drive 1/TV shows/</code>
:Hard drive 2/TV shows/</code>
+
:<code>Hard drive 2/TV shows/</code>
  
 
and the same is true for an additional nested folder with the same way:
 
and the same is true for an additional nested folder with the same way:
  
:<code>Hard drive 1/TV shows/American Dad/<br />
+
:<code>Hard drive 1/TV shows/American Dad/</code>
:Hard drive 2/TV shows/American Dad/</code>
+
:<code>Hard drive 2/TV shows/American Dad/</code>
  
 
You could have half of a show on one hard drive, half on another, and Kodi will show it to you as if it was in a single location by using multiple locations in a single source.
 
You could have half of a show on one hard drive, half on another, and Kodi will show it to you as if it was in a single location by using multiple locations in a single source.
Line 171: Line 186:
  
  
 +
 +
= References =
 +
<references />
  
  
Line 178: Line 196:
 
<div style="{{linear-gradient|left|#a1f5e4, #f5f5a1}}">{{next|[[Incorrect_and_missing_videos|'''Scraping Problems''']]}} </div>
 
<div style="{{linear-gradient|left|#a1f5e4, #f5f5a1}}">{{next|[[Incorrect_and_missing_videos|'''Scraping Problems''']]}} </div>
  
{{updated|17}}
+
{{updated|18}}
 
[[Category:FAQ]]
 
[[Category:FAQ]]
 
[[Category:Index]]
 
[[Category:Index]]

Latest revision as of 03:24, 18 April 2019

Steps to create your Video Library
Video.png
1. Video Guide Main Page
2. Naming & Folder Structure
2.1 Movies
2.2 TV Shows
3. Video File Tagging
4. Add Sources & Scrape
5. Scraping Problems

6. Update Video Library
7. Library Management
8. NFO Files
8.1 Movie
8.2 TV Show
9. Artwork
9.1 Movie
9.1 TV Show


10. Import Export Library
11. Rebuild your Video Library
Zappy-frodo.png
Home icon grey.png   ▶ Video library ▶ Adding video sources


1 Introduction

The Source is the main folder on your hard drive which contains your collection of Movies or TV Shows or Music Videos or Music. These four classes of media cannot be mixed in the one Source. Once the Sources are set up, Kodi can perform the appropriate actions to display your media. There is no limit to the number of Sources that can be added to Kodi for each media class.

This step of the guide will enable you to complete the following actions:

  1. Adding Sources - Add the Source folder to Kodi
  2. Set Media Type - Advise Kodi what type of media is in the Source
  3. Scraper Settings - Advise Kodi which Information Provider (Scraper) to use and adjust the settings to your preferences
  4. Add to Library - Scrape (import) the media into the library

Each section is a direct continuation of the previous section, and only separated for clarity. Although the page looks complex, it is not. It is possible to perform the steps on this page in less than one minute once familiar with the process.


If you have come directly to this page without following the guide and are unsure of how to set up your Sources on your computer/NAS, skip back to Naming Video Files at the start of the guide.

UPnP does not work with the library features of Kodi (scanning data in like summaries and movie covers). It is recommended that you share your media using another protocol such as SMB


2 Scraper and Settings

The default scraper used by Kodi for TV Shows is the TheMovieDB-TV Shows. Other scrapers are available and can be found by searching the Kodi site here

See: TheMovieDB
See: TheMovieDB Add-on

Check the settings of the scraper are configured to your preference. The default settings are usually good enough, but you may have different preferences or needs.

When checking settings, ensure you access the scraper settings from the Context Menu of the TV Show Source. Accessing it through the add-ons menu only adjusts the default settings, and won't adjust settings on the currently active sources.

Note:

  • TVDB was the default Kodi scraper until 19 November 2018 when the scraper changed to the current TheMovieDB-TV Shows scraper [1]. Due to a lack of communication from the TVDB, the high level of complaints on their forum, and the sudden changes to their API, it was deemed necessary to change provider to ensure a more stable user experience.
  • Enable the setting Show empty TV shows in Settings > Media > Videos. This will make it easier to find tv shows in your library that failed the scraping process.



3 Adding Sources

4 Set Content


The left image is the Set Content screen for Movies. The right image is the Set Content screen for TV Shows. Continue these steps using the appropriate one, not both.


Movies- Content scanning options
Movies are in separate folders that match the movie title
  • If Enabled Kodi will use the folder name to scrape the movie
  • Kodi will load NFO files from NFO files named movie.nfo, but will fallback to <videofilename>.nfo as required
  • Kodi will load artwork files using the short format <artworktype>.jpg/png filenames, but will fallback to the longer <NameOfVideoFile>-<artworktype>.jpg/png format as required.
  • If Disabled Kodi will use the filename to scrape the movie
  • NFO files must be named the long format <MovieFileName>.nfo filename.
  • Artwork files must be named using the long format <NameOfVideoFile>-<artworktype>.jpg/png filenames.
Scan Recursively
Used for deep folder structures such as when additional Genre or Movie Set folders are used. Will allow the video scanner to search deeper to find the playable file
Selected folder contains a single video
Normally greyed out unless you have selected a single movie folder within an existing source. Disabled when a Source is selected. Becomes Enabled when a Movie folder is selected.
Exclude path from library updates
Prevents the Source from being scanned when an Update Library is running. When Enabled it will speed up the Update Library process in large libraries if the Source no longer has content added to it.


TV Show- Content scanning options
Selected folder contains a single TV show
Allows you to change the Content settings for a particular TV Show without affecting the entire Source. Disabled when a Source is selected. Becomes Enabled when a TV Show folder is selected.
Exclude path from library updates
Prevents the Source from being scanned when an Update Library is running. When Enabled it will speed up the Update Library process in large libraries if the Source no longer has content added to it.


Alternate scrapers are available, and can be installed using the Get More button from the Choose information provider option shown in Step 9. Only change the default scraper if you have a particular reason to.


4.1 Movie Scraper


From Step 9a above select Settings to access the settings page for the scraper

Keep original title
Use the original (untranslated) title when downloading info for a foreign film.
For example the movie Crouching Tiger, Hidden Dragon (2000) is the English translated title of the movie. The Original Name of the movie is 卧虎藏龙. If you prefer the English translated title, then disable the setting. If you prefer the original Chinese title then enable the setting.
Enable fanart
Enable this setting to download Fanart.
Enable trailer (YouTube)
Downloads the link to a movie trailer at YouTube. If you have local trailers, ensure this setting is disabled.
Preferred language
Language to use for summaries and other metadata.
Preferred Certification Country
Country/Nation preference for Content Advisory Ratings- eg M, MA, PG
Default Rating from
Choose site to download movie ratings from. Choices are TMDB and IMDB. If IMDB is selected, it becomes the default rating. TheMovieDB rating is still scraped.
Add also IMDB ratings
Only visible if the previous setting is set to TMDB. Allows scraping of ratings from both sources, but keeps TheMovieDB rating as the default rating.

Press OK to accept the changes. The screen in Step 10 will be offered


4.2 TV Show Scraper


From Step 9b above select Settings to access the settings page for the scraper

Keep original title
Use the original (untranslated) title when downloading info for a TV Show
For example the movie Crouching Tiger, Hidden Dragon (2000) is the English translated title of the movie. The Original Name of the movie is 卧虎藏龙. If you want the English translated title, then disable the setting. If you want the original Chinese title then enable the setting.
Get Artwork from themoviedb.org
Enable this setting to download Poster, Fanart and episode Thumbs Artwork
Get Extra Artwork from fanart.tv
Enable this setting to download other Artwork types such as Banner, Clearart, Clearlogo, Discart, Landscape for the TV Show and Seasons
Preferred language
Language to use for summaries and other metadata.


Press OK to accept the changes. The screen in Step 10 will be offered

5 Add to Library


Once you press Yes, Kodi will scan your library and attempt to match each title in your library to the title at the site of the Information Provider. If a match is found, the metadata and artwork is downloaded and used for the library display. Depending upon the size of your library, this could take some time. A single movie could take approx 30 seconds, a library of 400 movies could take over an hour.

When the scraping process is complete, be sure to check the Event Log to view any titles that were not added to the library, which is normally due to incorrect naming. See... Scraping Problems


At this point, you should now have a fully functioning video library. Repeat the steps on this page to add the remainder of your media.



The remainder of this page deals with Special Use cases and can be safely ignored.

Return to top


6 Adding Remote sources

For details on the supported protocols and configuration

See: File sharing

Follow the steps (above) for adding a source, but when you get to the 'browse' section (step 4 & 5), you need to do one of the following:

If your remote device is visible from one of the existing choices (e.g 'Network File system' , 'UPnP Devices' etc)

  • Select a remote location, and you should be able to browse to the remote server.

If the device is not visible, or

  • It is a remote NAS
  • It is an SMB server

You will need to add a new network location:


7 Making one source from multiple locations

Multi locations in one source.png

You might notice that Kodi has an "ADD" button in addition to a "BROWSE" button when you are adding a source. After you add your first location, you can add a second location (network or local. you can even mix them) and Kodi will show both folders as a single folder/source.

Kodi will also combine the subfolders within the source/locations. For example, if you had a hard drive for TV shows, but ran out of space, you could make a second hard drive with the same folder paths and Kodi would merge them together to a single directory path. Such as

Hard drive 1/TV shows/
Hard drive 2/TV shows/

and the same is true for an additional nested folder with the same way:

Hard drive 1/TV shows/American Dad/
Hard drive 2/TV shows/American Dad/

You could have half of a show on one hard drive, half on another, and Kodi will show it to you as if it was in a single location by using multiple locations in a single source.


Note: This only impacts the basic "Files view". The default Library nodes will combine things by show even if their files are spread across multiple drives. Most users will not really benefit from using multiple paths in a single source.


8 Password protected sources

See: Media sources#Locking


9 References


Return to top


Next step: Scraping Problems