Adding video sources: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(Modify Remote Shares)
(v21 Updates)
 
(16 intermediate revisions by 4 users not shown)
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 {{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" />
{{warning|For media files that are stored on network sources: [[UPnP]] cannot be used to create a library. It is recommended that you share your media using another protocol such as [[SMB]].}}


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




'''{{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}}'''
{{-}}
<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}}:''' 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-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.<br>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>


Line 36: Line 29:


= 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. Select '''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 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>
 
 
 
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.
 
<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: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
</gallery>
</gallery>




;{{big|Movies- Content scanning options}}
{|
:'''Movies are in separate folders that match the movie title'''
! style="width: 45%;" | {{resize|1.4em|Set Content for Movies}}
::*If '''Enabled''' {{Kodi}} will use the '''folder''' name to scrape the movie
! style="width: 10%;" |
::*If '''Disabled''' {{kodi}} will use the '''filename''' to scrape the movie
! style="width: 45%;" | {{resize|1.4em|Set Content for TV Shows}}
 
|-
:'''Scan Recursively'''
| style="width: 45%; text-align:center;" | [[File:Set-content-Movies.jpg|600px]]<br>'''{{big|Step 9a}}''': Select '''OK''' when done
::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: 10%;" |
 
| style="width: 45%; text-align:center;" | [[File:Set-content-TV-Shows.jpg|600px]]<br>'''{{big|Step 9b}}''': Select '''OK''' when done
:'''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
| || ||
|-
| style="width: 40%;" |
;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:{{note|If your preferred scraper is not listed, use the '''Get more...''' button.}}


:'''Exclude path from library updates'''
;Settings
::Prevents the Source from being scanned when an Update Library is running
:Adjust the scraper settings, '''for this Source only'''.
:{{note|Default movie scraper settings are explained in the wiki page for each scraper.}}


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


;{{big|TV Show- Content scanning options}}
;Scan Recursively
:'''Selected folder contains a single TV show'''
: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
::Allows you to change the Content settings for a particular TV Show without affecting the entire Source
:'''Exclude path from library updates'''
::Prevents the Source from being scanned when an Update Library is running


;Selected folder contains a single video;
: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.


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.
;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. <ref>https://github.com/xbmc/xbmc/pull/16273</ref>


| style="width: 10%;" |
| style="width: 45%; text-align:left; vertical-align:top;"  |


== Movie Scraper ==
;Choose information provider
{{see also|Add-on:The MovieDB}}
:Select this setting to change the scraper that this Source uses<br>
:{{note|If your preferred scraper is not listed, use the '''Get more...''' button.}}


;Settings
:Adjust the scraper settings, '''for this Source only'''.
:{{note|Default movie scraper settings are explained in the wiki page for each scraper.}}


From Step 9a above select '''Settings''' to access the settings page for the scraper
;Selected folder contains a single TV show
{{#lst:Add-on:The MovieDB|Scraper settings}}
: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.
Press OK to accept the changes. The screen in '''Step 10''' will be offered


;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. <ref>https://github.com/xbmc/xbmc/pull/16273</ref>
|}


== TV Show Scraper ==
{{see also|Add-on:The_TVDB}}


'''Note:''' Additional scrapers are available.
{| class="mw-collapsible mw-collapsed wikitable" style="margin: 0.0em 0 0.0em 0em; {{border-radius|5px}}; {{box-shadow|0px|1px|3px|#878787}};"
! scope="row" style="width:500px; background-color:#dfedf0; text-align:left;"| List of Movie scrapers compatible with v20 Nexus
|-
|
<dpl>
category = Omega_add-on_repository
category = Movie scraper add-ons
notcategory = Broken add-ons
</dpl>
|}


From Step 9b above select '''Settings''' to access the settings page for the scraper
{| class="mw-collapsible mw-collapsed wikitable" style="margin: 0.0em 0 0.0em 0em; {{border-radius|5px}}; {{box-shadow|0px|1px|3px|#878787}};"
{{#lst:Add-on:The_TVDB|Scraper settings}}
! scope="row" style="width:500px; background-color:#dfedf0; text-align:left;"| List of TV Show scrapers compatible with v20 Nexus
|-
|
<dpl>
category = Omega_add-on_repository
category = TV scraper add-ons
notcategory = Broken add-ons
</dpl>
|}


Press OK to accept the changes. The screen in '''Step 10''' will be offered
{| class="mw-collapsible mw-collapsed wikitable" style="margin: 0.0em 0 0.0em 0em; {{border-radius|5px}}; {{box-shadow|0px|1px|3px|#878787}};"
! scope="row" style="width:500px; background-color:#dfedf0; text-align:left;"| List of Music Video scrapers compatible with v20 Nexus
|-
|
<dpl>
category = Omega_add-on_repository
category = Category:Music_video_scraper_add-ons
notcategory = Broken add-ons
</dpl>
|}






= 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" />


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.
* 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 are 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|Event Log]]''''' to view any titles that were not added to the library, which is normally due to incorrect naming. '''''See... [[Incorrect_and_missing_videos|Scraping Problems]]'''''
When the scraping process is complete, be sure to check the '''''[[Event_Log|Event Log]]''''' to view any titles that were not added to the library, which is normally due to incorrect naming. '''''See... [[Incorrect_and_missing_videos|Scraping Problems]]'''''




<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>
 
 
----
'''{{big|{{red|The remainder of this page deals with Special Use cases and can be safely ignored.}}}}'''
----
 
{{top}}
 
 
= Adding Remote sources =
For details on the supported protocols and configuration


{{See|File sharing}}


Follow the steps ([[#Adding sources|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)
= References =
*Select a remote location, and you should be able to browse to the remote server.
<references />


'''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:
<gallery widths=500px heights=283px >
File:Add-Network-Location.png |Image 1- Select '''Add network location...''' from the '''Browse for new shares'''' list.
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|Image 3- 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_4.png|Image 4-<br> '''4.1''' In the '''Share folder''' section, type in the name of the  folder you wish to add.<br>'''4.2''' You may also be required to add the drive letter, depending upon your setup ''eg f\Movies''.<br>'''4.3''' 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>
= 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/<br />
: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/<br />
: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;"
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Mergefrom.gif|60px|link=Naming_video_files/Episodes]]
| style="width:200px; text-align:center;" | '''Previous step'''
|-
| style="width:200px; text-align:center;" | '''[[Naming_video_files/Episodes|Episodes Setup]]'''
|}</center>






{{top}}
{{top}}
{{updated|21}}


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

Latest revision as of 02:17, 22 April 2024

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

Stop hand.png For media files that are stored on network sources: UPnP cannot be used to create a library. It is recommended that you share your media using another protocol such as SMB.


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

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


Adding Sources


Set Content


Set Content for Movies Set Content for TV Shows
Set-content-Movies.jpg
Step 9a: Select OK when done
Set-content-TV-Shows.jpg
Step 9b: Select OK when done
Choose information provider
Select this setting to change the scraper that this Source uses
Note: If your preferred scraper is not listed, use the Get more... button.
Settings
Adjust the scraper settings, for this Source only.
Note: Default movie scraper settings are explained in the wiki page for each scraper.
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]
Choose information provider
Select this setting to change the scraper that this Source uses
Note: If your preferred scraper is not listed, use the Get more... button.
Settings
Adjust the scraper settings, for this Source only.
Note: Default movie scraper settings are explained in the wiki page for each scraper.
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]


Note: Additional scrapers are available.

List of Movie scrapers compatible with v20 Nexus
List of TV Show scrapers compatible with v20 Nexus
List of Music Video scrapers compatible with v20 Nexus


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


References



Mergefrom.gif Previous step
Episodes Setup


Return to top