User:Karellen/scratchpad: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(Blanked the page)
(Naming movies)
Line 1: Line 1:
{|class="{{{1|infobox}}}" style="width:280px; color:black; background-color:{{linear-gradient|bottom|#f5f5a1, #a1f5e4}};"
! '''Steps to create your Video Library'''
|-
|[[File:Video.png|80px|center|link=Video_library]]
|-
|1. [[:HOW-TO:Create_Music_Library|Guide Main Page]]
|-
|2. [[Naming_video_files/Movies|Movie Naming & Folder Structure]]
|-
|3. [[Music_tagging|Music File Tagging]]
|-
|4. [[Adding_music_to_the_library|Scanning Music Into Library]]
|-
|5. [[Scraping_Music|Scraping Additional Music data]]
----
----
|-
|6. [[NFO_files|NFO Files]]
:6.1 [[NFO files/Music|Music NFO Files]]
|-
|7. [[Artwork]]
:7.1 [[Music_artwork|Music Artwork]]
|-
|8. [[Update_Music_Library|Update Music Library]]
----
----
|-
|9. [[Import-export library]]
|-
|10. Rebuild your music library
|-
|[[File:Zappy-frodo.png|100px|center|link=Video_library]]
|}
{{mininav|[[Video library]]|[[Video management|Management]]|[[Naming video files]]}}


