Adding video sources: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
(Page rewritten)
Line 1: Line 1:
{{VideoLibraryCreate}}
{{VideoLibraryCreate}}
{{mininav|[[Video library]]}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}




= 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 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 step 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}}
#'''Add Sources''' - Add the Source folder to {{Kodi}}
#'''Set Media Type''' - Advise {{kodi}} what type of media is in the Source
#'''Set Content''' - Advise {{kodi}} what type of media is in the Source
#'''Scraper Settings''' - Advise {{Kodi}} which Information Provider (Scraper) to use and adjust the settings to your preferences
#'''Scraper Settings''' - Adjust the scraper settings to your preferences, or change to a different scraper
#'''Add to Library''' - Scrape (import) the media into the library
#'''Add to Library''' - Scrape 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.
 
 
'''{{red|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.}}'''


'''{{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}}'''
Each section is a direct continuation of the previous section, and only separated for clarity.  


'''{{red|[[UPnP]] cannot be used to create a library. 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.
<section begin="adding video" />
= Adding Sources =
= Adding Sources =
<gallery widths=500px heights=283px>
<gallery mode="packed" widths="500px" heights="283px">
File:Quick-start-1.png|'''{{big|Step 1}}:''' Select '''VIDEOS''' in the home screen menu. <br />(Or select ''Enter files section'' if that button is visible)
File:Quick-start-1.png|'''{{big|Step 1}}:''' Select '''VIDEOS''' in the home screen menu. <br />(Or select ''Enter files section'' if that button is visible)
File:Quick-start-2.png|'''{{big|Step 2}}:''' Select '''FILES'''
File:Quick-start-2.png|'''{{big|Step 2}}:''' Select '''FILES'''
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'''}}
File:Quick-start-3.png|'''{{big|Step 4}}:''' Select the '''BROWSE'''
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}}:''' Browse to locate your Source folder. Enter the Source folder so you see your titles. Select '''OK'''
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 mode="packed" widths="600px" heights="337px">
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-6a.jpg|'''{{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.
File:Quick-start-6.1.png|'''{{big|Step 8}}:''' Select the type of media that is in the Source.
</gallery>
</gallery>




{|
! style="width: 45%;" | {{resize|1.4em|Set Content screen for Movies}}
! style="width: 10%;" |
! style="width: 45%;" | {{resize|1.4em|Set Content screen for TV Shows}}
|-
| style="width: 45%; text-align:center;" | [[File:Set-content-Movies.jpg|600px]]<br>'''{{big|Step 9a}}:'''<br>'''Choose information provider'''- used to change scraper if required<br>'''-Settings'''- adjust scraper settings to your requirements<br>Default movie scraper settings are explained '''[[Add-on:The_Movie_Database_Python|here]]'''<br><br>
| style="width: 10%;" |
| style="width: 45%; text-align:center;" | [[File:Set-content-TV-Shows.jpg|600px]]<br>'''{{big|Step 9b}}''' <br>'''Choose information provider'''- used to change scraper if required<br>'''-Settings'''- adjust scraper settings to your requirements<br>Default TV show scraper settings are explained '''[[Add-on:TMDb_TV_Shows|here]]'''<br><br>
|-
| || ||
|-
| style="width: 40%;" | <center>'''{{big|Movies- Content scanning options}}'''</center><br>
'''Movies are in separate folders that match the movie title'''
:If your movies are in Movie folders, '''Enable''' this setting
:*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
::*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.


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


<gallery widths=500px heights=283px>
'''Selected folder contains a single video'''
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
:Available only when you have selected '''''Change content''''' from the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' on a Movie folder, instead of the Source folder. Allows you to adjust scraper settings for a particular movie which is different to the rest of the Source.
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>


{{warning|Do '''not''' select ''Local information only'' Scraper. Using this scraper will prevent your TV Shows from being scanned into the library when using NFO files. {{kodi}} always scans for, and uses NFO files first, regardless of what scraper is set.}}
'''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.


;{{big|Movies- Content scanning options}} {{Anchor|SeparateFolders}}
'''Skip filename matching for external audio tracks'''
:'''Movies are in separate folders that match the movie title'''
: When enabled Kodi skips name checks of external audio files in the folder and returns '''all''' found audio tracks to the player for the video. <ref>https://github.com/xbmc/xbmc/pull/16273</ref>
::*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
:::*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'''
| style="width: 10%;" |
::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
| style="width: 45%; text-align:left; vertical-align:top;"  | <center>'''{{big|TV Show- Content scanning options}}'''</center><br>


:'''Selected folder contains a single video'''
'''Selected folder contains a single TV show'''
::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.
: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. When '''Enabled''' it will speed up the Update Library process in large libraries if the Source no longer has content added to it.
: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.


'''Skip filename matching for external audio tracks'''
: When enabled Kodi skips name checks of external audio files in the folder and returns '''all''' found audio tracks to the player for the video. <ref>https://github.com/xbmc/xbmc/pull/16273</ref>
|}


;{{big|TV Show- Content scanning options}}
{{warning|Do '''not''' select ''Local information only'' Scraper. Using this scraper will prevent your TV Shows from being scanned into the library when using NFO files. {{kodi}} always scans for, and uses NFO files first, regardless of what scraper is set.}}
:'''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.
 
 
 
== Movie Scraper ==
{{see also|Add-on:The_Movie_Database}}


Additional scrapers are available. Before replacing the default scraper, ensure the scraper works for your version of {{kodi}} and is suitable for your needs.
: All Movie scrapers- '''[[:Category:Movie scraper add-ons|Movie scraper add-ons]]'''
: All TV Show scrapers - '''[[:Category:TV scraper add-ons|TV scraper add-ons]]'''


From Step 9a above select '''Settings''' to access the settings page for the scraper
{{#lst:Add-on:The_Movie_Database|Scraper settings}}
Press OK to accept the changes. The screen in '''Step 10''' will be offered


== TV Show Scraper ==
{{see also|Add-on:The_Movie_Database}}
From Step 9b above select '''Settings''' to access the settings page for the scraper
{{#lst:Add-on:The_Movie_Database|TMDB-TVShow Settings}}
Press OK to accept the changes. The screen in '''Step 10''' will be offered


= Add to Library =
= Add to Library =
<gallery widths=500px heights=283px>
<gallery mode="packed" widths="600px" heights="337px">
File:Quick-start-8.png|'''{{big|Step 10}}:''' Press '''Yes''' to scrape the content to the library <br />(if '''No''' is pressed, it can be scanned later via the Source Context Menu).
File:Quick-start-8.png|'''{{big|Step 10}}:''' Press '''Yes''' to scrape the content to the library <br />If '''No''' is selected, it can be scanned later from the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' of the Source
</gallery>
</gallery>
<section end="adding video" />
<section end="adding video" />
Line 125: Line 98:




<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 Sources.}}}}'''</center>




----
'''<center>{{big|{{red|The remainder of this page deals with Special Use cases and can be safely ignored.}}}}</center>'''
----


{{top}}
<references />
 
 
= Adding Remote sources =
To add a Source folder located on a NAS or another PC, we recommend using '''[[SMB]]'''.
 
Other network sharing protocols can be found here... {{See|File sharing}}
 
 
 
= Making one source from multiple locations =
[[File:Multi locations in one source.png|right|500px]]
 
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
 
:<code>Hard drive 1/TV shows/</code>
:<code>Hard drive 2/TV shows/</code>
 
and the same is true for an additional nested folder with the same way:
 
:<code>Hard drive 1/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.
 
{{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.'''}}
{{-}}






= Password protected sources =
{{See|Media sources#Locking}}


 
<center>
 
{| style="border: 1px solid black;"
= References =
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Mergefrom.gif|60px|link=Naming_video_files/Episodes]]
<references />
| style="width:200px; text-align:center;" | '''Previous step'''
|-
| style="width:200px; text-align:center;" | '''[[Naming_video_files/Episodes|Episodes Setup]]'''
|}</center>






{{top}}
{{top}}
{{updated|19}}


<div style="{{linear-gradient|left|#a1f5e4, #f5f5a1}}">{{next|[[Incorrect_and_missing_videos|'''Scraping Problems''']]}} </div>
{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:How-to]]
[[Category:Guides]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:Video library]]
[[Category:General topics]]
[[Category:First time user]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

Revision as of 02:08, 30 January 2021

Create Video Libraries
1. The Basics
2. Source Folder
3. Movie Setup
4a. TV Show Setup
4b. Seasons Setup
4c. Episodes Setup
5. Music Videos Setup
6. Add Source & Scrape
7. Scraping Problems
Home icon grey.png   ▶ Video library ▶ Create Video Library ▶ Adding video sources


Introduction

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

  1. Add Sources - Add the Source folder to Kodi
  2. Set Content - Advise Kodi what type of media is in the Source
  3. Scraper Settings - Adjust the scraper settings to your preferences, or change to a different scraper
  4. Add to Library - Scrape the media into the library

Each section is a direct continuation of the previous section, and only separated for clarity.

UPnP cannot be used to create a library. It is recommended that you share your media using another protocol such as SMB


Adding Sources

  • Step 1: Select VIDEOS in the home screen menu. (Or select Enter files section if that button is visible)

    Step 1: Select VIDEOS in the home screen menu.
    (Or select Enter files section if that button is visible)

  • Step 2: Select FILES

    Step 2: Select FILES

  • Step 3: Select ADD VIDEOS....

    Step 3: Select ADD VIDEOS....

  • Step 4: Select the BROWSE

    Step 4: Select the BROWSE

  • Step 5: Browse to locate your Source folder. Enter the Source folder so you see your titles. Select OK

    Step 5: Browse to locate your Source folder. Enter the Source folder so you see your titles. Select OK

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

    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.

Set Content

  • Step 7: The set content window will display. This is where the media type is set. Select the option This directory contains.

    Step 7: The set content window will display. This is where the media type is set.
    Select the option This directory contains.

  • Step 8: Select the type of media that is in the Source.

    Step 8: Select the type of media that is in the Source.


Set Content screen for Movies Set Content screen for TV Shows
Set-content-Movies.jpg
Step 9a:
Choose information provider- used to change scraper if required
-Settings- adjust scraper settings to your requirements
Default movie scraper settings are explained here

 Set-content-TV-Shows.jpg
Step 9b
Choose information provider- used to change scraper if required
-Settings- adjust scraper settings to your requirements
Default TV show scraper settings are explained here

Movies- Content scanning options

Movies are in separate folders that match the movie title

If your movies are in Movie folders, Enable this setting
  • 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

Available only when you have selected Change content from the Context Menu on a Movie folder, instead of the Source folder. Allows you to adjust scraper settings for a particular movie which is different to the rest of the Source.

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.

Skip filename matching for external audio tracks

When enabled Kodi skips name checks of external audio files in the folder and returns all found audio tracks to the player for the video. [1]
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.

Skip filename matching for external audio tracks

When enabled Kodi skips name checks of external audio files in the folder and returns all found audio tracks to the player for the video. [2]
Stop hand.png Do not select Local information only Scraper. Using this scraper will prevent your TV Shows from being scanned into the library when using NFO files. Kodi always scans for, and uses NFO files first, regardless of what scraper is set.


Additional scrapers are available. Before replacing the default scraper, ensure the scraper works for your version of Kodi and is suitable for your needs.

All Movie scrapers- Movie scraper add-ons
All TV Show scrapers - TV scraper add-ons


Add to Library

  • Step 10: Press Yes to scrape the content to the library If No is selected, it can be scanned later from the Context Menu of the Source

    Step 10: Press Yes to scrape the content to the library
    If No is selected, it can be scanned later from the Context Menu of the Source


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


  1. ↑ https://github.com/xbmc/xbmc/pull/16273
  2. ↑ https://github.com/xbmc/xbmc/pull/16273



Mergefrom.gif Previous step
Episodes Setup


Return to top
Retrieved from "https://kodi.wiki/index.php?title=Adding_video_sources&oldid=223594"