= Introduction =
{{kodi}} has the ability to display movie information and artwork for your movie collection. This information and artwork comes from 3rd party sites which are created and maintained by volunteer members.
The process of matching and downloading data and artwork to your {{kodi}} library is named '''scraping'''. The sites where we obtain the information from is referred to as the '''scraper site'''. The wonderful add-on that enables this to occur is called the '''scraper'''.
Things you should know about scraping:
*{{Kodi}} obtains artwork and metadata from 3rd party sites that {{kodi}} has no control over. As these sites are outside the control of Kodi, it is important that your video files and folders are named correctly to ensure an accurate match with the listings at the scraper sites.
*If a movie does not exist at the scraper site, then {{kodi}} cannot scrape it. Always check the movie entry at the scraper site.
*{{Kodi}} can also scrape from local files known as '''''[[NFO_files|NFO Files]]'''''.
*As the scraper sites are maintained by a small volunteer community, which provides this service at no cost, it is strongly encouraged that {{Kodi}} users contribute back to those sites when discovering errors and ommissions in the databases.
*Scraping problems experienced by users are attributable as follows: 95%- Incorrect naming, folder and source structure; 4%- Missing data at the scraper site; 1%- Changes at the scraper site which breaks the scraper add-on.
*For a full list of metadata downloaded by the scraper see the Tag section of '''''[[NFO_files/Movies|Movie NFO Files]]'''''
*For a full list of artwork that can be used by [[Kodi]] see '''''[[Movie_artwork|Movie Artwork]]'''''
The default scraper used by {{kodi}} for Movies is the TheMovieDB (TMDB). Other scrapers are available and can be found by searching the {{kodi}} site [https://kodi.tv/addons/browse?keyword=&category=1185&author=&sort=title+ASC here]
:'''''See: [https://www.themoviedb.org/ TheMovieDB]
:'''''See: [[Add-on:The_Movie_Database|TheMovieDB Add-on]]
:'''''See: [[Add-on:Universal_Movie_Scraper|Universal Movie Scraper Add-on]]
'''{{big|This is the most important step to ensuring correct scraping.}}'''
= Source Folder =
[[File:Video-Movie Folder File Structure.png|400px|right]]
The Source folder is the location that the user specifies for {{kodi}} to search for a class of media. In this case, it is the folder that holds the movie files.
The Source must be the parent folder that holds the movies. In the example image to the right, it is the folder named ''Movies 1''. Immediately below ''Movies 1'' are the movie folders which contain the movie file.
Notes on naming and setting a '''Source''':
*There is no limit on the number of Sources that can be used
*The Source names do not need to be Movies 1 or Movies 2, and can be anything that makes sense to you. The names should be unique, which makes it easier to navigate to the correct source in {{Kodi}}
*Your movies can all be placed in one source if you desire, though larger libraries (200 or more moves) do benefit from multiple sources
*There is no requirement on how to separate movies between Sources. Many users separate based on Genre, alphabetical listing,  Video Resolution (DVD, Bluray, 4k) or any method you prefer
*If you have your movie collection on multiple drives, then a Movie Source must exist on each hard drive and added to {{Kodi}}
*'''Never''' mix media classes. ie, ensure TV Shows and Music are not in the same source as Movies.
*'''Never''' set the entire hard drive as your Source as this will create multiple ghost movie entries.
= Folder & Naming Conventions =
Once the Source has been created on your drive, there are are two options on how to store your movies. The {{kodi}} recommended convention is shown in the images to the right and is detailed in section 3.1.
== Movie Folder & Filename ==
[[File:MovieNaming02.jpg|400px|right]]
This method is the {{Kodi}} recommended method for storing movie media and is detailed in the images to the right.
#Inside the Source folder, create a folder named with the movie title
#*Movie '''Folder''' names must contain the '''Title''' and should contain the '''Year'''. The year must be in brackets.
#*The second image to the right is a screenshot of the ''Blade Runner 2049'' movie entry at TheMovieDatabase site, being the default {{Kodi}} movie scraper. The name of the movie folder should match the name displayed at the scraper site, as shown in the two images.
#Within the new movie folder, save the movie '''file''' as follows:
#*The setting '''Movies are in separate folders that match the movie title''' which is located in the Set Content settings page of the Source has the following effect:
#**If '''Enabled''' {{Kodi}} will use the '''folder''' name to scrape the movie
#**If '''Disabled''' {{kodi}} will use the '''filename''' to scrape the movie
#*In light of the above, and because many users may forget this setting, {{Kodi}} recommends naming the movie file the same as the folder name as shown in the example image above
#*The '''filename''' can be modified to include '''[[Media_flags|Media Flags]]'''
Placing movies in their own folder allows saving of local artwork and nfo files alongside the movie file.
Using this method will provide the safest and most accurate scrape of your media collection.
If using VIDEO_TS or BDMV folder structure you must enable '''Recursive''' lookup when adding the source directory. (You will be reminded of this and the above setting in later pages.)
{{-}}
== Filename Only ==
{| class="wikitable" style="float:right; color:black; background-color:#ffffcc;" cellpadding="10"
! style="width:100px; text-align:left;"| Source folder
! style="width:300px; text-align:left;"| Movie files
|-
| e:\Movies 1
|
:\Arrival (2016).mkv
:\Blade Runner 2049 (2017).mkv
:\Dredd (2012).mkv
:\John Wick (2014).mkv
:\Lucy (2014).mkv
:\Paul (2011).mkv
|}
An alternate method of storing your movies, but not one that is recommended, is to save all the movie files inside the Source folder and omit the Movie folder. Also known as a '''flat folder''' structure.
This method requires that the movie file is named correctly as Kodi is forced to use the movie '''filename''' to match the entry at the scraper site. The movie file must be named as follows:
::Movie Filename must contain the '''Title''' and should contain the '''Year'''. The year must be in brackets. It should match the entry at the scraper site as shown in the above images.
There are disadvantages using this method:
*With larger libraries, this method can become untidy and cumbersome to maintain
*If you use nfo files and save local artwork, the folder will become even more cluttered
*Some Artwork add-ons will not work with this method
*Saving locally stored Artwork will be problematic and, in some cases, impossible to use.
*The option '''Movies are in separate folders that match the movie title''' in the Set Content settings page of the Source does not apply to this method.
== Extra Video Files ==
It is not uncommon to have extra video files that are somehow related to the main movie. Clips such as bloopers, interviews with cast or crew, production notes etc.
{{Kodi}} will see all these additional video files saved inside the movie folder and attempt to scrape them, which will cause incorrect and unwanted multiple entries in the library. How {{kodi}} actually treats these will depend upon which settings are enabled and which folder structure and naming convention is in use.
To safely store extra video files along with your movie, and have them accessible within {{kodi}}, you will need to install the '''Extras''' add-on. Follow the instructions in the link below to create the correct folder structure. This add-on will only work with Movie Folders.
{{see|Add-on:Extras}}
----
'''{{big|{{red|The remainder of this page deals with Special Use cases and can be safely ignored. Most libraries will not require implementing the following additional name extensions.}}}}'''
----
= Media Tags / Flags =
{{main|Media flags}}
[[File:480.png|50px]] [[File:1080.png|50px]] [[File:720.png|50px]] [[File:1080 n.png|50px]] [[File:480-1.png|50px]]
[[File:Divx.png|80px]] [[File:Xvid.png|80px]] [[File:H264.png|80px]] [[File:Bluray.png|80px]] [[File:Dvd.png|80px]] [[File:Avc1.png|80px]]
[[File:1.33.png|50px]] [[File:1.66.png|50px]] [[File:2.20.png|50px]] [[File:2.35.png|50px]]
Media flags are icons in Kodi that displays the meta-information from the media file of a movie, TV show or music title. They are skin specific, and what works in one skin, may not work in another skin. It is always best to check with the author of the skin which flags and tags are used.
'''It is important to note that the skin will display these flags even when these extensions are not used. The only difference being that without the extensions, the movie must be played first in order for {{kodi}} to read the audio and video codec data.
The actual audio and video codec data will override any extension used.''' This means that if you set the extension of, say, '''.ATMOS''', but the video file only has a stereo track, then the '''.ATMOS''' flag will be removed.
;Example
{| class="prettytable"
|-
! scope="row" ! style="width:400px; background-color:#ffffcc; text-align:left;"| ...\Paul (2011).4K.HDR.Atmos.mkv
|}
== 3D movies ==
{{Main|3D}}
Some 3D movies might need an additional file name extension to be identified by Kodi as a 3D movie. See '''[[3D]]''' for details on that additional extension, and when it is needed.
= Split Video Files =
Also known as File Stacking, allows you to combine multiple movie files so they appear and play as the one movie. No longer a common requirement, but still available in {{kodi}} should it be needed.
An example of this use is the Special Extended DVD Edition of ''The Lord of the Rings- The Fellowship of the Ring''. Due to the length of the movie, the movie was split and released on two DVD's requiring a DVD change half way through the movie. This means that when storing this movie, the rip creates two separate movie files. When watching the movie, there will be an interruption when the first part ends and the second part needs to be selected to play.
Two options to overcome this issue:
#Combine both movie files into a single movie file.
#Leave them as Split Video Files, but allow Kodi to combine them into the one library entry (kodi does not combine the actual movie files)
To use this function the following steps are required:
#The setting '''Combine split video items''' must be enabled in the Settings menu. '''''See: [[Settings/Media/Videos#Files|Settings>Media>Files]]'''''
#Modify the movie file names, as described below, so that Kodi recognises them as Split Video Files
#Can only be used with the '''Movie Folder & Filename''' method described above
The default expressions will NOT stack files which use only a number without the extensions stated below (eg movie1.avi, movie2.avi). This is intentional due to false positives which can occur with sequels, eg Die Hard 1, Die Hard 2, Die Hard 3, etc.
== Movie Files ==
'''These are for multi-part video files in the same Movie folder.''' eg *.mkv, *.mp4, *.avi etc
The following are default stacking extensions that can be added to file names.
[[File:Video-Movie FolderStacking.png|600px|right]]
{| class="prettytable"
|-
! colspan="7" style="background-color:#ffffcc;" | # = 1 thru 9 OR A thru D. No space.
|-
! scope="row" ! style="width:100px; text-align:left;"| Default Stacking Extensions
|style="width:50px; text-align:left;"|part#
|style="width:50px; text-align:left;"|cd#
|style="width:50px; text-align:left;"|dvd#
|style="width:50px; text-align:left;"|pt#
|style="width:50px; text-align:left;"|disk#
|style="width:50px; text-align:left;"|disc#
|-
! colspan="7" style="background-color:#ffffcc;" | # = A thru D. No space.
|-
! scope="row" ! style="width:100px; text-align:left;"| Default Stacking Extensions
| colspan="7" |moviename'''#'''.ext<br />
eg.<br />
e:\Movies 1\Lucy (2014)A.mkv<br />
e:\Movies 1\Lucy (2014)B.mkv
|}
== DVD & BluRay Folders ==
If you have preserved the DVD or Bluray folder structure, then use this method for folder stacking.
{| class="prettytable"
|-
! colspan="5" style="background-color:#ffffcc;" | # = 1 thru 9. No space.
|-
! scope="row" ! style="width:100px; text-align:left;"| Default Stacking Extensions
|style="width:50px; text-align:left;"|cd#
|style="width:50px; text-align:left;"|dvd#
|style="width:50px; text-align:left;"|disk#
|style="width:50px; text-align:left;"|disc#
|}
== Advanced Stacking Options ==
File stacking can be fine-tuned by the user to match obscure cases using the '''[[Advancedsettings.xml#moviestacking|<moviestacking>]]''' and '''[[Advancedsettings.xml#folderstacking|<folderstacking>]]''' advancedsettings.xml settings.
{{top}}
<div style="{{linear-gradient|left|#a1f5e4, #f5f5a1}}">{{next|[[Naming_video_files/TV_shows|'''Naming TV Shows''']]}} </div>
{{updated|17}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:How-to]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Video library]]
[[Category:General topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

Revision as of 23:26, 5 January 2018

Steps to create your Video Library
Video.png
1. Guide Main Page
2. Movie Naming & Folder Structure
3. Music File Tagging
4. Scanning Music Into Library
5. Scraping Additional Music data

6. NFO Files
6.1 Music NFO Files
7. Artwork
7.1 Music Artwork
8. Update Music Library

9. Import-export library
10. Rebuild your music library
Zappy-frodo.png
Home icon grey.png   ▶ Video library ▶ Management ▶ Naming video files ▶ scratchpad


Introduction

Kodi has the ability to display movie information and artwork for your movie collection. This information and artwork comes from 3rd party sites which are created and maintained by volunteer members.

The process of matching and downloading data and artwork to your Kodi library is named scraping. The sites where we obtain the information from is referred to as the scraper site. The wonderful add-on that enables this to occur is called the scraper.

Things you should know about scraping:

  • Kodi obtains artwork and metadata from 3rd party sites that Kodi has no control over. As these sites are outside the control of Kodi, it is important that your video files and folders are named correctly to ensure an accurate match with the listings at the scraper sites.
  • If a movie does not exist at the scraper site, then Kodi cannot scrape it. Always check the movie entry at the scraper site.
  • Kodi can also scrape from local files known as NFO Files.
  • As the scraper sites are maintained by a small volunteer community, which provides this service at no cost, it is strongly encouraged that Kodi users contribute back to those sites when discovering errors and ommissions in the databases.
  • Scraping problems experienced by users are attributable as follows: 95%- Incorrect naming, folder and source structure; 4%- Missing data at the scraper site; 1%- Changes at the scraper site which breaks the scraper add-on.
  • For a full list of metadata downloaded by the scraper see the Tag section of Movie NFO Files
  • For a full list of artwork that can be used by Kodi see Movie Artwork


The default scraper used by Kodi for Movies is the TheMovieDB (TMDB). Other scrapers are available and can be found by searching the Kodi site here

See: TheMovieDB
See: TheMovieDB Add-on
See: Universal Movie Scraper Add-on


This is the most important step to ensuring correct scraping.


Source Folder

Video-Movie Folder File Structure.png

The Source folder is the location that the user specifies for Kodi to search for a class of media. In this case, it is the folder that holds the movie files.

The Source must be the parent folder that holds the movies. In the example image to the right, it is the folder named Movies 1. Immediately below Movies 1 are the movie folders which contain the movie file.

Notes on naming and setting a Source:

  • There is no limit on the number of Sources that can be used
  • The Source names do not need to be Movies 1 or Movies 2, and can be anything that makes sense to you. The names should be unique, which makes it easier to navigate to the correct source in Kodi
  • Your movies can all be placed in one source if you desire, though larger libraries (200 or more moves) do benefit from multiple sources
  • There is no requirement on how to separate movies between Sources. Many users separate based on Genre, alphabetical listing, Video Resolution (DVD, Bluray, 4k) or any method you prefer
  • If you have your movie collection on multiple drives, then a Movie Source must exist on each hard drive and added to Kodi
  • Never mix media classes. ie, ensure TV Shows and Music are not in the same source as Movies.
  • Never set the entire hard drive as your Source as this will create multiple ghost movie entries.


Folder & Naming Conventions

Once the Source has been created on your drive, there are are two options on how to store your movies. The Kodi recommended convention is shown in the images to the right and is detailed in section 3.1.


Movie Folder & Filename

MovieNaming02.jpg

This method is the Kodi recommended method for storing movie media and is detailed in the images to the right.

  1. Inside the Source folder, create a folder named with the movie title
    • Movie Folder names must contain the Title and should contain the Year. The year must be in brackets.
    • The second image to the right is a screenshot of the Blade Runner 2049 movie entry at TheMovieDatabase site, being the default Kodi movie scraper. The name of the movie folder should match the name displayed at the scraper site, as shown in the two images.
  2. Within the new movie folder, save the movie file as follows:
    • The setting Movies are in separate folders that match the movie title which is located in the Set Content settings page of the Source has the following effect:
      • If Enabled Kodi will use the folder name to scrape the movie
      • If Disabled Kodi will use the filename to scrape the movie
    • In light of the above, and because many users may forget this setting, Kodi recommends naming the movie file the same as the folder name as shown in the example image above
    • The filename can be modified to include Media Flags

Placing movies in their own folder allows saving of local artwork and nfo files alongside the movie file.

Using this method will provide the safest and most accurate scrape of your media collection.

If using VIDEO_TS or BDMV folder structure you must enable Recursive lookup when adding the source directory. (You will be reminded of this and the above setting in later pages.)


Filename Only

Source folder Movie files
e:\Movies 1
\Arrival (2016).mkv
\Blade Runner 2049 (2017).mkv
\Dredd (2012).mkv
\John Wick (2014).mkv
\Lucy (2014).mkv
\Paul (2011).mkv

An alternate method of storing your movies, but not one that is recommended, is to save all the movie files inside the Source folder and omit the Movie folder. Also known as a flat folder structure.

This method requires that the movie file is named correctly as Kodi is forced to use the movie filename to match the entry at the scraper site. The movie file must be named as follows:

Movie Filename must contain the Title and should contain the Year. The year must be in brackets. It should match the entry at the scraper site as shown in the above images.

There are disadvantages using this method:

  • With larger libraries, this method can become untidy and cumbersome to maintain
  • If you use nfo files and save local artwork, the folder will become even more cluttered
  • Some Artwork add-ons will not work with this method
  • Saving locally stored Artwork will be problematic and, in some cases, impossible to use.
  • The option Movies are in separate folders that match the movie title in the Set Content settings page of the Source does not apply to this method.


Extra Video Files

It is not uncommon to have extra video files that are somehow related to the main movie. Clips such as bloopers, interviews with cast or crew, production notes etc.

Kodi will see all these additional video files saved inside the movie folder and attempt to scrape them, which will cause incorrect and unwanted multiple entries in the library. How Kodi actually treats these will depend upon which settings are enabled and which folder structure and naming convention is in use.

To safely store extra video files along with your movie, and have them accessible within Kodi, you will need to install the Extras add-on. Follow the instructions in the link below to create the correct folder structure. This add-on will only work with Movie Folders.

See: Add-on:Extras




The remainder of this page deals with Special Use cases and can be safely ignored. Most libraries will not require implementing the following additional name extensions.



Media Tags / Flags

480.png 1080.png 720.png 1080 n.png 480-1.png Divx.png Xvid.png H264.png Bluray.png Dvd.png Avc1.png 1.33.png 1.66.png 2.20.png 2.35.png


Media flags are icons in Kodi that displays the meta-information from the media file of a movie, TV show or music title. They are skin specific, and what works in one skin, may not work in another skin. It is always best to check with the author of the skin which flags and tags are used.

It is important to note that the skin will display these flags even when these extensions are not used. The only difference being that without the extensions, the movie must be played first in order for Kodi to read the audio and video codec data.

The actual audio and video codec data will override any extension used. This means that if you set the extension of, say, .ATMOS, but the video file only has a stereo track, then the .ATMOS flag will be removed.

Example
...\Paul (2011).4K.HDR.Atmos.mkv


3D movies

Some 3D movies might need an additional file name extension to be identified by Kodi as a 3D movie. See 3D for details on that additional extension, and when it is needed.


Split Video Files

Also known as File Stacking, allows you to combine multiple movie files so they appear and play as the one movie. No longer a common requirement, but still available in Kodi should it be needed.

An example of this use is the Special Extended DVD Edition of The Lord of the Rings- The Fellowship of the Ring. Due to the length of the movie, the movie was split and released on two DVD's requiring a DVD change half way through the movie. This means that when storing this movie, the rip creates two separate movie files. When watching the movie, there will be an interruption when the first part ends and the second part needs to be selected to play.

Two options to overcome this issue:

  1. Combine both movie files into a single movie file.
  2. Leave them as Split Video Files, but allow Kodi to combine them into the one library entry (kodi does not combine the actual movie files)

To use this function the following steps are required:

  1. The setting Combine split video items must be enabled in the Settings menu. See: Settings>Media>Files
  2. Modify the movie file names, as described below, so that Kodi recognises them as Split Video Files
  3. Can only be used with the Movie Folder & Filename method described above

The default expressions will NOT stack files which use only a number without the extensions stated below (eg movie1.avi, movie2.avi). This is intentional due to false positives which can occur with sequels, eg Die Hard 1, Die Hard 2, Die Hard 3, etc.


Movie Files

These are for multi-part video files in the same Movie folder. eg *.mkv, *.mp4, *.avi etc

The following are default stacking extensions that can be added to file names.

Video-Movie FolderStacking.png
# = 1 thru 9 OR A thru D. No space.
Default Stacking Extensions part# cd# dvd# pt# disk# disc#
# = A thru D. No space.
Default Stacking Extensions moviename#.ext

eg.
e:\Movies 1\Lucy (2014)A.mkv
e:\Movies 1\Lucy (2014)B.mkv


DVD & BluRay Folders

If you have preserved the DVD or Bluray folder structure, then use this method for folder stacking.

# = 1 thru 9. No space.
Default Stacking Extensions cd# dvd# disk# disc#


Advanced Stacking Options

File stacking can be fine-tuned by the user to match obscure cases using the <moviestacking> and <folderstacking> advancedsettings.xml settings.



Return to top


Next step: Naming TV Shows