Official Kodi Wiki - User contributions [en]

Basic controls

2022-12-19T03:11:06Z

LGoosens: Structured markup + changed wording for clarity

{{mininav|[[First time user]]}}

= Introduction =
'''Welcome new user!''' <section begin="intro" />You have finally installed Kodi on your equipment, launched it, and then probably sat there for a few minutes scratching your head thinking "What is this"? This page will describe the commonly used screens and basic navigation around Kodi. Its aim is to allow you to become familiar with Kodi and prepare you for the upcoming setup pages.<section end="intro" />

This page will not describe how to load your media. That task is covered in subsequent pages. As with most pages of the wiki, this page assumes you are using the default skin '''[[Add-on:Estuary|Estuary]]'''. If you are using another skin, then you have run before learning to walk, so you should change back until you have at least set up Kodi.

Kodi has been designed around the ''[https://en.wikipedia.org/wiki/10-foot_user_interface 10 foot interface]'' principle. This means that Kodi is best used with a remote control or keyboard while sitting on your couch watching TV. Mouse support is limited, and disabled in many skins.

Although this guide applies to all parts of Kodi, some portions have been based on the Video/Movies/TV Shows section of Kodi. To see the specific Basic Controls for Music, see '''''[http://kodi.wiki/view/Music_navigation Music Navigation & Playback]'''''

The following image is a screenshot of the Home Screen when Kodi launches. In this screenshot there is media in the library, but you may not have media in your library yet.

<gallery mode="packed" widths="900px" heights="506px">
File:HomeScreenGuide.jpg
</gallery>
{{-}}

= Power Options =
[[File:Estuary-power-menu.jpg|right|300px]]
Pressing {{keypress|S}} on the keyboard, or by selecting the Power icon in the top left corner of the home screen calls up the Power Options menu.

Depending on your hardware, the Power Options menu may have more or less options to that shown in the image.

The options on this menu are from top to bottom:

;Exit
:Exits Kodi to your operating system.
;Power off system
:Powers down your hardware
;Custom Shutdown Timer
:Kodi will shutdown the hardware at the end of the nominated countdown time. Enter the time interval in minutes.
;Suspend
:Suspends your hardware.
;Hibernate
:Hibernates your hardware.
;Reboot
:Restarts your hardware.
;Log off <ProfileName> user
:If using Profiles, the option to log out the current user and login as a new user is this option. <ProfileName> will display the name of the currently logged in Profile/User.

= Settings =
The Settings Icon in the top left of the screen provides access to the Kodi Settings pages. Most general use settings are contained in these pages. During your travels with Kodi, you will come across mention of the advancedsettings.xml file. This holds advanced Settings for Kodi and can be modified by the user.

For more information on the Settings pages, {{See|Settings}}

For more information on the advancedsettings.xml file, {{see|Advancedsettings.xml}}

= Search & Filter =
[[File:GlobalSearch.jpg|right|300px]]
The Global Search function allows you to search your library, add-ons or some on-line sources for information.

Some of the pictured options will require installation of an add-on. Simply confirm the installation of the add-on when prompted.

{{see|Add-on:Global Search}}
{{see|Add-on:YouTube}}
{{see|Add-on:ExtendedInfo Script}}

There are also Search and Filter functions inside each of the Main Menu options which are accessible from the '''[[Basic_controls#Sideblade_Menu|Sideblade Menu]]'''.

{{see|Advanced library filtering}}
{{-}}

= Main Menu =
All classes of media are separated into their own menu options. The default classes are listed below. Other skins allow you to add additional menu items for, say, Home Movies, Cartoons, Disney etc. See: '''''[[Custom_home_items|Custom home items]]'''''

It is possible to remove unwanted menu options and to re-add them at a later date. Very useful for those options that remain unused in your setup such as Live TV, Radio etc. See: '''''[[Add-on:Estuary/Settings#Main_Menu_Items|Hiding Menu items]]'''''

As each Main Menu option is selected, the Home Page will dynamically update with information relevant for the selected menu option. The full list of available menu options are as follows:

* '''[[Video_library|Movies]]''' - Enter the movie library and view "All movies, by title"
* '''[[Video_library|TV shows]]''' - Enter the TV show library and view "All TV shows, by title"
* '''[[Music_library|Music]]''' - Enter the music library and select how to view the library- artists, albums, songs, genre, etc
* '''[[Music_library|Music Videos]]''' - Enter the music video library and select how to view the library- artists, albums, songs, genre, etc
* '''[[PVR|Live TV]]''' - With a PVR add-on, access Free To Air Television channels with an EPG (Electronic Program Guide) with Pause/Rewind/Fast Forward and Record facilities
* '''[[PVR|Radio]]''' - With a PVR add-on, access Free To Air Radio Channels with an EPG (Electronic Program Guide)
* '''[[Games]]''' - View your games
* '''[[Add-ons]]''' - Access installed add-ons, such as 'Video-addons', Music add-ons, Program add-ons, etc
* '''[[Pictures]]''' - Shows a basic file-based image viewer, as well as picture-related add-ons.
* '''[[Video_library|Vidoes]]''' - Allows you to access the file system of your video Sources. It includes file views, movie library, TV show library, music video library, playlists, and video related add-ons. Users can also use this to navigate to more '''[[video nodes|nodes]]''' in the library, showing movies or TV shows by year, genre, actor, or even custom created nodes for specific people, moods, etc.
* '''[[Favourites]]''' - Shows all your media that has been tagged as a ''Favourite'' in one easily accessible location.
* '''[[Weather]]''' - Install a weather add-on to display weather forecasts for your chosen area

= Home Screen =
The term '''Home Screen''' can be used to mean the entire screen as depicted in the image in Section 1 above. If it is prefixed by a menu item, say ''Movies Home Screen'' or ''TV Show Home Screen'', then it refers to the section to the right of the Main Menu. The following information refers to the latter.

The Home Screen contains a dynamic list of media relevant for the selected main menu item. The image above displays the following items:

;Categories- also known as Nodes
:A quick link to the available Movie Nodes. It allows you to navigate your Movie library via Genres, Title, Year, Country Actors, Directors, Studios, Sets, Tags and Recently added
:{{see also|Video nodes|Music nodes}}

;Poster views
:Displays movie titles that fit into the following criteria:
:*In-progress
:*Recently added
:*Unwatched movies
:*Random selection
:*Movie Sets

;Genres
:Quck icon selection of available Genre's in the library.

;Studios
:Quick icon selection of available Studios in the library.

The other classes in the main menu have a similar selection but designed and named to be most relevant for their class of media.

= '''Sideblade Menu''' =
[[File:EstuarySideBarMenu_small.gif|right]]
[[File:Estuary-player-sidebar-video.jpg|210px|right]]

{{red|The Sideblade Menu is central to browsing and organising your media, and is accessible from '''most''' screens in Kodi.}}

{{note|The direction you need to press — {{keypress|left}} or {{keypress|up}} — is indicated by the ''Options'' arrow in the bottom left corner of the screen.}}

<section begin="SidebladeMenu" />To invoke the sideblade, either:
* press the {{keypress|left}} key on your remote control
* press the {{keypress|left}} key on a keyboard
* bring the mouse cursor to the left border of the screen<section end="SidebladeMenu" />

'''Available Options'''

The options in the Sideblade Menu vary. Shown below are options for the Movies section.

;ViewType
:Change current library view.

;Sort by
:Select how the list of Movies/TV Shows/Episodes are sorted: e.g. ''Title, PlayCount'' etc

;Order
:Once the ''Sort by'' is selected, choose the order: ''Ascending'' or ''Descending''

;Filter
:Allows you to filter your list on certain criteria: e.g. ''Director, Actor, Ratings, Tags'' etc '''''See: [[Advanced library filtering]]'''''

;All Videos / Watched / Unwatched
:Global toggle that allows you to select what is shown in the list: ''All Videos, Watched'' or ''Unwatched'' videos only

;Update library
:Scans the library for newly added Movies, TV Shows, Episodes and Music Videos in the Video Library.

;Go to playlist
:Will open the currently playing Party Mode playlist

;Bottom Icons- From Left to right
*Pause
*Stop
*Skip to next video
*Open Fullscreen mode: for video this returns you to the playing video, and for music this opens the Now Playing/Visualisation window.

{{See also|Music_navigation#Sideblade_Menu|label 1=Music Sideblade Menu}}
{{-}}

= '''Context Menu''' =
'''{{resize|1.4em|{{red|The Context Menu is a critical menu that holds numerous options. It is available in most locations.}}}}'''

The '''Context Menu''' allows quick access to a limited set of functions relevant for the currently selected item.

<section begin="ContextMenu" />After highlighting an item (eg a movie) the Context Menu can be invoked by:
* long press the {{keypress|OK}} key on your remote control
* Press letter {{keypress|C}} on a keyboard
* right-clicking with the mouse<section end="ContextMenu" />

References to Context Menus are scattered throughout the wiki on relevant pages and can be found easily enough in Kodi. As there are many, many types of context menus, it would be uneconomical to list them all here.

The following are a few examples of the context menu.
<gallery mode="packed-overlay" widths="500px" heights="283px">
File:MovieSets02.jpg|The context menu in the ''Movie library''.
File:EstuaryContextmenu3.png|The context menu in the ''Video file browser''.
File:EstuaryContextmenu2.png|The context menu in the [[Add-on:YouTube|YouTube]] add-on.
</gallery>

= '''Information Page''' =
[[File:Artwork-Actors01.jpg|right|500px]]
<section begin="InformationPage" />The Information Page is available for each title in the movies, TV show and Music Video library, and for each artist, album and song in the music library. An Information Page may also be available for each recording in the PVR library.

This screen will display the metadata for the title. A number of options are available along the bottom of the page. What is displayed will depend on the skin in use and which class of media is displayed (Movie, TV Show, Music Video, Music, PVR)<section end="InformationPage" />

This is a Library only feature and will not work on titles not in the library. Attempting to perform this in the File Browser using Videos>Files will commence the scrape process for that individual title. '''''See: [[Updating_or_removing_videos|Update Video Library]]'''''

To access the Information Page, navigate to, and highlight the required title. Once highlighted use one of the following methods to view the Information Page:
*Press {{keypress|i}} on a remote control
*Press {{keypress|i}} on a keyboard
*Using the '''''[[Basic_controls#Context_Menu|Context Menu]]''''', select '''Information'''

Available option buttons. '''Requires scrolling left/right to access all buttons'''
;Actors image
:Clicking on the image of an actor will bring up a listing of other titles, in your library, the actor appears in
:Pressing {{keypress|up}} will provide additional information from online sources. If the '''''[[Add-on:ExtendedInfo_Script|ExtendedInfo add-on]]''''' is not installed, you will be asked to install it
;Play
:Commence playback of the title
;Your Rating
:Use this option to apply your personal rating to your media. The display of the User Rating depends upon the library view in use. It is displayed at the top of the Poster as a blue star containing the rating in Poster View. Each type of view displays it differently.
;Trailer
:Commence playback of the '''''[[Trailers|Trailer]]'''''. If no trailer is available, either the button will not be displayed or you will be offered to install the YouTube add-on to view online trailers.
;Show Fanart
:Full screen display of the fanart attached to the title
;Same director
:Displays a listing of other titles in the library from the same director
;Movie Set
:Open the '''''[[Movie_sets|Movie Set]]''''' that the current movie belongs to. Only visible when the movie is part of a set.
;Choose art
:Settings page that allows the manual selection of '''''[[Artwork]]'''''
;Refresh
:Allows you to rescan or rescrape the title. Useful if you have modified information in the NFO File, or you would like to re-scrape updated information from the site of the Information provider. '''''See: [[Updating_or_removing_videos|Update Video Library]]'''''
:Highlighting this button will also display the path to the playable file that {{kodi}} has recorded in the library database. Useful to track down duplicate entries.

= Now Playing Controls =
The Now Playing Controls are covered in more detail in the following two sections...

;Music Player Controls
:'''''See: [[Music_navigation|Music Navigation & Playback]]'''''

;Video Player Controls
:'''''See: [[Video_playback|Video Playback]]'''''

= On Screen Keyboard =
[[File:OnScreenKeyboard.jpg|right|500px]]
When required, Kodi will display an on-screen keyboard to facilitate data entry. No special selection is required by the user as the keyboard will appear where required.

The on-screen keyboard can be used in the following ways:
*Remote control
*Physical keyboard
*Mouse presses
{{-}}

= Remote Controls =
Kodi is best used with a Remote Control. Many types of Remote Controls can be used as listed on the following page.
{{see|Remote controls}}

= Keyboard Controls =
If you are using a physical keyboard, the following page lists available keystrokes to control Kodi.
{{see|Keyboard controls}}

{{top}}

<div style="{{linear-gradient|left|#ffdddd, #ddffdd 50%, #ddddff}}">{{next|[[Video_library|Video Library Main Menu]]}} </div>
<br />
<div style="{{linear-gradient|left|#f5d3ff, #12b2e7}}">{{next|[[Music_library|Music Library Main Menu]]}} </div>

{{updated|19}}
[[Category:Karellen]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

HTTP

2022-12-17T20:11:53Z

LGoosens: Structured markup for clarity

{{mininav| [[File sharing]] }}
<section begin="intro"/>Kodi contains an [[w:HTTP|HTTP]]-client with which you can add sources in all sections in the Kodi interface.<section end="intro"/>

== HTTP/HTTPS url format ==
Kodi supported normal http/https urls, additionally, it support optional options we called as 'protocol options' which user/addons can set so that Kodi can full simulate the browser operations with specified http request header values.
* normal http url format:
http[s]://[username[:password]@]host[:port]/directory/file?a=b&c=d

* http url with 'protocol options':
http[s]://[username[:password]@]host[:port]/directory/file?a=b&c=d'''|option1=value1&option2=value2'''

=== Kodi supported special http protocol options ===
* auth
which is required if your HTTP server uses any type of authentication other than basic (which is, in fact, unsafe unless used over HTTPS). E.g. if your HTTP server uses digest authentication, use <code><nowiki>http://username:password@host:port/directory/|auth=digest</nowiki></code>. For maximum flexibility, use <code>auth=any</code> or <code>auth=anysafe</code> (i.e. anything other than basic).

* seekable (13.0+ Gotham, since git bb79b32b)
when the media url is unseekable, addons can set <code>seekable=0</code> protocol options, then Kodi won't try to seek on that url.

{{note|If you set it in frodo or earlier, it will add a http header '<code>seekable: 0</code>' in the http request, it's harmless.}}

=== Other http protocol options (they are all rfc defined http request headers) ===
* Referer
* User-Agent
* Cookie
* Encoding
* any other http request headers defined in rfc.

For the meanings of these, see RFC 2616.

{{Helix updated}}

[[Category:File sharing]]
[[Category:Manual]]

Settings/Media/Library

2022-12-15T21:50:07Z

LGoosens: Changed wording

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= Manage Sources =
[[File:Settings_media_library_manage_sources.jpg|500px]]

== Videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Video Sources. It is an alternate access to Videos>Files from the main menu.
{{see|HOW-TO:Create Video Library}}
|}

== Music ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Music Sources. It is an alternate access to Music>Files from the Music menu.
{{See|HOW-TO:Create Music Library}}
|}

== Pictures ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Picture Sources. It is an alternate access to Pictures from the Pictures menu.
{{See|Pictures}}
|}

= Video Library =
[[File:Settings_media_library_video_library.jpg|500px]]

== Update library on startup ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Check for new video content every time {{kodi}} is started.
{{note|If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.<br>
The linked page gives alternate methods to scan new items into the library.}}
{{see|Updating or removing videos}}
|}

== Hide progress of library updates ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Hide the pop-up library scanning progress bar during scans.
|}

== Clean library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Remove items from the library.
|}

{{divbox|yellow|Removing content from disconnected sources|If storage media are disconnected, using this function will not remove their contents from the library. This protects your library from accidental erasure in case a removable storage device is unplugged.

To permanently remove titles from the library:<br>
# Use the correct method of removing titles from the library as detailed in the link below.<br>
# After correctly deleting from the library first, ''then'' run a clean library to purge the database of unnecessary records.
See '''[[Updating_or_removing_videos#Remove_From_Library|Removing content]]'''}}

== Export library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Export the contents of the video library. Used as a backup of your library, or to create a new {{kodi}} installation.
{{note|For the Video library, we recommend using the Separate Files method.}}
: See '''[[Import-export_library/Video|Export Video Library]]'''

|}

== Import library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you exported your library using the '''Single File''' method, use this to import the single file into the video library.
: See '''[[Import-export_library/Video#Import|Import Single File]]'''
|}

= Music Library =
[[File:Settings_media_library_music_library.jpg|500px]]

== Update library on startup ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Check for new music content every time {{kodi}} is started.
{{note|If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.<br>
The linked page gives alternate methods to scan new items into the library.}}
{{see|Update Music Library}}
|}

== Hide progress of library updates ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Hide the pop-up library scanning progress bar during scans.
|}

== Clean library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Performs cleanup tasks on the '''Music''' database. Used to de-clutter the database of unused records. Used if you have moved, deleted or renamed files. If a source is located on removable storage that is not connected at the time of the Clean Library, you will be asked to choose to remove or keep the library entries from that drive.
* Removes any songs with invalid paths
* Removes any albums which have no references
* Removes any artists which have no references
* Removes any genres which have no references
* Removes any paths which have no references
|}

== Export library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Export the contents of the video library. Used as a backup of your library or to create a new {{kodi}} installation.
For the Music library, we recommend using the Single Files method as this will also export play counts, user ratings and last played data.
: See '''[[Import-export_library/Music|Export Music Library]]'''

|}

== Import library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you exported your library using the '''Single File''' method, use this to import the single file into the music library.
: See '''[[Import-export_library/Music#Import_-_Single_File|Import Single File]]'''
|}

{{Top}}
{{updated|19}}

[[Category:Settings]]

Settings/Media/Library

2022-12-15T21:48:27Z

LGoosens: Structured markup for clarity

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= Manage Sources =
[[File:Settings_media_library_manage_sources.jpg|500px]]

== Videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Video Sources. It is an alternate access to Videos>Files from the main menu.
{{see|HOW-TO:Create Video Library}}
|}

== Music ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Music Sources. It is an alternate access to Music>Files from the Music menu.
{{See|HOW-TO:Create Music Library}}
|}

== Pictures ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Picture Sources. It is an alternate access to Pictures from the Pictures menu.
{{See|Pictures}}
|}

= Video Library =
[[File:Settings_media_library_video_library.jpg|500px]]

== Update library on startup ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Check for new video content every time {{kodi}} is started.
{{note|If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.<br>
The linked page gives alternate methods to scan new items into the library.}}
{{see|Updating or removing videos}}
|}

== Hide progress of library updates ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Hide the pop-up library scanning progress bar during scans.
|}

== Clean library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Remove items from the library.
|}

{{divbox|yellow|Removing content from disconnected sources|If storage media are disconnected, using this function will not remove their contents from the library. This protects your library from accidental erasure in case your removable storage device is unplugged.

To permanently remove titles from the library:<br>
# Use the correct method of removing titles from the library as detailed in the link below.<br>
# After correctly deleting from the library first, ''then'' run a clean library to purge the database of unnecessary records.
See '''[[Updating_or_removing_videos#Remove_From_Library|Removing content]]'''}}

== Export library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Export the contents of the video library. Used as a backup of your library, or to create a new {{kodi}} installation.
{{note|For the Video library, we recommend using the Separate Files method.}}
: See '''[[Import-export_library/Video|Export Video Library]]'''

|}

== Import library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you exported your library using the '''Single File''' method, use this to import the single file into the video library.
: See '''[[Import-export_library/Video#Import|Import Single File]]'''
|}

= Music Library =
[[File:Settings_media_library_music_library.jpg|500px]]

== Update library on startup ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Check for new music content every time {{kodi}} is started.
{{note|If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.<br>
The linked page gives alternate methods to scan new items into the library.}}
{{see|Update Music Library}}
|}

== Hide progress of library updates ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Hide the pop-up library scanning progress bar during scans.
|}

== Clean library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Performs cleanup tasks on the '''Music''' database. Used to de-clutter the database of unused records. Used if you have moved, deleted or renamed files. If a source is located on removable storage that is not connected at the time of the Clean Library, you will be asked to choose to remove or keep the library entries from that drive.
* Removes any songs with invalid paths
* Removes any albums which have no references
* Removes any artists which have no references
* Removes any genres which have no references
* Removes any paths which have no references
|}

== Export library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Export the contents of the video library. Used as a backup of your library or to create a new {{kodi}} installation.
For the Music library, we recommend using the Single Files method as this will also export play counts, user ratings and last played data.
: See '''[[Import-export_library/Music|Export Music Library]]'''

|}

== Import library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you exported your library using the '''Single File''' method, use this to import the single file into the music library.
: See '''[[Import-export_library/Music#Import_-_Single_File|Import Single File]]'''
|}

{{Top}}
{{updated|19}}

[[Category:Settings]]

Settings/Media/Library

2022-12-15T21:46:48Z

LGoosens: Structured markup for clarity

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= Manage Sources =
[[File:Settings_media_library_manage_sources.jpg|500px]]

== Videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Video Sources. It is an alternate access to Videos>Files from the main menu.
{{see|HOW-TO:Create Video Library}}
|}

== Music ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Music Sources. It is an alternate access to Music>Files from the Music menu.
{{See|HOW-TO:Create Music Library}}
|}

== Pictures ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Picture Sources. It is an alternate access to Pictures from the Pictures menu.
{{See|Pictures}}
|}

= Video Library =
[[File:Settings_media_library_video_library.jpg|500px]]

== Update library on startup ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Check for new video content every time {{kodi}} is started.
{{note|If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.<br>
The linked page gives alternate methods to scan new items into the library.}}
{{see|Updating or removing videos}}
|}

== Hide progress of library updates ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Hide the pop-up library scanning progress bar during scans.
|}

== Clean library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Remove items from the library.
|}

{{divbox|yellow|Removing content from disconnected sources|If storage media are disconnected, using this function will not remove their contents from the library. This protects your library from accidental erasure in case your removable storage device is unplugged.

To permanently remove titles from the library:<br>
# Use the correct method of removing titles from the library as detailed in the link below.<br>
# After correctly deleting from the library first, ''then'' run a clean library to purge the database of unnecessary records.
See '''[[Updating_or_removing_videos#Remove_From_Library|Removing content]]'''}}

== Export library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Export the contents of the video library. Used as a backup of your library, or to create a new {{kodi}} installation.
{{note|For the Video library, we recommend using the Separate Files method.}}
: See '''[[Import-export_library/Video|Export Video Library]]'''

|}

== Import library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you exported your library using the '''Single File''' method, use this to import the single file into the video library.
: See '''[[Import-export_library/Video#Import|Import Single File]]'''
|}

= Music Library =
[[File:Settings_media_library_music_library.jpg|500px]]

== Update library on startup ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Check for new music content every time {{kodi}} is started.
If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.
For alternate methods to scan new items into the library...
{{see|Update Music Library}}
|}

== Hide progress of library updates ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Hide the pop-up library scanning progress bar during scans.
|}

== Clean library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Performs cleanup tasks on the '''Music''' database. Used to de-clutter the database of unused records. Used if you have moved, deleted or renamed files. If a source is located on removable storage that is not connected at the time of the Clean Library, you will be asked to choose to remove or keep the library entries from that drive.
* Removes any songs with invalid paths
* Removes any albums which have no references
* Removes any artists which have no references
* Removes any genres which have no references
* Removes any paths which have no references
|}

== Export library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Export the contents of the video library. Used as a backup of your library or to create a new {{kodi}} installation.
For the Music library, we recommend using the Single Files method as this will also export play counts, user ratings and last played data.
: See '''[[Import-export_library/Music|Export Music Library]]'''

|}

== Import library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you exported your library using the '''Single File''' method, use this to import the single file into the music library.
: See '''[[Import-export_library/Music#Import_-_Single_File|Import Single File]]'''
|}

{{Top}}
{{updated|19}}

[[Category:Settings]]

Settings/Media/Library

2022-12-15T21:43:22Z

LGoosens: Clarified this (I hope) + structured markup

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= Manage Sources =
[[File:Settings_media_library_manage_sources.jpg|500px]]

== Videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Video Sources. It is an alternate access to Videos>Files from the main menu.
{{see|HOW-TO:Create Video Library}}
|}

== Music ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Music Sources. It is an alternate access to Music>Files from the Music menu.
{{See|HOW-TO:Create Music Library}}
|}

== Pictures ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Picture Sources. It is an alternate access to Pictures from the Pictures menu.
{{See|Pictures}}
|}

= Video Library =
[[File:Settings_media_library_video_library.jpg|500px]]

== Update library on startup ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Check for new video content every time {{kodi}} is started.
If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.
For alternate methods to scan new items into the library...
{{see|Updating or removing videos}}
|}

== Hide progress of library updates ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Hide the pop-up library scanning progress bar during scans.
|}

== Clean library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Remove items from the library.
|}

{{divbox|yellow|Removing content from disconnected sources|If storage media are disconnected, using this function will not remove their contents from the library. This protects your library from accidental erasure in case your removable storage device is unplugged.

To permanently remove titles from the library:<br>
# Use the correct method of removing titles from the library as detailed in the link below.<br>
# After correctly deleting from the library first, ''then'' run a clean library to purge the database of unnecessary records.
See '''[[Updating_or_removing_videos#Remove_From_Library|Removing content]]'''}}

== Export library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Export the contents of the video library. Used as a backup of your library, or to create a new {{kodi}} installation.
{{note|For the Video library, we recommend using the Separate Files method.}}
: See '''[[Import-export_library/Video|Export Video Library]]'''

|}

== Import library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you exported your library using the '''Single File''' method, use this to import the single file into the video library.
: See '''[[Import-export_library/Video#Import|Import Single File]]'''
|}

= Music Library =
[[File:Settings_media_library_music_library.jpg|500px]]

== Update library on startup ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Check for new music content every time {{kodi}} is started.
If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.
For alternate methods to scan new items into the library...
{{see|Update Music Library}}
|}

== Hide progress of library updates ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Hide the pop-up library scanning progress bar during scans.
|}

== Clean library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Performs cleanup tasks on the '''Music''' database. Used to de-clutter the database of unused records. Used if you have moved, deleted or renamed files. If a source is located on removable storage that is not connected at the time of the Clean Library, you will be asked to choose to remove or keep the library entries from that drive.
* Removes any songs with invalid paths
* Removes any albums which have no references
* Removes any artists which have no references
* Removes any genres which have no references
* Removes any paths which have no references
|}

== Export library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Export the contents of the video library. Used as a backup of your library or to create a new {{kodi}} installation.
For the Music library, we recommend using the Single Files method as this will also export play counts, user ratings and last played data.
: See '''[[Import-export_library/Music|Export Music Library]]'''

|}

== Import library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you exported your library using the '''Single File''' method, use this to import the single file into the music library.
: See '''[[Import-export_library/Music#Import_-_Single_File|Import Single File]]'''
|}

{{Top}}
{{updated|19}}

[[Category:Settings]]

Import-export library/Video

2022-12-15T21:04:46Z

LGoosens: Structured markup + changed flow for clarity

{|class="infobox" style="width:200px"
! Import-Export Contents
|-
|
* '''[[Import-export_library|Import-Export]]'''
** '''[[Import-export_library/Music|Music Library]]'''
** '''[[Import-export_library/Video|Video Library]]'''
* '''[[HOW-TO:Create_Video_Library|Return to Video Guide]]'''
|}

{{mininav|[[Video_library|Video Library]]|[[Import-export_library|Import Export Library]]}}
{{see also|NFO files|Artwork|Backup}}

= Watched, PlayCount, ResumePoints =
{{warning|From v20 Nexus the <importwatchedstate> and <importresumepoint> settings have been reversed. It is no longer necessary to add these tags to allow import of that data. That data will be imported by default. The tags are only required to exclude the importing of that particular data.<ref>https://github.com/xbmc/xbmc/pull/20842</ref> If these tags are already present in your advancedsettings.xml file, there is no issue if they remain.}}

By default {{kodi}} will export all data in the MyVideosxxx.db.

The Watched Status, Play Counts and Resume Points are '''not imported''' by default. By pasting the following code to the ''advancedsettings.xml'' file, any or all three items can be imported. Do not duplicate the ''<advancedsettings>'' tags if you already have the advancedsettings.xml file.
:'''false''' = Not imported
:'''true''' = Imported
:{{small see also|Advancedsettings.xml}}

<syntaxhighlight lang=xml>
<advancedsettings>
<videolibrary>
<exportautothumbs>false</exportautothumbs> 
<importwatchedstate>false</importwatchedstate> 
<importresumepoint>false</importresumepoint> 
</videolibrary>
</advancedsettings>
</syntaxhighlight>

= Export =
<gallery mode="packed" widths="500px" heights="283px">
File:LibExp01.jpg|Location of setting
File:LibExp02.png|Select which Export option you require.
</gallery>

In settings, select '''Export library''' as shown in the first image. You will be required to choose the Export method as depicted in the second image.

{{warning|If you intend to export artwork from cache, be aware of the modifications that {{kodi}} makes to cached artwork. If you have local artwork, do not export artwork.}}
'''''See: [[Artwork#Cache|Artwork Cache]]'''''

== Separate Files ==
<gallery mode="packed" widths="500px" heights="283px">
File:LibExp03.png|Do you want to export Thumbnails and Fanart?
File:LibExp05.jpg|Do you want to export Actors Thumbs?
File:LibExp04.png|Do you want to Overwrite Old Files?
</gallery>

This option will export the metadata stored in the database and save it as a '''nfo file'''. It will be saved to the same directory where that particular Movie/TV Show/Episode/Music Video is located.

{{note|Exported artwork will use the long name format of ''<videofilename>-<artworktype>.<ext>'' eg- ''Lucy (2014)-poster.jpg''}}
{{warning|If you use local artwork, do not export artwork as your original artwork may be overwritten with an inferior copy or duplicated if you use the short name format.}}

#After selecting '''Separate''', you will then be asked if you would like to '''Export thumbnails and fanart?'''. This will export all artwork that has been cached.
#*Choosing '''Yes''' will save a copy of the cached artwork into the Movie, TV Show, TV Show Episode and Music Video directory alongside the video file and the nfo file.
#*Choosing '''No''' will not export artwork
# If you selected ''Yes'' to the previous option you will be asked '''Export Actors Thumbs?'''.
#* Choosing '''Yes''' will export a copy of the Actors artwork in a directory named ''.actors''
#* Choosing '''No''' will not export a copy of the Actors artwork
# The final option is '''Overwrite Old Files?'''.
#* Choosing '''Yes''' will overwrite the existing nfo files and artwork (if selected). This is useful if you have modified your metadata such as changed the artwork, created or modified movie sets, etc. Any movies/tv shows/music videos that were not present since the last Export will have the nfo and artwork exported to their directory.
#* Choosing '''No''' will add nfo files and artwork to those movies/tv shows/music videos that do not already have them. eg they are new and added after the last export. If you made changes to a movie/tv show/music video that already has an nfo created, these changes will '''not''' be exported.
#* If this is the first time this option has been run and/or you have no nfo files and artwork saved in your movie/tv show/music video directories, both choices will have the same result.

The Export will commence immediately once the final option is selected. An onscreen progress bar will indicate progress.

== Single File ==
{{warning|'''This method is not the recommended export method'''. Do not use this method unless you have a specific need to do so '''and''' understand the following limitations:<br>
* If you rearrange files and folders after the export, the export still contains the original paths which will be imported creating dead library entries<br>
* Unless you are using Absolute file paths, you cannot build a new library on a different {{kodi}} installation<br>
* URL's to remote artwork are rewritten to the location of the export folder. You will be unable to change artwork using the "Choose Art" option, and if the export folder is deleted (which contains the exported artwork) the artwork will slowly disappear from the library
'''Use the Separate Files method detailed in the previous section'''}}

<gallery mode="packed" widths="500px" heights="283px">
File:LibExp06.jpg
</gallery>

This option will export all metadata and all artwork to a single directory, to a location nominated by the user, as follows:
*The only option available is the ''save location'' which you will be prompted and required to enter
*Kodi will create a directory in your selected location named ''xbmc_videodb_yyyy-mm-dd''
*Library metadata will be saved into a single ''videodb.xml'' file within that directory
*Artwork will be saved within multiple sub-directories according to type
*Subsequent exports '''will not''' overwrite existing Single File exports
*Subsequent exports are '''full''' exports. They are '''not''' incremental exports.

{{-}}

= Import =
Which Import method you use will depend on which Export method was used:

== Separate Files ==
If you exported your library using the '''Export to Separate Files''' option, then you must use the normal scraping process to re-import the data from the NFO Files. eg Update Library option.

:'''''See:[[Updating_or_removing_videos|Adding or Removing Videos]]'''''

== Single File ==
If you exported your library using the '''Export to Single File''' option, you will need to use this method to import the data as follows

{{note|The media Sources must be set before attempting the Import. '''''See: [[Adding_video_sources]]'''''}}

{{note|If you have removed media from the library since the export, the media will be imported into the library. You will need to run a ''Clean Library'' to remove them.}}

<gallery mode="packed-overlay" widths="500px" heights="283px">
File:LibExp01.jpg|Image 1- Select Import in the Video Library section
File:LibExp07.jpg|Image 2- Navigate and locate the correct export folder
File:LibExp08.jpg|Image 3- '''Enter''' the folder and select '''OK'''
File:LibExp09.jpg|Image 4- A progress screen will display
</gallery>

= References =
<references />

{{top}}

{{updated|19}}
[[Category:Karellen]]
[[Category:Video library]]

Settings/Media/Library

2022-12-15T20:36:08Z

LGoosens: Structured markup for clarity

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= Manage Sources =
[[File:Settings_media_library_manage_sources.jpg|500px]]

== Videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Video Sources. It is an alternate access to Videos>Files from the main menu.
{{see|HOW-TO:Create Video Library}}
|}

== Music ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Music Sources. It is an alternate access to Music>Files from the Music menu.
{{See|HOW-TO:Create Music Library}}
|}

== Pictures ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| This provides access to the Picture Sources. It is an alternate access to Pictures from the Pictures menu.
{{See|Pictures}}
|}

= Video Library =
[[File:Settings_media_library_video_library.jpg|500px]]

== Update library on startup ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Check for new video content every time {{kodi}} is started.
If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.
For alternate methods to scan new items into the library...
{{see|Updating or removing videos}}
|}

== Hide progress of library updates ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Hide the pop-up library scanning progress bar during scans.
|}

== Clean library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Remove items from the library.
Many users misunderstand this function. {{kodi}} has been designed to allow plugging and unplugging of portable hard drives. Due to this, when you run this option your media may not be deleted as expected. This is to ensure a library is not deleted because a USB HDD was unplugged.<br>
Use the correct method of removing titles from the library as detailed in the link below.<br>
After correctly deleting from the library ''first'' then run a clean library to purge the database of unnecessary records.
: See '''[[Updating_or_removing_videos#Remove_From_Library|Removing content]]'''
|}

== Export library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Export the contents of the video library. Used as a backup of your library, or to create a new {{kodi}} installation.
{{note|For the Video library, we recommend using the Separate Files method.}}
: See '''[[Import-export_library/Video|Export Video Library]]'''

|}

== Import library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you exported your library using the '''Single File''' method, use this to import the single file into the video library.
: See '''[[Import-export_library/Video#Import|Import Single File]]'''
|}

= Music Library =
[[File:Settings_media_library_music_library.jpg|500px]]

== Update library on startup ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Check for new music content every time {{kodi}} is started.
If your content does not change often, leave this disabled as it will be running and scanning for no benefit and possibly making internet API calls for unscrapable media.
For alternate methods to scan new items into the library...
{{see|Update Music Library}}
|}

== Hide progress of library updates ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Hide the pop-up library scanning progress bar during scans.
|}

== Clean library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Performs cleanup tasks on the '''Music''' database. Used to de-clutter the database of unused records. Used if you have moved, deleted or renamed files. If a source is located on removable storage that is not connected at the time of the Clean Library, you will be asked to choose to remove or keep the library entries from that drive.
* Removes any songs with invalid paths
* Removes any albums which have no references
* Removes any artists which have no references
* Removes any genres which have no references
* Removes any paths which have no references
|}

== Export library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Export the contents of the video library. Used as a backup of your library or to create a new {{kodi}} installation.
For the Music library, we recommend using the Single Files method as this will also export play counts, user ratings and last played data.
: See '''[[Import-export_library/Music|Export Music Library]]'''

|}

== Import library ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| If you exported your library using the '''Single File''' method, use this to import the single file into the music library.
: See '''[[Import-export_library/Music#Import_-_Single_File|Import Single File]]'''
|}

{{Top}}
{{updated|19}}

[[Category:Settings]]

Settings/Media/Videos

2022-12-15T18:01:11Z

LGoosens: Structured markup + changed wording for clarity

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= All =
[[File:Settings-Media-Videos-01.jpg|600px|Image 1]]

== Default select action ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
|
Allows you to change the default action when clicking on a library item.

* '''Choose''' - Always offer a pop-up box with several options ('''Resume''', '''Play''', '''Show information''', '''More...''')
* '''Play''' - ''Offer the option'' to '''Resume''' or '''Play from beginning''' if applicable, otherwise just play the item from the start
* '''Resume''' - ''Immediately'' resume videos from the last watched position if applicable, otherwise just play the item from the start
* '''Show information''' - Display the '''''[[Basic_controls#Information_Page|Information Page]]'''''
* '''Queue item''' - Add selected items to a temporary playlist (accessed through the '''''[[Basic_controls#Sideblade_Menu|Sideblade menu]]''''')
|}

== Use video tags ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Same concept as embedded tags in music files. The video library can read tags in *.mp4 or *.mkv files when this setting is enabled.<br>This feature is limited in the tags that are read and does not match the amount of metadata that can be scraped.
{{warning|••• '''Do not''' enable this setting unless you have deliberately set proper and correct tags in your video files. Incorrect tags will cause the scraper to fail on all movies containing bad embedded tags.}}
The below image is a typical example of why scraping fails in most cases. The ''Title'' usually contains junk data and the scraper will be unable to find the correct title.
[[File:VideoTags.jpg|700px]]
|}

== Extract video information from files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract file metadata such as audio and video codecs, audio stream languages, audio channel layout, aspect ratio, subtitle languages, duration.
|}

== Extract chapter thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed in chapter timeline displays used by some skins.
|}

= Files =
[[File:Settings-Media-Videos-02.jpg|600px|Image 2]]

== Combine split video items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Combines multi-part video files and DVD/Bluray folders into a single item in '''Files view'''.
{{note|Library lists are not affected by this setting.}}
|}

== Replace file names with library titles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When a file is scanned into the library it will display the scanned title instead of the filename. Disable this setting to display the filename instead.
|}
{{-}}

= Library =
[[File:Settings-Media-Videos-03.jpg|600px|Image 3]]

== Show all items entry ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show "All items" entry in library lists e.g. ''All Albums'' or ''All seasons''
|}

== Show information for unwatched items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Hide information to prevent spoilers. All information is shown by default. ''Movie plot, Episode plot'' and ''Episode thumb'' can be removed from the list.
|}

== Show movie sets ==
<section begin="Show movie sets" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
|
* When disabled, all movies are shown individually in library lists.
* When enabled, movies that are part of a "Movie set" are '''always''' grouped together and displayed as a Collection, not separately. Clicking the collection will in turn display the individual movies.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{See|Movie sets}}
|}
<section end="Show movie sets" />

== Include sets containing a single movie ==
<section begin="Show movie sets SingleMovie" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Can work with, or independently of the previous setting.
*When the previous setting is enabled and this setting is enabled, a "Movie set" entry is used even if the movie set contains only a single movie from the set.
*When the previous setting is enabled and this setting is disabled, a "Movie set" entry is used only if the movie library contains two or more movies from the set.<br>
*When this setting is enabled with or without the previous setting, sets that contain a single movie become visible in the Movie Set Editor.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{see|Movie sets}}
|}
<section end="Show movie sets SingleMovie" />

== Flatten hierarchy ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Removes the title, genre, etc. nodes from the library view. Selecting a category takes you straight to the title view
|}

== Flatten TV show seasons ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjusts when Season lists are removed from TV Show views. Instead a list of episodes from all seasons is displayed.
Options are:
* ''Never''- Season lists are always displayed
* ''If only one season''- (default) Season lists are displayed only when two or more seasons exist
* ''Always''- Hide season lists always
{{note|Cover art for individual seasons will also be hidden.}}
|}

== Show empty TV shows ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show TV shows with no episodes when browsing through the library.
|}

== Select first unwatched TV show season / episode ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled:
* When entering the seasons list, selects the first season with unwatched episodes.
* When entering the episode list, selects the first unwatched episode.
|}

=== Include "All seasons" and "Specials" ===
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Works with the previous setting. Whether or not consider the items from "All season" and "Specials" in the unwatched item selection
|}

== Movie set information folder ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Nominate the location of the Movie Set artwork.<ref>https://github.com/xbmc/xbmc/pull/16970</ref>
{{See|Movie set information folder}}
|}

== Show all performers for music videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled, shows all contributors in addition to the artists. <ref>https://github.com/xbmc/xbmc/pull/18386</ref>
|}

= Artwork =
<gallery mode="packed" widths="600px" heights="337px">
File:Settings-Media-Videos-04.jpg| Image 4 - Available settings for '''Maximum''' artwork level
File:Settings-Media-Videos-05.jpg| Image 5 - Avaialble settings for the '''Custom''' artwork level
</gallery>

{{note|These are '''new artwork settings for v19'''. These settings replace the artwork settings in scrapers and the artwork tags in the advancedsettings.xml file which are no longer needed.<ref>https://github.com/xbmc/xbmc/pull/18072</ref>}}

== Artwork level ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Allows you to choose the types of artwork to be added to {{kodi}}. Options are:
* '''Maximum''' - Scan or scrape all available '''[[Artwork types]]'''. When scanning local artwork, this setting is indiscriminate and will add ''all'' artwork found.
{{note|This includes artwork that does not conform to {{kodi}}'s naming scheme, which will not be displayed unless you have modified the skin to do so.<br>
Users with messy folders should use the Custom option instead.}}
* '''Basic''' - For users with low powered and low storage devices, scrape the minimum of ''poster, fanart'' and ''episode thumbnails'' only.
* '''Custom''' - (image 2) Create a whitelist of artwork to be scanned or scraped. If artwork tags are available in the advancedsettings.xml file, these will be read and added to the custom settings on first run of {{kodi}}
* '''None''' - No artwork will be scanned or scraped.
|}

The following four settings relate to the '''Custom''' setting.

== Movie art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for movies.
* The listed Movie artwork also extends to the equivalent for Movie Sets. E. g., ''poster'' includes Movie poster and Movie Set poster.
* {{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button.
{{note|Before adding a new art type, check it is used by the skin, as adding a new art type does not necessarily mean it will be displayed.}}
|}

== TV show art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for TV Shows.
* The listed TV show artwork also extends to the equivalent for Seasons. E. g., ''poster'' includes TV show poster and Season posters.
* {{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button.
{{note|Before adding a new art type, check it is used by the skin, as adding a new art type does not necessarily mean it will be displayed.}}
|}

== Episode art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for episodes.
* {{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button.
{{note|Before adding a new art type, check it is used by the skin, as adding a new art type does not necessarily mean it will be displayed.}}
|}

== Music Video art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for Music Videos.
* {{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button.
{{note|Before adding a new art type, check it is used by the skin, as adding a new art type does not necessarily mean it will be displayed.}}
|}

== Download actor thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Also download actor artwork when scanning/scraping media.
|}

== Extract thumbnails from video files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed when episode artwork or when movie poster or fanart are missing.
|}

= References =
<references />

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

[[Category:Settings]]

Settings/Media/Videos

2022-12-15T17:45:14Z

LGoosens: Typo + brevity

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= All =
[[File:Settings-Media-Videos-01.jpg|600px|Image 1]]

== Default select action ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
|
Allows you to change the default action when clicking on a library item.

* '''Choose''' - Always offer a pop-up box with several options ('''Resume''', '''Play''', '''Show information''', '''More...''')
* '''Play''' - ''Offer the option'' to '''Resume''' or '''Play from beginning''' if applicable, otherwise just play the item from the start
* '''Resume''' - ''Immediately'' resume videos from the last watched position if applicable, otherwise just play the item from the start
* '''Show information''' - Display the '''''[[Basic_controls#Information_Page|Information Page]]'''''
* '''Queue item''' - Add selected items to a temporary playlist (accessed through the '''''[[Basic_controls#Sideblade_Menu|Sideblade menu]]''''')
|}

== Use video tags ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Same concept as embedded tags in music files. The video library can read tags in *.mp4 or *.mkv files when this setting is enabled.<br>This feature is limited in the tags that are read and does not match the amount of metadata that can be scraped.
{{warning|••• '''Do not''' enable this setting unless you have deliberately set proper and correct tags in your video files. Incorrect tags will cause the scraper to fail on all movies containing bad embedded tags.}}
The below image is a typical example of why scraping fails in most cases. The ''Title'' usually contains junk data and the scraper will be unable to find the correct title.
[[File:VideoTags.jpg|700px]]
|}

== Extract video information from files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract file metadata such as audio and video codecs, audio stream languages, audio channel layout, aspect ratio, subtitle languages, duration.
|}

== Extract chapter thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed in chapter timeline displays used by some skins.
|}

= Files =
[[File:Settings-Media-Videos-02.jpg|600px|Image 2]]

== Combine split video items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Combines multi-part video files and DVD/Bluray folders into a single item in '''Files view'''.
{{note|Library lists are not affected by this setting.}}
|}

== Replace file names with library titles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When a file is scanned into the library it will display the scanned title instead of the filename. Disable this setting to display the filename instead.
|}
{{-}}

= Library =
[[File:Settings-Media-Videos-03.jpg|600px|Image 3]]

== Show all items entry ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show "All items" entry in library lists e.g. ''All Albums'' or ''All seasons''
|}

== Show information for unwatched items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Hide information to prevent spoilers. All information is shown by default. ''Movie plot, Episode plot'' and ''Episode thumb'' can be removed from the list.
|}

== Show movie sets ==
<section begin="Show movie sets" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
|
* When disabled, all movies are shown individually in library lists.
* When enabled, movies that are part of a "Movie set" are '''always''' grouped together and displayed as a Collection, not separately. Clicking the collection will in turn display the individual movies.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{See|Movie sets}}
|}
<section end="Show movie sets" />

== Include sets containing a single movie ==
<section begin="Show movie sets SingleMovie" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Can work with, or independently of the previous setting.
*When the previous setting is enabled and this setting is enabled, a "Movie set" entry is used even if the movie set contains only a single movie from the set.
*When the previous setting is enabled and this setting is disabled, a "Movie set" entry is used only if the movie library contains two or more movies from the set.<br>
*When this setting is enabled with or without the previous setting, sets that contain a single movie become visible in the Movie Set Editor.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{see|Movie sets}}
|}
<section end="Show movie sets SingleMovie" />

== Flatten hierarchy ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Removes the title, genre, etc. nodes from the library view. Selecting a category takes you straight to the title view
|}

== Flatten TV show seasons ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjusts when Season lists are removed from TV Show views. Instead a list of episodes from all seasons is displayed.
Options are:
* ''Never''- Season lists are always displayed
* ''If only one season''- (default) Season lists are displayed only when two or more seasons exist
* ''Always''- Hide season lists always
{{note|Cover art for individual seasons will also be hidden.}}
|}

== Show empty TV shows ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show TV shows with no episodes when browsing through the library.
|}

== Select first unwatched TV show season / episode ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled:
* When entering the seasons list, selects the first season with unwatched episodes.
* When entering the episode list, selects the first unwatched episode.
|}

=== Include "All seasons" and "Specials" ===
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Works with the previous setting. Whether or not consider the items from "All season" and "Specials" in the unwatched item selection
|}

== Movie set information folder ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Nominate the location of the Movie Set artwork.<ref>https://github.com/xbmc/xbmc/pull/16970</ref>
{{See|Movie set information folder}}
|}

== Show all performers for music videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled, shows all contributors in addition to the artists. <ref>https://github.com/xbmc/xbmc/pull/18386</ref>
|}

= Artwork =
<gallery mode="packed" widths="600px" heights="337px">
File:Settings-Media-Videos-04.jpg| Image 4 - Available settings for '''Maximum''' artwork level
File:Settings-Media-Videos-05.jpg| Image 5 - Avaialble settings for the '''Custom''' artwork level
</gallery>

These are '''new artwork settings for v19'''. These settings replace the artwork settings in scrapers and the artwork tags in the advancedsettings.xml file which are no longer needed.<ref>https://github.com/xbmc/xbmc/pull/18072</ref>

== Artwork level ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Allows you to choose the types of artwork to be added to {{kodi}}. Options are:
* '''Maximum'''- Scan or scrape all available '''[[Artwork types]]'''. When scanning local artwork, this setting is indiscriminate and will add ''all'' artwork found, even artwork that does not conform to {{kodi}}'s naming scheme, which will not be displayed unless you have modified the skin to do so. Users with messy folders should use the Custom option instead.
* '''Basic'''- For users with low powered and low storage devices, scrape the minimum of ''poster, fanart'' and ''episode thumbnails'' only.
* '''Custom'''- (image 2) Create a whitelist of artwork to be scanned or scraped. If artwork tags are available in the advancedsettings.xml file, these will be read and added to the custom settings on first run of {{kodi}}
* '''None'''- No artwork will be scanned or scraped.
|}

The following four settings relate to the '''Custom''' setting.

== Movie art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for movies.
The listed Movie artwork also extends to the equivelant for Movie Sets. eg, ''poster'' includes Movie poster and Movie Set poster.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== TV show art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for TV Shows.
The listed TV show artwork also extends to the equivelant for Seasons. eg, ''poster'' includes TV show poster and Season posters.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Episode art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for episodes.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Music Video art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for Music Videos.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Download actor thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Also download actor artwork when scanning/scraping media.
|}

== Extract thumbnails from video files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed when episode artwork or when movie poster or fanart are missing.
|}

= References =
<references />

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

[[Category:Settings]]

Settings/Media/Videos

2022-12-15T17:43:14Z

LGoosens: Structured markup + changed flow for clarity

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= All =
[[File:Settings-Media-Videos-01.jpg|600px|Image 1]]

== Default select action ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
|
Allows you to change the default action when clicking on a library item.

* '''Choose''' - Always offer a pop-up box with several options ('''Resume''', '''Play''', '''Show information''', '''More...''')
* '''Play''' - ''Offer the option'' to '''Resume''' or '''Play from beginning''' if applicable, otherwise just play the item from the start
* '''Resume''' - ''Immediately'' resume videos from the last watched position if applicable, otherwise just play the item from the start
* '''Show information''' - Display the '''''[[Basic_controls#Information_Page|Information Page]]'''''
* '''Queue item''' - Add selected items to a temporary playlist (accessed through the '''''[[Basic_controls#Sideblade_Menu|Sideblade menu]]''''')
|}

== Use video tags ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Same concept as embedded tags in music files. The video library can read tags in *.mp4 or *.mkv files when this setting is enabled.<br>This feature is limited in the tags that are read and does not match the amount of metadata that can be scraped.
{{warning|••• '''Do not''' enable this setting unless you have deliberately set proper and correct tags in your video files. Incorrect tags will cause the scraper to fail on all movies containing bad embedded tags.}}
The below image is a typical example of why scraping fails in most cases. The ''Title'' usually contains junk data and the scraper will be unable to find the correct title.
[[File:VideoTags.jpg|700px]]
|}

== Extract video information from files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract file metadata such as audio and video codecs, audio stream languages, audio channel layout, aspect ratio, subtitle languages, duration.
|}

== Extract chapter thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed in chapter timeline displays used by some skins.
|}

= Files =
[[File:Settings-Media-Videos-02.jpg|600px|Image 2]]

== Combine split video items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Combines multi-part video files and DVD/Bluray folders into a single item in '''Files view'''.
{{note|Library lists are not affected by this setting.}}
|}

== Replace file names with library titles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When a file is scanned into the library it will display the scanned title instead of the filename. Disable this setting to display the filename instead.
|}
{{-}}

= Library =
[[File:Settings-Media-Videos-03.jpg|600px|Image 3]]

== Show all items entry ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show "All items" entry in library lists e.g. ''All Albums'' or ''All seasons''
|}

== Show information for unwatched items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Hide informamtion to prevent spoilers. All information is shown by default. Remove an item from the list to hide information and avoid spoilers
''Movie plot, Episode plot'' and ''Episode thumb'' can be hidden.
|}

== Show movie sets ==
<section begin="Show movie sets" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
|
* When disabled, all movies are shown individually in library lists.
* When enabled, movies that are part of a "Movie set" are '''always''' grouped together and displayed as a Collection, not separately. Clicking the collection will in turn display the individual movies.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{See|Movie sets}}
|}
<section end="Show movie sets" />

== Include sets containing a single movie ==
<section begin="Show movie sets SingleMovie" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Can work with, or independently of the previous setting.
*When the previous setting is enabled and this setting is enabled, a "Movie set" entry is used even if the movie set contains only a single movie from the set.
*When the previous setting is enabled and this setting is disabled, a "Movie set" entry is used only if the movie library contains two or more movies from the set.<br>
*When this setting is enabled with or without the previous setting, sets that contain a single movie become visible in the Movie Set Editor.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{see|Movie sets}}
|}
<section end="Show movie sets SingleMovie" />

== Flatten hierarchy ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Removes the title, genre, etc. nodes from the library view. Selecting a category takes you straight to the title view
|}

== Flatten TV show seasons ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjusts when Season lists are removed from TV Show views. Instead a list of episodes from all seasons is displayed.
Options are:
* ''Never''- Season lists are always displayed
* ''If only one season''- (default) Season lists are displayed only when two or more seasons exist
* ''Always''- Hide season lists always
{{note|Cover art for individual seasons will also be hidden.}}
|}

== Show empty TV shows ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show TV shows with no episodes when browsing through the library.
|}

== Select first unwatched TV show season / episode ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled:
* When entering the seasons list, selects the first season with unwatched episodes.
* When entering the episode list, selects the first unwatched episode.
|}

=== Include "All seasons" and "Specials" ===
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Works with the previous setting. Whether or not consider the items from "All season" and "Specials" in the unwatched item selection
|}

== Movie set information folder ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Nominate the location of the Movie Set artwork.<ref>https://github.com/xbmc/xbmc/pull/16970</ref>
{{See|Movie set information folder}}
|}

== Show all performers for music videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled, shows all contributors in addition to the artists. <ref>https://github.com/xbmc/xbmc/pull/18386</ref>
|}

= Artwork =
<gallery mode="packed" widths="600px" heights="337px">
File:Settings-Media-Videos-04.jpg| Image 4 - Available settings for '''Maximum''' artwork level
File:Settings-Media-Videos-05.jpg| Image 5 - Avaialble settings for the '''Custom''' artwork level
</gallery>

These are '''new artwork settings for v19'''. These settings replace the artwork settings in scrapers and the artwork tags in the advancedsettings.xml file which are no longer needed.<ref>https://github.com/xbmc/xbmc/pull/18072</ref>

== Artwork level ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Allows you to choose the types of artwork to be added to {{kodi}}. Options are:
* '''Maximum'''- Scan or scrape all available '''[[Artwork types]]'''. When scanning local artwork, this setting is indiscriminate and will add ''all'' artwork found, even artwork that does not conform to {{kodi}}'s naming scheme, which will not be displayed unless you have modified the skin to do so. Users with messy folders should use the Custom option instead.
* '''Basic'''- For users with low powered and low storage devices, scrape the minimum of ''poster, fanart'' and ''episode thumbnails'' only.
* '''Custom'''- (image 2) Create a whitelist of artwork to be scanned or scraped. If artwork tags are available in the advancedsettings.xml file, these will be read and added to the custom settings on first run of {{kodi}}
* '''None'''- No artwork will be scanned or scraped.
|}

The following four settings relate to the '''Custom''' setting.

== Movie art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for movies.
The listed Movie artwork also extends to the equivelant for Movie Sets. eg, ''poster'' includes Movie poster and Movie Set poster.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== TV show art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for TV Shows.
The listed TV show artwork also extends to the equivelant for Seasons. eg, ''poster'' includes TV show poster and Season posters.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Episode art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for episodes.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Music Video art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for Music Videos.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Download actor thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Also download actor artwork when scanning/scraping media.
|}

== Extract thumbnails from video files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed when episode artwork or when movie poster or fanart are missing.
|}

= References =
<references />

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

[[Category:Settings]]

Settings/Media/Videos

2022-12-15T17:38:48Z

LGoosens: Changed/added for clarification

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= All =
[[File:Settings-Media-Videos-01.jpg|600px|Image 1]]

== Default select action ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
|
Allows you to change the default action when clicking on a library item.

* '''Choose''' - Always offer a pop-up box with several options ('''Resume''', '''Play''', '''Show information''', '''More...''')
* '''Play''' - ''Offer the option'' to '''Resume''' or '''Play from beginning''' if applicable, otherwise just play the item from the start
* '''Resume''' - ''Immediately'' resume videos from the last watched position if applicable, otherwise just play the item from the start
* '''Show information''' - Display the '''''[[Basic_controls#Information_Page|Information Page]]'''''
* '''Queue item''' - Add selected items to a temporary playlist (accessed through the '''''[[Basic_controls#Sideblade_Menu|Sideblade menu]]''''')
|}

== Use video tags ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Same concept as embedded tags in music files. The video library can read tags in *.mp4 or *.mkv files when this setting is enabled.<br>This feature is limited in the tags that are read and does not match the amount of metadata that can be scraped.
{{warning|••• '''Do not''' enable this setting unless you have deliberately set proper and correct tags in your video files. Incorrect tags will cause the scraper to fail on all movies containing bad embedded tags.}}
The below image is a typical example of why scraping fails in most cases. The ''Title'' usually contains junk data and the scraper will be unable to find the correct title.
[[File:VideoTags.jpg|700px]]
|}

== Extract video information from files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract file metadata such as audio and video codecs, audio stream languages, audio channel layout, aspect ratio, subtitle languages, duration.
|}

== Extract chapter thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed in chapter timeline displays used by some skins.
|}

= Files =
[[File:Settings-Media-Videos-02.jpg|600px|Image 2]]

== Combine split video items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Combines multi-part video files and DVD/Bluray folders into a single item in '''Files view'''.
Has no affect on library lists.
|}

== Replace file names with library titles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When a file is scanned into the library it will display the scanned title instead of the filename. Disable this setting to display the filename instead.
|}
{{-}}

= Library =
[[File:Settings-Media-Videos-03.jpg|600px|Image 3]]

== Show all items entry ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show "All items" entry in library lists e.g. ''All Albums'' or ''All seasons''
|}

== Show information for unwatched items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Hide informamtion to prevent spoilers. All information is shown by default. Remove an item from the list to hide information and avoid spoilers
''Movie plot, Episode plot'' and ''Episode thumb'' can be hidden.
|}

== Show movie sets ==
<section begin="Show movie sets" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
|
* When disabled, all movies are shown individually in library lists.
* When enabled, movies that are part of a "Movie set" are '''always''' grouped together and displayed as a Collection, not separately. Clicking the collection will in turn display the individual movies.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{See|Movie sets}}
|}
<section end="Show movie sets" />

== Include sets containing a single movie ==
<section begin="Show movie sets SingleMovie" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Can work with, or independently of the previous setting.
*When the previous setting is enabled and this setting is enabled, a "Movie set" entry is used even if the movie set contains only a single movie from the set.
*When the previous setting is enabled and this setting is disabled, a "Movie set" entry is used only if the movie library contains two or more movies from the set.<br>
*When this setting is enabled with or without the previous setting, sets that contain a single movie become visible in the Movie Set Editor.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{see|Movie sets}}
|}
<section end="Show movie sets SingleMovie" />

== Flatten hierarchy ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Removes the title, genre, etc. nodes from the library view. Selecting a category takes you straight to the title view
|}

== Flatten TV show seasons ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjusts when Season lists are removed from TV Show views. Instead a list of episodes from all seasons is displayed.
Options are:
* ''Never''- Season lists are always displayed
* ''If only one season''- (default) Season lists are displayed only when two or more seasons exist
* ''Always''- Hide season lists always
{{note|Cover art for individual seasons will also be hidden.}}
|}

== Show empty TV shows ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show TV shows with no episodes when browsing through the library.
|}

== Select first unwatched TV show season / episode ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled:
* When entering the seasons list, selects the first season with unwatched episodes.
* When entering the episode list, selects the first unwatched episode.
|}

=== Include "All seasons" and "Specials" ===
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Works with the previous setting. Whether or not consider the items from "All season" and "Specials" in the unwatched item selection
|}

== Movie set information folder ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Nominate the location of the Movie Set artwork.<ref>https://github.com/xbmc/xbmc/pull/16970</ref>
{{See|Movie set information folder}}
|}

== Show all performers for music videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled, shows all contributors in addition to the artists. <ref>https://github.com/xbmc/xbmc/pull/18386</ref>
|}

= Artwork =
<gallery mode="packed" widths="600px" heights="337px">
File:Settings-Media-Videos-04.jpg| Image 4 - Available settings for '''Maximum''' artwork level
File:Settings-Media-Videos-05.jpg| Image 5 - Avaialble settings for the '''Custom''' artwork level
</gallery>

These are '''new artwork settings for v19'''. These settings replace the artwork settings in scrapers and the artwork tags in the advancedsettings.xml file which are no longer needed.<ref>https://github.com/xbmc/xbmc/pull/18072</ref>

== Artwork level ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Allows you to choose the types of artwork to be added to {{kodi}}. Options are:
* '''Maximum'''- Scan or scrape all available '''[[Artwork types]]'''. When scanning local artwork, this setting is indiscriminate and will add ''all'' artwork found, even artwork that does not conform to {{kodi}}'s naming scheme, which will not be displayed unless you have modified the skin to do so. Users with messy folders should use the Custom option instead.
* '''Basic'''- For users with low powered and low storage devices, scrape the minimum of ''poster, fanart'' and ''episode thumbnails'' only.
* '''Custom'''- (image 2) Create a whitelist of artwork to be scanned or scraped. If artwork tags are available in the advancedsettings.xml file, these will be read and added to the custom settings on first run of {{kodi}}
* '''None'''- No artwork will be scanned or scraped.
|}

The following four settings relate to the '''Custom''' setting.

== Movie art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for movies.
The listed Movie artwork also extends to the equivelant for Movie Sets. eg, ''poster'' includes Movie poster and Movie Set poster.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== TV show art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for TV Shows.
The listed TV show artwork also extends to the equivelant for Seasons. eg, ''poster'' includes TV show poster and Season posters.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Episode art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for episodes.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Music Video art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for Music Videos.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Download actor thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Also download actor artwork when scanning/scraping media.
|}

== Extract thumbnails from video files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed when episode artwork or when movie poster or fanart are missing.
|}

= References =
<references />

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

[[Category:Settings]]

Settings/Media/Videos

2022-12-15T17:22:51Z

LGoosens: Typo

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= All =
[[File:Settings-Media-Videos-01.jpg|600px|Image 1]]

== Default select action ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
|
Allows you to change the default action when clicking on a library item.

Available options are: '''Choose''', '''Play''', '''Resume''', '''Show information''' and '''Queue item'''

* '''Choose'''- A pop-up box with various actions you can ''choose'' from.
* '''Play'''- Play the item immediately
* '''Resume'''- Kodi will resume videos from the last watched position. If there is no last watched position, playback will commence from the start of the movie
* '''Show information'''- Display the '''''[[Basic_controls#Information_Page|Information Page]]'''''
* '''Queue item'''- Add selected items to a temporary playlist. Use the '''''[[Basic_controls#Sideblade_Menu|Sideblade menu]]''''' to then access the playlist
|}

== Use video tags ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Same concept as embedded tags in music files. The video library can read tags in *.mp4 or *.mkv files when this setting is enabled.<br>This feature is limited in the tags that are read and does not match the amount of metadata that can be scraped.
{{warning|••• '''Do not''' enable this setting unless you have deliberately set proper and correct tags in your video files. Incorrect tags will cause the scraper to fail on all movies containing bad embedded tags.}}
The below image is a typical example of why scraping fails in most cases. The ''Title'' usually contains junk data and the scraper will be unable to find the correct title.
[[File:VideoTags.jpg|700px]]
|}

== Extract video information from files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract file metadata such as audio and video codecs, audio stream languages, audio channel layout, aspect ratio, subtitle languages, duration.
|}

== Extract chapter thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed in chapter timeline displays used by some skins.
|}

= Files =
[[File:Settings-Media-Videos-02.jpg|600px|Image 2]]

== Combine split video items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Combines multi-part video files and DVD/Bluray folders into a single item in '''Files view'''.
Has no affect on library lists.
|}

== Replace file names with library titles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When a file is scanned into the library it will display the scanned title instead of the filename. Disable this setting to display the filename instead.
|}
{{-}}

= Library =
[[File:Settings-Media-Videos-03.jpg|600px|Image 3]]

== Show all items entry ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show "All items" entry in library lists e.g. ''All Albums'' or ''All seasons''
|}

== Show information for unwatched items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Hide informamtion to prevent spoilers. All information is shown by default. Remove an item from the list to hide information and avoid spoilers
''Movie plot, Episode plot'' and ''Episode thumb'' can be hidden.
|}

== Show movie sets ==
<section begin="Show movie sets" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
|
* When disabled, all movies are shown individually in library lists.
* When enabled, movies that are part of a "Movie set" are '''always''' grouped together and displayed as a Collection, not separately. Clicking the collection will in turn display the individual movies.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{See|Movie sets}}
|}
<section end="Show movie sets" />

== Include sets containing a single movie ==
<section begin="Show movie sets SingleMovie" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Can work with, or independently of the previous setting.
*When the previous setting is enabled and this setting is enabled, a "Movie set" entry is used even if the movie set contains only a single movie from the set.
*When the previous setting is enabled and this setting is disabled, a "Movie set" entry is used only if the movie library contains two or more movies from the set.<br>
*When this setting is enabled with or without the previous setting, sets that contain a single movie become visible in the Movie Set Editor.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{see|Movie sets}}
|}
<section end="Show movie sets SingleMovie" />

== Flatten hierarchy ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Removes the title, genre, etc. nodes from the library view. Selecting a category takes you straight to the title view
|}

== Flatten TV show seasons ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjusts when Season lists are removed from TV Show views. Instead a list of episodes from all seasons is displayed.
Options are:
* ''Never''- Season lists are always displayed
* ''If only one season''- (default) Season lists are displayed only when two or more seasons exist
* ''Always''- Hide season lists always
{{note|Cover art for individual seasons will also be hidden.}}
|}

== Show empty TV shows ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show TV shows with no episodes when browsing through the library.
|}

== Select first unwatched TV show season / episode ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled:
* When entering the seasons list, selects the first season with unwatched episodes.
* When entering the episode list, selects the first unwatched episode.
|}

=== Include "All seasons" and "Specials" ===
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Works with the previous setting. Whether or not consider the items from "All season" and "Specials" in the unwatched item selection
|}

== Movie set information folder ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Nominate the location of the Movie Set artwork.<ref>https://github.com/xbmc/xbmc/pull/16970</ref>
{{See|Movie set information folder}}
|}

== Show all performers for music videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled, shows all contributors in addition to the artists. <ref>https://github.com/xbmc/xbmc/pull/18386</ref>
|}

= Artwork =
<gallery mode="packed" widths="600px" heights="337px">
File:Settings-Media-Videos-04.jpg| Image 4 - Available settings for '''Maximum''' artwork level
File:Settings-Media-Videos-05.jpg| Image 5 - Avaialble settings for the '''Custom''' artwork level
</gallery>

These are '''new artwork settings for v19'''. These settings replace the artwork settings in scrapers and the artwork tags in the advancedsettings.xml file which are no longer needed.<ref>https://github.com/xbmc/xbmc/pull/18072</ref>

== Artwork level ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Allows you to choose the types of artwork to be added to {{kodi}}. Options are:
* '''Maximum'''- Scan or scrape all available '''[[Artwork types]]'''. When scanning local artwork, this setting is indiscriminate and will add ''all'' artwork found, even artwork that does not conform to {{kodi}}'s naming scheme, which will not be displayed unless you have modified the skin to do so. Users with messy folders should use the Custom option instead.
* '''Basic'''- For users with low powered and low storage devices, scrape the minimum of ''poster, fanart'' and ''episode thumbnails'' only.
* '''Custom'''- (image 2) Create a whitelist of artwork to be scanned or scraped. If artwork tags are available in the advancedsettings.xml file, these will be read and added to the custom settings on first run of {{kodi}}
* '''None'''- No artwork will be scanned or scraped.
|}

The following four settings relate to the '''Custom''' setting.

== Movie art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for movies.
The listed Movie artwork also extends to the equivelant for Movie Sets. eg, ''poster'' includes Movie poster and Movie Set poster.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== TV show art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for TV Shows.
The listed TV show artwork also extends to the equivelant for Seasons. eg, ''poster'' includes TV show poster and Season posters.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Episode art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for episodes.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Music Video art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for Music Videos.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Download actor thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Also download actor artwork when scanning/scraping media.
|}

== Extract thumbnails from video files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed when episode artwork or when movie poster or fanart are missing.
|}

= References =
<references />

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

[[Category:Settings]]

Settings/Media/Videos

2022-12-15T17:21:50Z

LGoosens: Structured markup + changed wording for clarity

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= All =
[[File:Settings-Media-Videos-01.jpg|600px|Image 1]]

== Default select action ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
|
Allows you to change the default action when clicking on a library item.

Available options are: '''Choose''', '''Play''', '''Resume''', '''Show information''' and '''Queue item'''

* '''Choose'''- A pop-up box with various actions you can ''choose'' from.
* '''Play'''- Play the item immediately
* '''Resume'''- Kodi will resume videos from the last watched position. If there is no last watched position, playback will commence from the start of the movie
* '''Show information'''- Display the '''''[[Basic_controls#Information_Page|Information Page]]'''''
* '''Queue item'''- Add selected items to a temporary playlist. Use the '''''[[Basic_controls#Sideblade_Menu|Sideblade menu]]''''' to then access the playlist
|}

== Use video tags ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Same concept as embedded tags in music files. The video library can read tags in *.mp4 or *.mkv files when this setting is enabled.<br>This feature is limited in the tags that are read and does not match the amount of metadata that can be scraped.
{{warning|••• '''Do not''' enable this setting unless you have deliberately set proper and correct tags in your video files. Incorrect tags will cause the scraper to fail on all movies containing bad embedded tags.}}
The below image is a typical example of why scraping fails in most cases. The ''Title'' usually contains junk data and the scraper will be unable to find the correct title.
[[File:VideoTags.jpg|700px]]
|}

== Extract video information from files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract file metadata such as audio and video codecs, audio stream languages, audio channel layout, aspect ratio, subtitle languages, duration.
|}

== Extract chapter thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed in chapter timeline displays used by some skins.
|}

= Files =
[[File:Settings-Media-Videos-02.jpg|600px|Image 2]]

== Combine split video items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Combines multi-part video files and DVD/Bluray folders into a single item in '''Files view'''.
Has no affect on library lists.
|}

== Replace file names with library titles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When a file is scanned into the library it will display the scanned title instead of the filename. Disable this setting to display the filename instead.
|}
{{-}}

= Library =
[[File:Settings-Media-Videos-03.jpg|600px|Image 3]]

== Show all items entry ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show "All items" entry in library lists e.g. ''All Albums'' or ''All seasons''
|}

== Show information for unwatched items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Hide informamtion to prevent spoilers. All information is shown by default. Remove an item from the list to hide information and avoid spoilers
''Movie plot, Episode plot'' and ''Episode thumb'' can be hidden.
|}

== Show movie sets ==
<section begin="Show movie sets" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
|
* When disabled, all movies are shown individually in library lists.
* When enabled, movies that are part of a "Movie set" are '''always''' grouped together and displayed as a Collection, not separately. Clicking the collection will in turn display the individual movies.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{See|Movie sets}}
|}
<section end="Show movie sets" />

== Include sets containing a single movie ==
<section begin="Show movie sets SingleMovie" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Can work with, or independently of the previous setting.
*When the previous setting is enabled and this setting is enabled, a "Movie set" entry is used even if the movie set contains only a single movie from the set.
*When the previous setting is enabled and this setting is disabled, a "Movie set" entry is used only if the movie library contains two or more movies from the set.<br>
*When this setting is enabled with or without the previous setting, sets that contain a single movie become visible in the Movie Set Editor.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{see|Movie sets}}
|}
<section end="Show movie sets SingleMovie" />

== Flatten hierarchy ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Removes the title, genre, etc. nodes from the library view. Selecting a category takes you straight to the title view
|}

== Flatten TV show seasons ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjusts when Season lists are removed from TV Show views. Instead a list of episodes from all seasons is displayed.
Options are:
* ''Never''- Season lists are always displayed
* ''If only one season''- (default) Season lists are displayed only when two or more seasons exist
* ''Always''- Hide season lists always
{{note|Cover art for individual seasons will also be hidden.}}
|}

== Show empty TV shows ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show TV shows with no episodes when browsing through the library.
|}

== Select first unwatched TV show season / episode ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled:
* When entering the seasons list, selects the first season with unwatched episodes.
* When etering the episode list, selects the first unwatched episode.
|}

=== Include "All seasons" and "Specials" ===
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Works with the previous setting. Whether or not consider the items from "All season" and "Specials" in the unwatched item selection
|}

== Movie set information folder ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Nominate the location of the Movie Set artwork.<ref>https://github.com/xbmc/xbmc/pull/16970</ref>
{{See|Movie set information folder}}
|}

== Show all performers for music videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled, shows all contributors in addition to the artists. <ref>https://github.com/xbmc/xbmc/pull/18386</ref>
|}

= Artwork =
<gallery mode="packed" widths="600px" heights="337px">
File:Settings-Media-Videos-04.jpg| Image 4 - Available settings for '''Maximum''' artwork level
File:Settings-Media-Videos-05.jpg| Image 5 - Avaialble settings for the '''Custom''' artwork level
</gallery>

These are '''new artwork settings for v19'''. These settings replace the artwork settings in scrapers and the artwork tags in the advancedsettings.xml file which are no longer needed.<ref>https://github.com/xbmc/xbmc/pull/18072</ref>

== Artwork level ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Allows you to choose the types of artwork to be added to {{kodi}}. Options are:
* '''Maximum'''- Scan or scrape all available '''[[Artwork types]]'''. When scanning local artwork, this setting is indiscriminate and will add ''all'' artwork found, even artwork that does not conform to {{kodi}}'s naming scheme, which will not be displayed unless you have modified the skin to do so. Users with messy folders should use the Custom option instead.
* '''Basic'''- For users with low powered and low storage devices, scrape the minimum of ''poster, fanart'' and ''episode thumbnails'' only.
* '''Custom'''- (image 2) Create a whitelist of artwork to be scanned or scraped. If artwork tags are available in the advancedsettings.xml file, these will be read and added to the custom settings on first run of {{kodi}}
* '''None'''- No artwork will be scanned or scraped.
|}

The following four settings relate to the '''Custom''' setting.

== Movie art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for movies.
The listed Movie artwork also extends to the equivelant for Movie Sets. eg, ''poster'' includes Movie poster and Movie Set poster.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== TV show art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for TV Shows.
The listed TV show artwork also extends to the equivelant for Seasons. eg, ''poster'' includes TV show poster and Season posters.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Episode art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for episodes.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Music Video art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for Music Videos.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Download actor thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Also download actor artwork when scanning/scraping media.
|}

== Extract thumbnails from video files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed when episode artwork or when movie poster or fanart are missing.
|}

= References =
<references />

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

[[Category:Settings]]

Settings/Media/Videos

2022-12-15T17:19:43Z

LGoosens: Structured markup + changed wording for clarity

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= All =
[[File:Settings-Media-Videos-01.jpg|600px|Image 1]]

== Default select action ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
|
Allows you to change the default action when clicking on a library item.

Available options are: '''Choose''', '''Play''', '''Resume''', '''Show information''' and '''Queue item'''

* '''Choose'''- A pop-up box with various actions you can ''choose'' from.
* '''Play'''- Play the item immediately
* '''Resume'''- Kodi will resume videos from the last watched position. If there is no last watched position, playback will commence from the start of the movie
* '''Show information'''- Display the '''''[[Basic_controls#Information_Page|Information Page]]'''''
* '''Queue item'''- Add selected items to a temporary playlist. Use the '''''[[Basic_controls#Sideblade_Menu|Sideblade menu]]''''' to then access the playlist
|}

== Use video tags ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Same concept as embedded tags in music files. The video library can read tags in *.mp4 or *.mkv files when this setting is enabled.<br>This feature is limited in the tags that are read and does not match the amount of metadata that can be scraped.
{{warning|••• '''Do not''' enable this setting unless you have deliberately set proper and correct tags in your video files. Incorrect tags will cause the scraper to fail on all movies containing bad embedded tags.}}
The below image is a typical example of why scraping fails in most cases. The ''Title'' usually contains junk data and the scraper will be unable to find the correct title.
[[File:VideoTags.jpg|700px]]
|}

== Extract video information from files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract file metadata such as audio and video codecs, audio stream languages, audio channel layout, aspect ratio, subtitle languages, duration.
|}

== Extract chapter thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed in chapter timeline displays used by some skins.
|}

= Files =
[[File:Settings-Media-Videos-02.jpg|600px|Image 2]]

== Combine split video items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Combines multi-part video files and DVD/Bluray folders into a single item in '''Files view'''.
Has no affect on library lists.
|}

== Replace file names with library titles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When a file is scanned into the library it will display the scanned title instead of the filename. Disable this setting to display the filename instead.
|}
{{-}}

= Library =
[[File:Settings-Media-Videos-03.jpg|600px|Image 3]]

== Show all items entry ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show "All items" entry in library lists e.g. ''All Albums'' or ''All seasons''
|}

== Show information for unwatched items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Hide informamtion to prevent spoilers. All information is shown by default. Remove an item from the list to hide information and avoid spoilers
''Movie plot, Episode plot'' and ''Episode thumb'' can be hidden.
|}

== Show movie sets ==
<section begin="Show movie sets" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
|
* When disabled, all movies are shown individually in library lists.
* When enabled, movies that are part of a "Movie set" are '''always''' grouped together and displayed as a Collection, not separately. Clicking the collection will in turn display the individual movies.

{{note|The separate ''Movie Sets'' node is not affected by this setting.}}
{{See|Movie sets}}
|}
<section end="Show movie sets" />

== Include sets containing a single movie ==
<section begin="Show movie sets SingleMovie" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Can work with, or independently of the previous setting.
*When the previous setting is enabled and this setting is enabled, a "Movie set" entry is used even if the movie set contains only a single movie from the set.
*When the previous setting is enabled and this setting is disabled, a "Movie set" entry is used only if the movie library contains two or more movies from the set.<br>
*When this setting is enabled with or without the previous setting, sets that contain a single movie become visible in the Movie Set Editor.
*This setting has no affect on the Movie Sets node
{{see|Movie sets}}
|}
<section end="Show movie sets SingleMovie" />

== Flatten hierarchy ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Removes the title, genre, etc. nodes from the library view. Selecting a category takes you straight to the title view
|}

== Flatten TV show seasons ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjusts when Season lists are removed from TV Show views. Instead a list of episodes from all seasons is displayed.
Options are:
* ''Never''- Season lists are always displayed
* ''If only one season''- (default) Season lists are displayed only when two or more seasons exist
* ''Always''- Hide season lists always
{{note|Cover art for individual seasons will also be hidden.}}
|}

== Show empty TV shows ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show TV shows with no episodes when browsing through the library.
|}

== Select first unwatched TV show season / episode ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled:
* When entering the seasons list, selects the first season with unwatched episodes.
* When etering the episode list, selects the first unwatched episode.
|}

=== Include "All seasons" and "Specials" ===
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Works with the previous setting. Whether or not consider the items from "All season" and "Specials" in the unwatched item selection
|}

== Movie set information folder ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Nominate the location of the Movie Set artwork.<ref>https://github.com/xbmc/xbmc/pull/16970</ref>
{{See|Movie set information folder}}
|}

== Show all performers for music videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled, shows all contributors in addition to the artists. <ref>https://github.com/xbmc/xbmc/pull/18386</ref>
|}

= Artwork =
<gallery mode="packed" widths="600px" heights="337px">
File:Settings-Media-Videos-04.jpg| Image 4 - Available settings for '''Maximum''' artwork level
File:Settings-Media-Videos-05.jpg| Image 5 - Avaialble settings for the '''Custom''' artwork level
</gallery>

These are '''new artwork settings for v19'''. These settings replace the artwork settings in scrapers and the artwork tags in the advancedsettings.xml file which are no longer needed.<ref>https://github.com/xbmc/xbmc/pull/18072</ref>

== Artwork level ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Allows you to choose the types of artwork to be added to {{kodi}}. Options are:
* '''Maximum'''- Scan or scrape all available '''[[Artwork types]]'''. When scanning local artwork, this setting is indiscriminate and will add ''all'' artwork found, even artwork that does not conform to {{kodi}}'s naming scheme, which will not be displayed unless you have modified the skin to do so. Users with messy folders should use the Custom option instead.
* '''Basic'''- For users with low powered and low storage devices, scrape the minimum of ''poster, fanart'' and ''episode thumbnails'' only.
* '''Custom'''- (image 2) Create a whitelist of artwork to be scanned or scraped. If artwork tags are available in the advancedsettings.xml file, these will be read and added to the custom settings on first run of {{kodi}}
* '''None'''- No artwork will be scanned or scraped.
|}

The following four settings relate to the '''Custom''' setting.

== Movie art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for movies.
The listed Movie artwork also extends to the equivelant for Movie Sets. eg, ''poster'' includes Movie poster and Movie Set poster.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== TV show art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for TV Shows.
The listed TV show artwork also extends to the equivelant for Seasons. eg, ''poster'' includes TV show poster and Season posters.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Episode art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for episodes.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Music Video art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for Music Videos.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Download actor thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Also download actor artwork when scanning/scraping media.
|}

== Extract thumbnails from video files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed when episode artwork or when movie poster or fanart are missing.
|}

= References =
<references />

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

[[Category:Settings]]

Settings/Media/Videos

2022-12-15T17:13:17Z

LGoosens: Added note from own experience

{{mininav| [[Settings]] | [[Settings/Media|Media]] }}

__TOC__

= All =
[[File:Settings-Media-Videos-01.jpg|600px|Image 1]]

== Default select action ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
|
Allows you to change the default action when clicking on a library item.

Available options are: '''Choose''', '''Play''', '''Resume''', '''Show information''' and '''Queue item'''

* '''Choose'''- A pop-up box with various actions you can ''choose'' from.
* '''Play'''- Play the item immediately
* '''Resume'''- Kodi will resume videos from the last watched position. If there is no last watched position, playback will commence from the start of the movie
* '''Show information'''- Display the '''''[[Basic_controls#Information_Page|Information Page]]'''''
* '''Queue item'''- Add selected items to a temporary playlist. Use the '''''[[Basic_controls#Sideblade_Menu|Sideblade menu]]''''' to then access the playlist
|}

== Use video tags ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Same concept as embedded tags in music files. The video library can read tags in *.mp4 or *.mkv files when this setting is enabled.<br>This feature is limited in the tags that are read and does not match the amount of metadata that can be scraped.
{{warning|••• '''Do not''' enable this setting unless you have deliberately set proper and correct tags in your video files. Incorrect tags will cause the scraper to fail on all movies containing bad embedded tags.}}
The below image is a typical example of why scraping fails in most cases. The ''Title'' usually contains junk data and the scraper will be unable to find the correct title.
[[File:VideoTags.jpg|700px]]
|}

== Extract video information from files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Extract file metadata such as audio and video codecs, audio stream languages, audio channel layout, aspect ratio, subtitle languages, duration.
|}

== Extract chapter thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed in chapter timeline displays used by some skins.
|}

= Files =
[[File:Settings-Media-Videos-02.jpg|600px|Image 2]]

== Combine split video items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Combines multi-part video files and DVD/Bluray folders into a single item in '''Files view'''.
Has no affect on library lists.
|}

== Replace file names with library titles ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| When a file is scanned into the library it will display the scanned title instead of the filename. Disable this setting to display the filename instead.
|}
{{-}}

= Library =
[[File:Settings-Media-Videos-03.jpg|600px|Image 3]]

== Show all items entry ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show "All items" entry in library lists e.g. ''All Albums'' or ''All seasons''
|}

== Show information for unwatched items ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Basic
|- valign="top"
| '''Description:'''
| Hide informamtion to prevent spoilers. All information is shown by default. Remove an item from the list to hide information and avoid spoilers
''Movie plot, Episode plot'' and ''Episode thumb'' can be hidden.
|}

== Show movie sets ==
<section begin="Show movie sets" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
|
When disabled, all movies in are shown individually in library lists
When enabled, movies that are part of a "Movie set" are grouped together and the Collection is displayed instead of the individual movies in the set. Clicking the collection will display the movies.
This setting has no effect on the Movie Sets node.
{{See|Movie sets}}
|}
<section end="Show movie sets" />

== Include sets containing a single movie ==
<section begin="Show movie sets SingleMovie" />
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Standard
|- valign="top"
| '''Description:'''
| Can work with, or independently of the previous setting.
*When the previous setting is enabled and this setting is enabled, a "Movie set" entry is used even if the movie set contains only a single movie from the set.
*When the previous setting is enabled and this setting is disabled, a "Movie set" entry is used only if the movie library contains two or more movies from the set.<br>
*When this setting is enabled with or without the previous setting, sets that contain a single movie become visible in the Movie Set Editor.
*This setting has no affect on the Movie Sets node
{{see|Movie sets}}
|}
<section end="Show movie sets SingleMovie" />

== Flatten hierarchy ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Removes the title, genre, etc. nodes from the library view. Selecting a category takes you straight to the title view
|}

== Flatten TV show seasons ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Adjusts when Season lists are removed from TV Show views. Instead a list of episodes from all seasons is displayed.
Options are:
* ''Never''- Season lists are always displayed
* ''If only one season''- (default) Season lists are displayed only when two or more seasons exist
* ''Always''- Hide season lists always
{{note|Cover art for individual seasons will also be hidden.}}
|}

== Show empty TV shows ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Show TV shows with no episodes when browsing through the library.
|}

== Select first unwatched TV show season / episode ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled:
* When entering the seasons list, selects the first season with unwatched episodes.
* When etering the episode list, selects the first unwatched episode.
|}

=== Include "All seasons" and "Specials" ===
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Works with the previous setting. Whether or not consider the items from "All season" and "Specials" in the unwatched item selection
|}

== Movie set information folder ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Nominate the location of the Movie Set artwork.<ref>https://github.com/xbmc/xbmc/pull/16970</ref>
{{See|Movie set information folder}}
|}

== Show all performers for music videos ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| When enabled, shows all contributors in addition to the artists. <ref>https://github.com/xbmc/xbmc/pull/18386</ref>
|}

= Artwork =
<gallery mode="packed" widths="600px" heights="337px">
File:Settings-Media-Videos-04.jpg| Image 4 - Available settings for '''Maximum''' artwork level
File:Settings-Media-Videos-05.jpg| Image 5 - Avaialble settings for the '''Custom''' artwork level
</gallery>

These are '''new artwork settings for v19'''. These settings replace the artwork settings in scrapers and the artwork tags in the advancedsettings.xml file which are no longer needed.<ref>https://github.com/xbmc/xbmc/pull/18072</ref>

== Artwork level ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Allows you to choose the types of artwork to be added to {{kodi}}. Options are:
* '''Maximum'''- Scan or scrape all available '''[[Artwork types]]'''. When scanning local artwork, this setting is indiscriminate and will add ''all'' artwork found, even artwork that does not conform to {{kodi}}'s naming scheme, which will not be displayed unless you have modified the skin to do so. Users with messy folders should use the Custom option instead.
* '''Basic'''- For users with low powered and low storage devices, scrape the minimum of ''poster, fanart'' and ''episode thumbnails'' only.
* '''Custom'''- (image 2) Create a whitelist of artwork to be scanned or scraped. If artwork tags are available in the advancedsettings.xml file, these will be read and added to the custom settings on first run of {{kodi}}
* '''None'''- No artwork will be scanned or scraped.
|}

The following four settings relate to the '''Custom''' setting.

== Movie art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for movies.
The listed Movie artwork also extends to the equivelant for Movie Sets. eg, ''poster'' includes Movie poster and Movie Set poster.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== TV show art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for TV Shows.
The listed TV show artwork also extends to the equivelant for Seasons. eg, ''poster'' includes TV show poster and Season posters.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Episode art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for episodes.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Music Video art types whitelist ==
::{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Relates to the '''Custom''' artwork level.
Add to the whitelist the artwork to be scanned or scraped for Music Videos.
{{kodi}} standard artwork is available for selection. Additional types can be added using the ''Add art type'' button. Before adding a new art type, check it is used by the skin as adding a new art type does not mean it will be displayed.
|}

== Download actor thumbnails ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Also download actor artwork when scanning/scraping media.
|}

== Extract thumbnails from video files ==
{|
|- valign="top"
| width=120px | {{nowrap|'''Settings level:'''}}
| Advanced
|- valign="top"
| '''Description:'''
| Capture a frame of the video stream. This frame will be displayed when episode artwork or when movie poster or fanart are missing.
|}

= References =
<references />

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

[[Category:Settings]]

Media stubs

2022-12-14T20:10:59Z

LGoosens: Structured markup + changed wording for clarity

{{Mininav|[[Video library]]|[[Video management|Management]] }}

= Introduction =
<section begin="intro" />
* If you have a collection of DVD's and Bluray disks but do not want to rip them to a hard drive, then a Media Stub File allows you to add the collection of disks to the {{kodi}} Video Library.
* It is a simple text based file that is added to your Source in exactly the same way as any other Movie or TV Show, which is then scanned or scraped into the library.<section end="intro" />

= Creating =
The Media Stub File is a simple text file with the extension '''''.disc''''' instead of .txt extension. Once the file is saved correctly, {{kodi}} will see this file as an unplayable media file.

#Create a blank text file and rename the filename in accordance with proper Movie and TV Show '''''[[Naming_video_files|Naming Conventions]]'''''.
#Rename the extension to '''''.disc'''''
#Place the file in the Source as you would any other movie in your Source.

*Example 1- Media Stub file in a movie folder with local artwork, actors, Extras, NFO File, theme etc.
*Example 2- Media Stub file without local information and ready for scraping.

<gallery mode="packed" heights="500px">
MediaStubs02.jpg
</gallery>

= Usage =
Once the title is scanned into the library, it will be visible in the same way as any other title in the library. To view the title for playback...
#Select Play
#A box will display requesting you to insert the disk (as shown in the below image)
#Once the disk is inserted, press '''Play''' to commence playback.

<gallery mode="packed-overlay" heights="283px">
MediaStubs01.jpg|Messages will differ based upon the contents of the Stub File
</gallery>

== Messages ==
The basic Stub File will display the default message '''Please insert the following disc: <movie name>'''

It is possible to add messages to the pop up box as shown in the above image. The above image uses the following code placed inside the stub file.

{{note|Longer messages will automatically scroll.}}

<syntaxhighlight lang=xml enclose="div">
<discstub>
<title>Rogue Assassin aka WAR</title>
<message>Released as Rogue Assassin in Australia, but as WAR globally
Bluray located in Storage 3, Drawer 2
Add what you like to the message.</message>
</discstub>
</syntaxhighlight>

*The ''<discstub></discstub>'' tag is required if using either of the next two tags
*The ''<title></title>'' tag is optional and can be used to display an alternate name
*The ''<message></message>'' tag is optional. Use only one set of <message> tags as multiples are ignored.

= Adding/Removing File Extensions =
This modification requires inserting the following code into the '''''[[Advancedsettings.xml]]''''' file.
{{#lst:Advancedsettings.xml|discstubextensions}}

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

[[Category:Karellen]]
[[Category:Video library]]

Adding video sources

2022-12-11T23:56:28Z

LGoosens: Structured markup for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Introduction =
{{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 step of the guide will enable you to complete the following actions:
#'''Add Sources''' - Add the Source folder to {{Kodi}}
#'''Set Content''' - Advise {{kodi}} what type of media is in the Source
#'''Scraper Settings''' - Adjust the scraper settings to your preferences, or change to a different scraper
#'''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 =
<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-2.png|'''{{big|Step 2}}:''' Select '''FILES'''
File:Quick-start-2.1.png|'''{{big|Step 3}}:''' Select '''ADD VIDEOS...'''.<br />
File:Quick-start-3.png|'''{{big|Step 4}}:''' Select the '''BROWSE'''
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-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'''.
</gallery>

= Set Content =
<gallery mode="packed" widths="600px" heights="337px">
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.
</gallery>

{|
! style="width: 45%;" | {{resize|1.4em|Set Content for Movies}}
! style="width: 10%;" |
! style="width: 45%;" | {{resize|1.4em|Set Content for TV Shows}}
|-
| style="width: 45%; text-align:center;" | [[File:Set-content-Movies.jpg|600px]]<br>'''{{big|Step 9a}}
| style="width: 10%;" |
| style="width: 45%; text-align:center;" | [[File:Set-content-TV-Shows.jpg|600px]]<br>'''{{big|Step 9b}}
|-
| || ||
|-
| 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.}}

;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 [[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
: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 '''''[[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.

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

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

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

{{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.}}

{{divbox|yellow|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]]'''}}

= Add to Library =
<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 selected, it can be scanned later from the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' of the Source
</gallery>
<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.

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

<references />

<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}}
{{updated|19}}

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Adding video sources

2022-12-11T23:40:25Z

LGoosens: Changed wording for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Introduction =
{{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 step of the guide will enable you to complete the following actions:
#'''Add Sources''' - Add the Source folder to {{Kodi}}
#'''Set Content''' - Advise {{kodi}} what type of media is in the Source
#'''Scraper Settings''' - Adjust the scraper settings to your preferences, or change to a different scraper
#'''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 =
<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-2.png|'''{{big|Step 2}}:''' Select '''FILES'''
File:Quick-start-2.1.png|'''{{big|Step 3}}:''' Select '''ADD VIDEOS...'''.<br />
File:Quick-start-3.png|'''{{big|Step 4}}:''' Select the '''BROWSE'''
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-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'''.
</gallery>

= Set Content =
<gallery mode="packed" widths="600px" heights="337px">
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.
</gallery>

{|
! style="width: 45%;" | {{resize|1.4em|Set Content for Movies}}
! style="width: 10%;" |
! style="width: 45%;" | {{resize|1.4em|Set Content for TV Shows}}
|-
| style="width: 45%; text-align:center;" | [[File:Set-content-Movies.jpg|600px]]<br>'''{{big|Step 9a}}
| style="width: 10%;" |
| style="width: 45%; text-align:center;" | [[File:Set-content-TV-Shows.jpg|600px]]<br>'''{{big|Step 9b}}
|-
| || ||
|-
| style="width: 40%;" |
;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:If your preferred scraper is not listed, use the '''Get more...''' button.

;Settings
:Adjust the scraper settings for this Source.
:Changing settings here changes the setting for this Source only.
: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.

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

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

;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:If your preferred scraper is not listed, use the '''Get more...''' button.

;Settings
:Adjust the scraper settings for this Source.
:Changing settings here changes the setting for this Source only.
: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. <ref>https://github.com/xbmc/xbmc/pull/16273</ref>
|}

{{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.}}

{{divbox|yellow|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]]'''}}

= Add to Library =
<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 selected, it can be scanned later from the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' of the Source
</gallery>
<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.

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

<references />

<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}}
{{updated|19}}

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Adding video sources

2022-12-11T23:37:57Z

LGoosens: Changed flow for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Introduction =
{{warning|[[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:
#'''Add Sources''' - Add the Source folder to {{Kodi}}
#'''Set Content''' - Advise {{kodi}} what type of media is in the Source
#'''Scraper Settings''' - Adjust the scraper settings to your preferences, or change to a different scraper
#'''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 =
<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-2.png|'''{{big|Step 2}}:''' Select '''FILES'''
File:Quick-start-2.1.png|'''{{big|Step 3}}:''' Select '''ADD VIDEOS...'''.<br />
File:Quick-start-3.png|'''{{big|Step 4}}:''' Select the '''BROWSE'''
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-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'''.
</gallery>

= Set Content =
<gallery mode="packed" widths="600px" heights="337px">
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.
</gallery>

{|
! style="width: 45%;" | {{resize|1.4em|Set Content for Movies}}
! style="width: 10%;" |
! style="width: 45%;" | {{resize|1.4em|Set Content for TV Shows}}
|-
| style="width: 45%; text-align:center;" | [[File:Set-content-Movies.jpg|600px]]<br>'''{{big|Step 9a}}
| style="width: 10%;" |
| style="width: 45%; text-align:center;" | [[File:Set-content-TV-Shows.jpg|600px]]<br>'''{{big|Step 9b}}
|-
| || ||
|-
| style="width: 40%;" |
;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:If your preferred scraper is not listed, use the '''Get more...''' button.

;Settings
:Adjust the scraper settings for this Source.
:Changing settings here changes the setting for this Source only.
: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.

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

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

;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:If your preferred scraper is not listed, use the '''Get more...''' button.

;Settings
:Adjust the scraper settings for this Source.
:Changing settings here changes the setting for this Source only.
: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. <ref>https://github.com/xbmc/xbmc/pull/16273</ref>
|}

{{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.}}

{{divbox|yellow|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]]'''}}

= Add to Library =
<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 selected, it can be scanned later from the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' of the Source
</gallery>
<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.

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

<references />

<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}}
{{updated|19}}

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

NFS

2022-12-10T03:32:05Z

LGoosens: Structured markup + changed flow for clarity

<section begin="intro"/>'''Network File System''', or '''[http://en.wikipedia.org/wiki/Network_File_System_%28protocol%29 NFS]''', is a way to share folders over a network, and was added to XBMC in v11 (Eden). The main benefits of using NFS instead of SMB are its low protocol overhead (which allows it to send data across a network more quickly) and its use of simple [http://en.wikipedia.org/wiki/User_identifier UID's] to authenticate users rather than username/password combinations. This part bears repeating, as many people are confused on this point and try to create usernames and passwords to get Kodi to work with NFS.
{{warning|NFS does not use usernames or passwords as logins; it uses a UNIX-based "userID" (UID) alone.}}<section end="intro"/>

NFS's main disadvantage in comparison to SMB (a commonly-encountered protocol in Windows environments) is that it can be more complicated to set up in some cases, since many non-technical users are unfamiliar with configuring UNIX-based protocols.

NFS is commonly found on all Linux/UNIX distributions, as well as on OS X and Solaris, and offers several features:
* It is already incorporated in UNIX-like operating systems (such as OS X), eliminating the need for additional software and services to be installed on your computer.
* Once properly configured, NFS will allow your network shares to be seen and accessed by not only Kodi, but also any other machine on your network.
* It allows for authentication by UID, thus eliminating the need to save usernames and passwords in XBMC source XML files.
{{warning|Please note that this simple authentication also makes it more vulnerable to attacks. NFS should be only used inside a private LAN.}}

;{{note|If you already have a working NFS server check that the export options required by Kodi have been set (as described in the relevant section below).}}

When configuring NFS shares to use as network sources for Kodi's music/video libraries, use the following format: '''nfs://1.2.3.4/path/to/folder''' (where "1.2.3.4" should be replaced with the IP of your NFS server, and "/path/to/folder" should be replaced with the path to the folder you want to share; a double slash between the server and the path is wrong, you '''should not''' use nfs://1.2.3.4//path/to/folder). See the sections below for help configuring NFS shares on various devices' operating systems.

For more info on network sources for your music and video in Kodi, see Types of Media Sources.<br />

== NFS sharing from Windows ==
Windows does not have any built-in native ability to share folders via NFS; and only a limited selection of Windows operating systems have the native ability to access NFS shares as a client. However, several third-party solutions attempt to provide NFS functionality, on both the server side and the client side.

For ''serving'' (sharing) files from Windows using NFS, there seem to be three choices:
:* Windows Server 2003 R2, Windows Server 2008 and Windows Server 2012 have built-in NFS Server and Client through Subsystem for UNIX-based Applications (SUA). With 64-bit support, this solution supports files up to 4TB in size
:* [http://en.wikipedia.org/wiki/Microsoft_Windows_Services_for_UNIX Microsoft Windows Services for UNIX (SFU)] available [http://www.microsoft.com/download/en/details.aspx?id=274 here]for Windows 2000, Windows XP Professional (NOT Home edition, without a [http://www.networkedmediatank.com/showthread.php?tid=1434 hexedit hack]), Windows 2003 Server, and Windows Home Server (based on 2003 Server). SFU is 32-bit only, which ''may'' mean it only supports files up to 2GB in size, [http://www.suacommunity.com/SUA_Tools_Env_Start.htm#_Toc203389873 according to some sources] (this is unconfirmed). A good installation guide can be found [http://www.networkedmediatank.com/showthread.php?tid=1434 here]. Windows SFU will not install on Windows Vista or Windows 7, so there is no way to ''serve'' NFS from Windows Vista or Windows 7 with the possible exception of the haneWIN solution below, but it is unconfirmed if that works with Windows Vista/7.
:* [http://www.hanewin.net/nfs-e.htm haneWIN NFS Server for Windows] - a shareware program that costs 19EUR for non-commercial use. Claims to work for "Windows 2000 and above."

== NFS sharing from OS X ==
NFS is built into Mac OS X (OS 10.5 and later), and thus no additional software is required to set up NFS shares on a Mac OS X device.

;{{note|The following assumes some basic knowledge of the UNIX/BSD operating system interface and environment, and assumes you are familiar with using a Mac's Terminal command-line utility. It also assumes you have a beginner's understanding of UNIX text editors such as [http://mintaka.sdsu.edu/reu/nano.html nano] or [http://www.eng.hawaii.edu/Tutor/vi.html vi].}}

1. To allow regular (non-root) users to connect to your NFS shared folders, you'll need to edit the "/System/Library/LaunchDaemons/com.apple.nfsd.plist" file. Open it and add the option "-N" to the startup parameters as follows:

<array>
<string>/sbin/nfsd</string>
'''<string>-N</string>'''
</array>

If you don't do this step, Kodi will only be able to access the Mac's shared NFS folders if Kodi is running as root (normally, Kodi does not run as root, so you will almost certainly want to do this first step and add the -N parameter).

2. The NFS server and its shared folders are set up in a config file named "exports", located in the /etc directory. Technically speaking, with NFS you "export a path" rather than "share a folder" (which is why the file is named "exports"), but we'll use the latter phrasing for simplicity's sake.

The /etc/exports file may not yet exist; if not, you'll need to create it. The file is edited either manually (in Terminal, using a UNIX text editor such as '''nano''' or '''vi''') or via a GUI utility, the most well-known of which is [http://www.bresink.com/osx/NFSManager.html NFS Manager]. The following guide assumes you are using Terminal (if using NFS Manager, consult that software's documentation for help).

To view the current contents of /etc/exports, if any, execute the following command in a Terminal window:

'''cat /etc/exports'''

Any folders to be shared via NFS should be listed on separate lines, along with any configuration parameters governing connections to those folders. The lines should follow this general format:

/path/to/folder_name_to_share [-parameter1 -parameter2 ...] <IP address restriction (optional)>

<big>Examples</big>

In this sample /etc/exports file, we've set up four folders to be shared via NFS, using various parameters and options. The folders are all contained in a folder called "nfs_shares", and are named to indicate some things about how we've set them up; obviously, on your system, the folder names would be things like "video", "music", and so on.

/nfs_shares/allread -ro -mapall=nobody -alldirs
/nfs_shares/allwrite -mapall=nobody -alldirs -network 192.168.1.0 -mask 255.255.255.0
/nfs_shares/writeAs501 -mapall=501 -alldirs 192.168.1.5
/nfs_shares/Kodiuser

Let's look at what each of these shared folder configurations means.

* The folder "'''/nfs_shares/allread'''" can be accessed from all computers (because no IP address is given), is read-only ("'''-ro'''"), and all incoming connections are assigned the same permissions as the UNIX user "nobody", who has anonymous access ("'''-mapall=nobody'''"). This last parameter ensures that anyone can access the folder, but they will not have any rights on your NFS server other than those belonging to the "nobody" user. Also, the "'''-alldirs'''" parameter is used to indicate that incoming connections can mount either the /allread folder OR any subfolder underneath /allread.

* The folder "'''/nfs_shares/allwrite'''" can be accessed from all computers on the subnet 192.168.1.0/255.255.255.0, has read and write permissions (we've omitted "'''-ro'''"), and again access rights for user "nobody" are assigned ("'''-mapall=nobody'''"). The "'''-alldirs'''" parameter is once again used to allow subfolders to be mounted directly.

* The folder "'''/nfs_shares/writeAs501'''" can be accessed from the computer with an IP of 192.168.1.5, has read and write permissions (again we've omitted "'''-ro'''"), and access rights belonging to users on your system with a UID of 501 (see note below) will be inherited by all incoming connections ('''-mapall=501'''). The "'''-alldirs'''" parameter is once again used to allow subfolders to be mounted directly.

:;{{note|As already mentioned, authentication to the NFS server is done by checking UIDs. For Kodi, this means that the UID which the Kodi process is running under is given to the NFS server to be authenticated. To find out your current UID, just type "id" into a console:}}

Mac:~ [''your_user_name'']$ '''id'''

::You should see something that begins like this:

uid=501(''your_user_name'')

:In this example, my UID is 501. If you are going to be connecting to your NFS shared folder from Kodi on iOS, keep in mind that on iOS Kodi runs as the user "mobile", which should have UID 501 also.

* The folder "'''/nfs_shares/Kodiuser'''" can be accessed from all computers ('''no ip given'''), readwrite (no "'''-ro'''") and the access rights belonging to the UID which is connecting to the NFS server are used ("'''-mapall'''" removed).
;{{note|The important effect of the absence of the -mapall parameter in this case: if someone connects to your NFS server as root, they will be running on your system as root! Also note that because "-alldirs" is not specified, incoming connections will only be able to connect to the /Kodiuser folder, NOT any folders underneath it.}}

Bear in mind that any UID's that are used to connect to the NFS server, or that are specified with "-mapall", have to exist on your NFS server (i.e. on your Mac).

'''Each change on the exports config file needs a restart of the nfs server! Just issue "sudo nfsd restart" for this.'''

3. Once you've configured and saved your /etc/exports file, the NFS server can be started either by rebooting or by executing the following command:

$ sudo nfsd start

=== Troubleshooting NFS on OS X ===

==== -N flag is set, but shares still won’t work ====

Sometimes there are issues with NFS shares on OS X. Most of them result in the <code>-N</code> flag not being set, but they result in different error messages or issues. One of the root issues is the flag being set in the Property List file, but not read by launchd which controls the process. The following observations are pretty common in this case and if you see one of these points, it won’t hurt to either inspect the nfsd process on your Mac or restart the whole computer.

* You have successfully shared the volume and you can mount it from other Macs in your network (via ⌘K in the Finder), but not from Kodi.
* You can add the computer share (e.g. <code>nfs://192.168.1.5/</code>), but not the share that contains a path (e.g. <code>nfs://192.168.1.5/nfs_shares/allread</code>).
* When you add the computer share, you can enter it in Kodi’s browser, but then clicking on one of the mount points does nothing.
* You see either '''"Server responded: Procedure not available"''' or '''"RPC Packet not accepted by the server"''' in the error logs.

In most cases it’s sufficient to restart nfsd via launchd, just killing the process with <code>kill -9</code> or <code>killall nfsd</code> after applying changes to the Property List file has no effects. To restart nfsd via launchd you have to type the following command in the Terminal:

sudo launchctl unload /System/Library/LaunchDaemons/com.apple.nfsd.plist && \
sudo launchctl load /System/Library/LaunchDaemons/com.apple.nfsd.plist

When you use <code>ps</code> to inspect the process, <code>-N</code> should be visible at the end of the line. If it’s not, then launchd didn’t apply the changes and just (re-)started nfsd with the old configuration. A proper output looks like this:

~ '''ps aux | grep nfsd'''
root 55828 0,0 0,0 2500812 2332 ?? Ss 3:54pm 0:08.96 /sbin/nfsd '''-N'''
chiefsucker 58788 0,0 0,0 2435268 496 s000 U+ 7:22pm 0:00.00 grep nfsd

Pay attention to the <code>-N</code> flag being visible in the ps output. If the <code>-N</code> flag is visible, but your shares don’t work, then it’s probably another issue.

==== NFS shares stopped working after OS X upgrade ====

If your share stopped working after you upgraded your OS (e.g. from Lion to Mountain Lion) then it usually means that the installer did overwrite the Property List file and you have to add <code>-N</code> again. See immediately below for Mac OS X 10.11 El Capitan upgrade instructions.

==== Fresh Installs or Upgrading to Mac OS X 10.11 El Capitan through High Sierra ====

Mac OS X 10.11 changed the way the user is allowed to interact with certain system files, including anything in /System/Library/LaunchDaemons/ This is due to SIP [https://en.wikipedia.org/wiki/System_Integrity_Protection (System Integrity Protection)]. Follow these steps to disable SIP, set the -N option in com.apple.nfsd.plist, and re-enable SIP.

# Power up or restart the Mac. At the chime, hold down Command-R to boot into the Recovery Partition.
# Once booted in the Recovery Partition, go to the menu bar and click on '''Utilities''', then select '''Terminal'''.
# Type this into '''Terminal''' to disable SIP: <code>/usr/bin/csrutil disable</code>
# Quit '''Terminal''' and restart the Mac.
# Follow the [http://kodi.wiki/view/NFS#NFS_sharing_from_OS_X intructions from above] to insert the <code>-N</code> option.
# Restart the Mac. At the chime, hold down Command-R to boot into the Recovery Partition.
# Again, go to the menu bar and click on '''Utilities''' and select '''Terminal'''.
# Type this into '''Terminal''' to re-enable SIP: <code>/usr/bin/csrutil enable</code>
# Quit '''Terminal''' and restart the Mac.

==== My Mac goes to sleep while playing a movie from a NFS share ====

OS X 10.8 Mountain Lion introduced some changes that result in very aggressive sleep behaviour. Because NFS shares aren’t handled and treated like shares set from within the Sharing panel in System Preferences, OS X will ignore clients that access your NFS shares and just put it to sleep. Fortunately there are some workarounds:

# Set '''Computer sleep''' in the Energy Saver pane of System Preferences to '''Never'''. Unfortunately this will affect the whole machine and you’ll have to put your Mac manually to sleep from now on.
# Get the [http://itunes.apple.com/app/caffeine/id411246225?mt=12 free Caffeine app from the Mac App Store]. The app will reside in your menu bar and you can prevent your Mac from sleeping with just one mouse-click. If you disable Caffeine (again with one click), your Mac will go to sleep as set in the System Preferences. This has the benefit of adjustable sleep behavior, i.e. you turn Caffeine on when you watch movies and you turn it off otherwise to preserve energy and save the planet.
# You can reach the same goal with the Terminal app <code>caffeinate</code> that gets shipped with the OS since OS X 10.8 Mountain Lion.

== NFS sharing from Linux ==

NFS sharing has been built into linux kernel for a long time.

;{{note|This article assumes some basic knowledge of the Linux/UNIX/BSD operating-system interface and environment.}}

The configuration of the NFS server takes place in the config file "/etc/exports". As already mentioned, the authentication to the NFS server is done through UIDs. For Kodi, this means the UID that the Kodi process is running under is used to authenticate on the NFS server. To find out what UID Kodi is using, just type "id" into a console:

penix:~ [your_user_name]$ id
uid=501(your_user_name)

In this example, my UID is 501. For iOS devices, keep in mind that Kodi is running as the user "mobile", whose UID should also be 501.

A basic configuration for exporting a path with NFS looks like this:

/nfs/export <ip or iprange which is allowed to connect>(rw,all_squash,insecure)

The important options here for use with Kodi are the "ip or iprange" and the "insecure" options. The "insecure" option is needed because we want to be able to run Kodi without root privileges. If the insecure option is not enabled, only the root user (uid 0) will have access to the nfs share. The "ip or iprange" specifies which hosts on the network will be allowed to access the exported NFS share.

By changing some of the options of that line, we can use any of three different approaches for getting the access rights configured as we want:

1. The option all_squash (most insecure) - all UIDs connected to the NFS server are mapped to UID 65534 (user nobody)
::* In this case all files which shall be accessed on the NFS exported path should have the correct rights for the user "nobody".
2. Using the option "all_squash" in conjunction with the option "anonuid" and "anongid"
::* By adding the options "anonuid=501" and "anongid=501" all accesses would be mapped to the user with UID 501 (user "mobile" on iOS or user "memphis" in my example above)
3. Removing the "all_squash" option the accesses will be done with the UID given from the user which is running Kodi
::* So if Kodi is started with username foobar (which has UID 1000) all accesses to the NFS export path will be made with UID 1000.

<big>Examples for exported paths:</big>
### access from ''all computers'' ("'''*'''"), ''readonly'' ("'''ro'''"), access for user ''nobody'' ("'''all_squash'''")
/nfs/allread *(ro,all_squash,insecure)

### access from the subnet 192.168.1.0/255.255.255.0, ''read/write'' ("'''rw'''"), access for user ''nobody''
### ("'''all_squash'''"). Remember that "'''rw'''" doesn't automatically allow writes; the user "nobody" must
### have write access to the path on the filesystem.
/nfs/allwrite 192.168.1.0/24(rw,all_squash,insecure)

### access from 192.168.1.5, ''read/write'' ("'''rw'''"), access for user with UID 501 (i.e. memphis, for me)
### ("'''all_squash,anonuid=501,anongid=501'''")
/nfs/writeAsMemphis 192.168.1.5(rw,all_squash,insecure,anonuid=501,anongid=501)

### access from ''all computers'' ("'''*'''"), ''read/write'' ("'''rw'''"), access for the UID connecting to the
### NFS server ("'''all_squash'''" removed)
/nfs/Kodiuser *(rw,insecure)

### NTFS export *SECURITY Warning: this gives the user ROOT access*
### access from the subnet 192.168.1.0/255.255.255.0, ''read/write'' ("'''rw'''"), nfs client connects
### as root ("'''no_root_squash'''"). Otherwise, permission is for ''nfsnobody'', (uid 65534).
### NTFS is non-POSIX permissions compliant, so you must access the share as ''root''
/nfs/NTFS_share 192.168.1.0/24(rw,'''no_root_squash''',insecure)

The UIDs which are used to connect to the NFS server or which are specified with "anonuid" and "anongid" have to exist on the NFS server. Otherwise the filesystem permission can't be set.

Remember - access rights are these you give in the filesystem. '''After each change to the exports config file issue "sudo exportfs -ra"!'''

<big>'''Notes on serving NFS from Ubuntu 20.04 and other distributions with more modern NFS'''</big>

Ubuntu 20.04 LTS has an updated version of NFS vs. the older version in 16.04 and 18.04.

Combined with the relatively old version of libnfs included with most Kodi distributions at time of writing, this can make NFS set up a little more difficult than with older versions of Ubuntu. (i.e. when using Ubuntu as the server).

The main issue is that server discovery is broken - that is, when you click on the 'nfs' option when adding a source, you will ''not'' see your Ubuntu 20.04 NFS IP appearing in the list of available servers.

In most Kodi locations, you can just explicitly manually enter the full share details (as above, e.g. <code>nfs://192.168.1.5/SomeExport</code>) and you will then be able to use the share that way.

Unfortunately, though, this does not work in ''all'' Kodi file browsers (e.g. when adding a folder for the Kodi Music Information in the Settings -> Media -> Music area). A better solution, then, is to add an explicit entry to your [[mediasources.xml]] file. Note, you don't need to add all the individual NFS ''exports'' - once you have the entry for the ''server'' working, you will then be able to browse the exported shares from that server as normal.

Example <code>mediasources.xml</code> - this one contains both an SMB (with a user/password) and nfs share - both of which will then come up as sources in all Kodi file browsers.

<mediasources>
<network>
<location id="0">smb://user:password@192.168.1.4/</location>
<location id="1">nfs://192.168.1.5/</location>
</network>
</mediasources>

Note, also, that the standard Ubuntu UFW firewall, if enabled, will block incoming NFS connection by default. With NFSv4 clients, where only one standard port (2049) is used, you can add a simple rule to allow NFS through:

sudo ufw allow from 192.168.1.0/24 to any port nfs comment "NFS"

However, Kodi generally mounts using NFSv3, and this is therefore not sufficient. So you'll need to to do two more things - one, force NFS to use a specific port, and then open that port, plus port 111, on UFW as well. The accepted answer to [https://askubuntu.com/questions/103910/nfs-is-blocked-by-ufw-even-though-ports-are-opened/104232 this question on the Ask Ubuntu Stack Exchange] is the solution.

Once all this is done, it is then easy to both find your exports, and you will be able to connect to them.

== NFS sharing from FreeBSD ==
This will get you going with NFSv3.
Edit rc.conf:
nfs_server_enable="YES"
rpcbind_enable="YES"
rpc_lockd_enable="YES"
rpc_statd_enable="YES"
weak_mountd_authentication="yes"

Edit /etc/exports (change to network as required):
/path/to/share -alldirs -maproot=root -network=192.168.1.0/24
After that you can reboot or start the daemons:
service rpcbind start
service nfsd start
service mountd start

For more information refer to the [https://www.freebsd.org/doc/handbook/network-nfs.html FreeBSD handbook entry on NFS]
== NFS sharing from NAS4Free 9.x (successor to legacy FreeNAS 7.x) ==
The information in the Linux section above also applies for *BSD based systems (such as FreeBSD). This section addresses some specific issues to bear in mind if you are using NAS4Free 9.x or FreeNAS 7.x (aka. legacy) installations.

;{{note|FREENAS 8.3.0-RELEASE or later does not require modifying the rc.conf file for Kodi to access NFS shares. You must however enable "allow non-root mount" which can be found under the SERVICES - NFS section in the Freenas 8.3.0 web GUI.}}

Setup your NFS shares as normal. Remember: don't create shares inside other shares. The following would be illegal...
/mnt/disk -alldirs,quiet -mapall=root -network 192.168.1.0 -mask 255.255.255.0
/mnt/disk/folder -alldirs,quiet -mapall=root -network 192.168.1.0 -mask 255.255.255.0
...because the "/mnt/disk/folder" directory is already shared by "/mnt/disk". If you remember to set the setting "All dirs" when creating your NFS shares, the flag "-alldirs" will be set. This flag allows you to mount any subdirectory of your share just as if it was a share itself. Said another way: It's not necessary to share "/mnt/disk/folder" because you can mount it through the "/mnt/disk" share.

After having set up a standard NFS share on your NAS4Free box, you need to add a few variables to rc.conf on NAS4Free. This is done by going into System > Advanced > rc.conf .
Here you need to add the following:
Variable Value Comment
mountd_flags -n Allow non-root mount requests to be served.
nfs_reserved_port_only NO Allow for insecure ports to be used by NFS.
nfs_server_flags -u -t -n 4 Serve UDP and TCP with 4 servers.

After this, apply your changes and reboot NAS4Free. You should now be able to mount your NFS shares, as well as any subdirectory of those shares.

== NFS sharing from ZFSGuru ==
Very similar to FreeNAS solution.
mountd needs the -n flag.
In ZFSGuru you can achieve this by adding
weak_mountd_authentication="YES"
to /etc/rc.conf

== NFS sharing from commercial NAS systems such as Synology or QNAP ==
Each NAS manufacturer, if it allows you to share folders via NFS on its NAS systems, does so in its own way. Often this will involve setup via the NAS's control panel or administrator interface. You can also connect to many NAS systems via ssh and manually edit files in order to set up and configure NFS (consult your NAS manual to see if this is possible/desirable/necessary). Since most NAS systems are based on Linux/UNIX, if you need to manually edit files, you should be able to make use of the [[#NFS sharing from Linux|Linux instructions above]] to create/edit your NFS shares.

=== Troubleshooting NFS on a commercial NAS with Kodi ===
Your NFS server on your NAS needs to be able to allow connections on so-called '''unprivileged ports''', which are port numbers higher than 1023. However, most NAS's are set up by default to deny incoming NFS connections on these unprivileged ports. This is one of the most common reasons why Kodi users experience problems when trying to connect to an NFS shared folder on a NAS.

If you are having trouble connecting to your NFS shares on your NAS from Kodi, make sure your NFS shares have the "insecure" option enabled, which will allow connections on unprivileged ports. To check, connect to your NAS via ssh and issue the '''cat /etc/exports''' command. Your shared folders will each have several parameters listed separated by commas. If the "insecure" parameter is not listed, you will need to add that parameter to the list. This will usually involve directly editing the /etc/exports file with a UNIX text editor and adding the "insecure" option manually, although some NAS's may offer the ability to add the option via an admin interface. Check your NAS manual for details, or explore the section below if your brand of NAS is listed.

=== Commercial NAS NFS setup instructions ===
Kodi users have contributed the following NFS setup instructions for various brands of NAS devices. If your NAS is listed below, feel free to follow the accompanying instructions to set up NFS on your system.

==== Synology ====
[[File:Synology.png|link=]]<br />
;{{note|You do not need to create a special user account on your Synology NAS in order to make use of NFS for Kodi. The following guide assumes you are comfortable with using the simplest (least secure) internal setup on your NAS, which will normally be the case for the vast majority of Kodi users.}}

<gallery widths=600px heights=340px>
File:Step1.png|'''<big>Step 1:</big>''' Log in to your Synology admin control panel.
File:Step2.png|'''<big>Step 2:</big>''' Enable SSH (if not enabled already): Control Panel --> Terminal --> Enable SSH service --> {{button|OK}}

File:Step3.png|'''<big>Step 3:</big>''' Enable NFS under Control Panel --> Win/MAC/NFS
File:Step4.png|'''<big>Step 4:</big>''' NFS Services --> Enable NFS --> {{button|OK}}

File:Step5.png|'''<big>Step 4:</big>''' Under Control Panel --> Shared Folder
File:Step6.png|'''<big>Step 6:</big>''' On NFS Privileges tab select entry for the folders you want to share e.g. '''Movies'''
File:Step7.png|'''<big>Step 7:</big>''' {{button|Create}} privileges for the selected share
File:Step8.png|'''<big>Step 8:</big>''' As per example allow all IPs (or the desired IP for your HTPC) with '''read/write''' permissions with no mapping and enable '''asynchronous'''. The option to '''allow connections from non-priviledged hosts''' is new in DSM version 4.3-3776. Using DSM 5.0-4482 I had to use the "Squash" option and "Map all users to admin".

'''With this option the steps 10 through 14 are no longer necessary.''' --> {{button|OK}}
File:Step9.png|'''<big>Step 9:</big>''' Press {{button|OK}}
</gallery>

;{{note|The below steps are necessary only if you are using a Synology DSM version less than 4.3-3776.}}

'''<big>Step 10:</big>''' On your computer, in a command line window (Terminal on a Mac, CMD on a Windows PC, etc), ssh into your Synology:
'''ssh root@<<YOUR.SYNOLOGY.IP.ADDRESS>>'''

'''<big>Step 11:</big>''' Type in '''cat /etc/exports''' to make sure your previous steps have created exported NFS directories. If no entries are found, go back to the previous steps and make sure you've followed them correctly. You should be seeing something like this:

[[File:Step11.png|600px]]

'''<big>Step 12:</big>''' Type '''vi /etc/exports''' to edit the /etc/exports file, and change all the "insecure_locks" entries to simply read "insecure". If you don't know vi: press the INS[SERT] key, use arrows to go to the line to edit, and delete/edit the line. Then press the ESC key, and type ''':x''' to 'Save & Exit'.<br />
13. Type '''cat /etc/exports''' again, and you should now see something like this (make sure it says "insecure" rather than "insecure_locks"):

[[File:Step15.png|600px]]

'''<big>Step 14:</big>''' Type '''exportfs -ra''' to initialize your newly exported directories, or reboot the NAS.<br />
'''<big>Step 15:</big>''' You should now be able to browse NFS and get to your exported Synology subfolders in Kodi.<br />
===== Synology DSM 5.1 =====
<gallery widths=600px heights=340px>
File:syn5step1.png|'''<big>Step 1:</big>''' Enable NFS under Control Panel --> File Services
File:syn5step2.png|'''<big>Step 2:</big>''' NFS Services --> Enable NFS --> Press Apply

File:syn5step3.png|'''<big>Step 3:</big>''' Under Control Panel --> Shared Folder
File:syn5step4.png|'''<big>Step 4:</big>''' Select entry for the folders you want to share e.g. '''video''' and click '''Edit'''
File:syn5step5.png|'''<big>Step 5:</big>''' Under '''permissions''' tab add permission '''read/write''' for user '''admin'''
File:syn5step6.png|'''<big>Step 6:</big>''' Under '''NFS Permissions''' tab add permission click '''Create''' to create NFS permissions
File:syn5step7.png|'''<big>Step 7:</big>''' As per example allow all IPs (or the desired IP for your HTPC) with '''read/write''' permissions, Squash '''Map all users to admin''', Security '''sys''', and enable '''asynchronous'''. The option '''allow connections from non-priviledged ports''' selected. '''Allow users to access mounted subfolders''' also selected.
</gallery>
'''<big>Step 8:</big>''' Click '''OK''' to save changes. And now you should be able to access video folder via NFS protocol
==== QNAP ====
[[File:QNAP.gif|link=]]<br />
;{{note|You do not need to create a special user account on your QNAP NAS in order to make use of NFS for Kodi. The following guide assumes you are comfortable with using the simplest (least secure) internal setup on your NAS, which will normally be the case for the vast majority of Kodi users.}}

This guide requires you to SSH into your QNAP, and also to use the terminal editor [http://en.wikipedia.org/wiki/Vi Vi] to edit files.

Here's a couple of guides if you wish to learn more, but feel free to google for further reading:

[http://www.tuxfiles.org/linuxhelp/vimcheat.html Vi Cheat Sheet]

1. Log into your QNAP admin control panel. (Web browser = IP-ADDRESS:8080).

<gallery widths=700px heights=340px>
File:QNAP_SSH.png|'''<big>Step 2:</big>''' Enable SSH (if not already): Network Services -> Telnet / SSH -> 'tick' Allow SSH connection, Press {{button|Apply}}
File:QNAP_NFS.png|'''<big>Step 3:</big>''' Enable NFS: Network Services -> NFS Service -> 'tick' Enable NFS Service, Press {{button|Apply}}
</gallery>
<gallery widths=600px heights=350px>
File:QNAP_Shares.png|'''<big>Step 3:</big>''' Set NFS Access Rights: Under "Enable NFS Service" Click on "Click here to set the NFS access right of the network share"
File:QNAP_NFS_Access.png|'''<big>Step 4:</big>''' Click on the NFS icon next to Qmultimedia (or whatever the name of your media share on the QNAP) and set Access Right to No Limit and put in the IP Address of each individual device that requires NFS connection (ATV2, Desktop, Laptop, etc.), Press {{button|Apply}}
</gallery>

6. On your computer, in a command line window (Terminal on a Mac, CMD on a Windows PC, etc), ssh into your QNAP:
'''ssh admin@<<YOUR QNAP IP ADDRESS>>'''

7. Type in '''cat /etc/exports''' to make sure your previous steps have created exported NFS directories. If no entries are found, go back to the previous steps and make sure you've followed them correctly. You should be seeing something like this:
"/share/MD0_DATA/Qmultimedia" 192.168.1.15(rw,async,no_root_squash) 192.168.1.20(rw,async,no_root_squash)
"/share/NFS/Qmultimedia" 192.168.1.15(rw,nohide,async,no_root_squash) 192.168.1.20(rw,nohide,async,no_root_squash)

8. Type '''vi /etc/exports''' to edit the /etc/exports file, and add "insecure" entries inside the brackets in front "rw"(separated with a comma ","). If you don't know vi: press the "i" key, use arrows to go to the line to edit, and add the entries. Then press the ESC key, and type ''':wq''' to 'Save & Exit'. Your exports file should now look something like this:
"/share/MD0_DATA/Qmultimedia" 192.168.1.15(insecure,rw,async,no_root_squash) 192.168.1.20(insecure,rw,async,no_root_squash)
"/share/NFS/Qmultimedia" 192.168.1.15(insecure,rw,nohide,async,no_root_squash) 192.168.1.20(insecure,rw,nohide,async,no_root_squash)

9. Type '''exportfs -ra''' to initialize your newly exported directories, <span style="color:#FF0000">'''DO NOT''' reboot the QNAP or restart NFS via the QNAP Admin page - If you do the QNAP will overwrite the changes you just made</span>.

<gallery widths=415px heights=168px>
File:QNAP_nfssetting_before.png|'''<big>Step 10:</big>''' Now type '''vi /etc/config/nfssetting'''. You'll see something like this:
File:QNAP_nfssetting_after.png‎|'''<big>Step 11:</big>'''Move your cursor to after the '''rw''' in the line '''/share/*****/Qmultimedia = rw''' (***** interchangeable with whatever yours says). Press {{keypress|i}} and add '''insecure''' separated by a ''',''' (comma). When you're done editing press {{keypress|esc}} and then ''':wq''' to save the changes and close the file. It will look something like this when finished:
</gallery>
<span style="color:#FF0000">'''CAUTION: If you reboot your QNAP NAS at any time after completing the steps above, but before completing the steps below, the changes you've made will be wiped out and you will need to redo the process.'''</span>

12. That should be it for getting it working.. You should now be able to browse NFS and get to your exported QNAP folders in Kodi. Now there's just a few more steps to ensure all your hard work survives a reboot/firmware upgrade.

* We're going to edit/create an autorun script that overwrites two files from backups we're going to make.

13. Okay, you need to make a folder to store the backup files. You need to use the absolute path in the Autorun script. Type '''mkdir /share/MD0_DATA/backups''' and press '''enter'''. (The MD0_DATA part could be different on your model, I'm running a TS-509).

14. Now type '''cp /etc/exports /share/MD0_DATA/backups/exports''' and press enter.

15. Type '''cp /etc/config/nfssetting /share/MD0_DATA/backups/nfssetting''' and press enter.

16. Now for the fun part. To mount the ramblock follow the procedure below. This is based on the guide here (Method 1): [http://wiki.qnap.com/wiki/Running_Your_Own_Application_at_Startup QNAP Autorun Wikiguide]

17. Pick the method that is applicable to your QNAP model.
## Model TS-201: Mount the config ramblock /dev/mtdblock4: <pre># mount -t ext2 /dev/mtdblock4 /tmp/config </pre>
## Models TS-109, TS-109P, TS-110, TS-119, TS-209, TS-209P, TS-219, TS-409 (Marvell ARM), TS-419P: Mount the config ramblock /dev/mtdblock5: <pre># mount -t ext2 /dev/mtdblock5 /tmp/config</pre>
## Models TS-439, TS-509, TS-639, TS-809, TS-809U (x86): Mount the config ramblock /dev/sdx6: <pre># mount -t ext2 /dev/sdx6 /tmp/config</pre>
# Create/Edit /tmp/config/autorun.sh .
## either using vi: <pre># vi /tmp/config/autorun.sh</pre>
### Get vi editor into edit mode: '''press i'''
### Add these lines to the autorun.sh script:
### '''cp /share/MD0_DATA/backups/exports /etc/exports'''
### '''cp /share/MD0_DATA/backups/nfssetting /etc/config/nfssetting'''
### Exit edit mode: '''press ESC'''
### Save and exit: ''':wq'''
## or editing it using a desktop PC and e.g. SFTP
# Ensure that /tmp/config/autorun.sh is executable: <pre># chmod +x /tmp/config/autorun.sh</pre>
# '''IMPORTANT:''' Unmount the mounted flash partition: <pre># cd /</pre> <pre># umount /tmp/config</pre>

18. Finish the linked guide, making sure to unmount the ramblock. (You will need to cd away from the /tmp/config directory to umount it.

19. Should be done!

==== Thecus ====
[[File:thecuslogo.png|link=]]<br />

<gallery widths=600px heights=340px>
File:Thecus1.png|'''<big>Step 1:</big>''' Log in to your ThecusOS interface and select '''Network Service'''.
File:Thecus2.png|'''<big>Step 2:</big>''' Enable NFS and click {{button|Apply}}
File:Thecus3.png|'''<big>Step 3:</big>''' Go to the '''Share Folders''' entry in the '''Storage'''-section. Select the folder, you want to share via NFS and click on NFS.
File:Thecus4.png|'''<big>Step 4:</big>''' You can now define specific hosts and access rights. '''!!!IMPORTANT!!!''' Activate AIX as OS support, otherwise Android Kodi won't be supported. {{button|Apply}}
</gallery>

{{Isengard updated}}

NFS

2022-12-10T03:26:13Z

LGoosens: Structured markup + changed wording for clarity

<section begin="intro"/>'''Network File System''', or '''[http://en.wikipedia.org/wiki/Network_File_System_%28protocol%29 NFS]''', is a way to share folders over a network, and was added to XBMC in v11 (Eden). The main benefits of using NFS instead of SMB are its low protocol overhead (which allows it to send data across a network more quickly) and its use of simple [http://en.wikipedia.org/wiki/User_identifier UID's] to authenticate users rather than username/password combinations.
{{warning|Many people are confused on this point and try to create usernames and passwords to get Kodi to work with NFS: '''NFS does not use usernames or passwords as logins;''' it uses a UNIX-based "userID" (UID) alone.}}<section end="intro"/>

NFS's main disadvantage in comparison to SMB (a commonly-encountered protocol in Windows environments) is that it can be more complicated to set up in some cases, since many non-technical users are unfamiliar with configuring UNIX-based protocols.

NFS is commonly found on all Linux/UNIX distributions, as well as on OS X and Solaris, and offers several features:
:* It is already incorporated in UNIX-like operating systems (such as OS X), eliminating the need for additional software and services to be installed on your computer.
:* It allows for authentication by UID, thus eliminating the need to save usernames and passwords in XBMC source XML files (note, however, that this simple authentication also makes it more vulnerable to attacks; NFS should be only used inside a private LAN).
:* Once properly configured, NFS will allow your network shares to be seen and accessed by not only Kodi, but also any other machine on your network.

;{{note|If you already have a working NFS server check that the export options required by Kodi have been set (as described in the relevant section below).}}

When configuring NFS shares to use as network sources for Kodi's music/video libraries, use the following format: '''nfs://1.2.3.4/path/to/folder''' (where "1.2.3.4" should be replaced with the IP of your NFS server, and "/path/to/folder" should be replaced with the path to the folder you want to share; a double slash between the server and the path is wrong, you '''should not''' use nfs://1.2.3.4//path/to/folder). See the sections below for help configuring NFS shares on various devices' operating systems.

For more info on network sources for your music and video in Kodi, see Types of Media Sources.<br />

== NFS sharing from Windows ==
Windows does not have any built-in native ability to share folders via NFS; and only a limited selection of Windows operating systems have the native ability to access NFS shares as a client. However, several third-party solutions attempt to provide NFS functionality, on both the server side and the client side.

For ''serving'' (sharing) files from Windows using NFS, there seem to be three choices:
:* Windows Server 2003 R2, Windows Server 2008 and Windows Server 2012 have built-in NFS Server and Client through Subsystem for UNIX-based Applications (SUA). With 64-bit support, this solution supports files up to 4TB in size
:* [http://en.wikipedia.org/wiki/Microsoft_Windows_Services_for_UNIX Microsoft Windows Services for UNIX (SFU)] available [http://www.microsoft.com/download/en/details.aspx?id=274 here]for Windows 2000, Windows XP Professional (NOT Home edition, without a [http://www.networkedmediatank.com/showthread.php?tid=1434 hexedit hack]), Windows 2003 Server, and Windows Home Server (based on 2003 Server). SFU is 32-bit only, which ''may'' mean it only supports files up to 2GB in size, [http://www.suacommunity.com/SUA_Tools_Env_Start.htm#_Toc203389873 according to some sources] (this is unconfirmed). A good installation guide can be found [http://www.networkedmediatank.com/showthread.php?tid=1434 here]. Windows SFU will not install on Windows Vista or Windows 7, so there is no way to ''serve'' NFS from Windows Vista or Windows 7 with the possible exception of the haneWIN solution below, but it is unconfirmed if that works with Windows Vista/7.
:* [http://www.hanewin.net/nfs-e.htm haneWIN NFS Server for Windows] - a shareware program that costs 19EUR for non-commercial use. Claims to work for "Windows 2000 and above."

== NFS sharing from OS X ==
NFS is built into Mac OS X (OS 10.5 and later), and thus no additional software is required to set up NFS shares on a Mac OS X device.

;{{note|The following assumes some basic knowledge of the UNIX/BSD operating system interface and environment, and assumes you are familiar with using a Mac's Terminal command-line utility. It also assumes you have a beginner's understanding of UNIX text editors such as [http://mintaka.sdsu.edu/reu/nano.html nano] or [http://www.eng.hawaii.edu/Tutor/vi.html vi].}}

1. To allow regular (non-root) users to connect to your NFS shared folders, you'll need to edit the "/System/Library/LaunchDaemons/com.apple.nfsd.plist" file. Open it and add the option "-N" to the startup parameters as follows:

<array>
<string>/sbin/nfsd</string>
'''<string>-N</string>'''
</array>

If you don't do this step, Kodi will only be able to access the Mac's shared NFS folders if Kodi is running as root (normally, Kodi does not run as root, so you will almost certainly want to do this first step and add the -N parameter).

2. The NFS server and its shared folders are set up in a config file named "exports", located in the /etc directory. Technically speaking, with NFS you "export a path" rather than "share a folder" (which is why the file is named "exports"), but we'll use the latter phrasing for simplicity's sake.

The /etc/exports file may not yet exist; if not, you'll need to create it. The file is edited either manually (in Terminal, using a UNIX text editor such as '''nano''' or '''vi''') or via a GUI utility, the most well-known of which is [http://www.bresink.com/osx/NFSManager.html NFS Manager]. The following guide assumes you are using Terminal (if using NFS Manager, consult that software's documentation for help).

To view the current contents of /etc/exports, if any, execute the following command in a Terminal window:

'''cat /etc/exports'''

Any folders to be shared via NFS should be listed on separate lines, along with any configuration parameters governing connections to those folders. The lines should follow this general format:

/path/to/folder_name_to_share [-parameter1 -parameter2 ...] <IP address restriction (optional)>

<big>Examples</big>

In this sample /etc/exports file, we've set up four folders to be shared via NFS, using various parameters and options. The folders are all contained in a folder called "nfs_shares", and are named to indicate some things about how we've set them up; obviously, on your system, the folder names would be things like "video", "music", and so on.

/nfs_shares/allread -ro -mapall=nobody -alldirs
/nfs_shares/allwrite -mapall=nobody -alldirs -network 192.168.1.0 -mask 255.255.255.0
/nfs_shares/writeAs501 -mapall=501 -alldirs 192.168.1.5
/nfs_shares/Kodiuser

Let's look at what each of these shared folder configurations means.

* The folder "'''/nfs_shares/allread'''" can be accessed from all computers (because no IP address is given), is read-only ("'''-ro'''"), and all incoming connections are assigned the same permissions as the UNIX user "nobody", who has anonymous access ("'''-mapall=nobody'''"). This last parameter ensures that anyone can access the folder, but they will not have any rights on your NFS server other than those belonging to the "nobody" user. Also, the "'''-alldirs'''" parameter is used to indicate that incoming connections can mount either the /allread folder OR any subfolder underneath /allread.

* The folder "'''/nfs_shares/allwrite'''" can be accessed from all computers on the subnet 192.168.1.0/255.255.255.0, has read and write permissions (we've omitted "'''-ro'''"), and again access rights for user "nobody" are assigned ("'''-mapall=nobody'''"). The "'''-alldirs'''" parameter is once again used to allow subfolders to be mounted directly.

* The folder "'''/nfs_shares/writeAs501'''" can be accessed from the computer with an IP of 192.168.1.5, has read and write permissions (again we've omitted "'''-ro'''"), and access rights belonging to users on your system with a UID of 501 (see note below) will be inherited by all incoming connections ('''-mapall=501'''). The "'''-alldirs'''" parameter is once again used to allow subfolders to be mounted directly.

:;{{note|As already mentioned, authentication to the NFS server is done by checking UIDs. For Kodi, this means that the UID which the Kodi process is running under is given to the NFS server to be authenticated. To find out your current UID, just type "id" into a console:}}

Mac:~ [''your_user_name'']$ '''id'''

::You should see something that begins like this:

uid=501(''your_user_name'')

:In this example, my UID is 501. If you are going to be connecting to your NFS shared folder from Kodi on iOS, keep in mind that on iOS Kodi runs as the user "mobile", which should have UID 501 also.

* The folder "'''/nfs_shares/Kodiuser'''" can be accessed from all computers ('''no ip given'''), readwrite (no "'''-ro'''") and the access rights belonging to the UID which is connecting to the NFS server are used ("'''-mapall'''" removed).
;{{note|The important effect of the absence of the -mapall parameter in this case: if someone connects to your NFS server as root, they will be running on your system as root! Also note that because "-alldirs" is not specified, incoming connections will only be able to connect to the /Kodiuser folder, NOT any folders underneath it.}}

Bear in mind that any UID's that are used to connect to the NFS server, or that are specified with "-mapall", have to exist on your NFS server (i.e. on your Mac).

'''Each change on the exports config file needs a restart of the nfs server! Just issue "sudo nfsd restart" for this.'''

3. Once you've configured and saved your /etc/exports file, the NFS server can be started either by rebooting or by executing the following command:

$ sudo nfsd start

=== Troubleshooting NFS on OS X ===

==== -N flag is set, but shares still won’t work ====

Sometimes there are issues with NFS shares on OS X. Most of them result in the <code>-N</code> flag not being set, but they result in different error messages or issues. One of the root issues is the flag being set in the Property List file, but not read by launchd which controls the process. The following observations are pretty common in this case and if you see one of these points, it won’t hurt to either inspect the nfsd process on your Mac or restart the whole computer.

* You have successfully shared the volume and you can mount it from other Macs in your network (via ⌘K in the Finder), but not from Kodi.
* You can add the computer share (e.g. <code>nfs://192.168.1.5/</code>), but not the share that contains a path (e.g. <code>nfs://192.168.1.5/nfs_shares/allread</code>).
* When you add the computer share, you can enter it in Kodi’s browser, but then clicking on one of the mount points does nothing.
* You see either '''"Server responded: Procedure not available"''' or '''"RPC Packet not accepted by the server"''' in the error logs.

In most cases it’s sufficient to restart nfsd via launchd, just killing the process with <code>kill -9</code> or <code>killall nfsd</code> after applying changes to the Property List file has no effects. To restart nfsd via launchd you have to type the following command in the Terminal:

sudo launchctl unload /System/Library/LaunchDaemons/com.apple.nfsd.plist && \
sudo launchctl load /System/Library/LaunchDaemons/com.apple.nfsd.plist

When you use <code>ps</code> to inspect the process, <code>-N</code> should be visible at the end of the line. If it’s not, then launchd didn’t apply the changes and just (re-)started nfsd with the old configuration. A proper output looks like this:

~ '''ps aux | grep nfsd'''
root 55828 0,0 0,0 2500812 2332 ?? Ss 3:54pm 0:08.96 /sbin/nfsd '''-N'''
chiefsucker 58788 0,0 0,0 2435268 496 s000 U+ 7:22pm 0:00.00 grep nfsd

Pay attention to the <code>-N</code> flag being visible in the ps output. If the <code>-N</code> flag is visible, but your shares don’t work, then it’s probably another issue.

==== NFS shares stopped working after OS X upgrade ====

If your share stopped working after you upgraded your OS (e.g. from Lion to Mountain Lion) then it usually means that the installer did overwrite the Property List file and you have to add <code>-N</code> again. See immediately below for Mac OS X 10.11 El Capitan upgrade instructions.

==== Fresh Installs or Upgrading to Mac OS X 10.11 El Capitan through High Sierra ====

Mac OS X 10.11 changed the way the user is allowed to interact with certain system files, including anything in /System/Library/LaunchDaemons/ This is due to SIP [https://en.wikipedia.org/wiki/System_Integrity_Protection (System Integrity Protection)]. Follow these steps to disable SIP, set the -N option in com.apple.nfsd.plist, and re-enable SIP.

# Power up or restart the Mac. At the chime, hold down Command-R to boot into the Recovery Partition.
# Once booted in the Recovery Partition, go to the menu bar and click on '''Utilities''', then select '''Terminal'''.
# Type this into '''Terminal''' to disable SIP: <code>/usr/bin/csrutil disable</code>
# Quit '''Terminal''' and restart the Mac.
# Follow the [http://kodi.wiki/view/NFS#NFS_sharing_from_OS_X intructions from above] to insert the <code>-N</code> option.
# Restart the Mac. At the chime, hold down Command-R to boot into the Recovery Partition.
# Again, go to the menu bar and click on '''Utilities''' and select '''Terminal'''.
# Type this into '''Terminal''' to re-enable SIP: <code>/usr/bin/csrutil enable</code>
# Quit '''Terminal''' and restart the Mac.

==== My Mac goes to sleep while playing a movie from a NFS share ====

OS X 10.8 Mountain Lion introduced some changes that result in very aggressive sleep behaviour. Because NFS shares aren’t handled and treated like shares set from within the Sharing panel in System Preferences, OS X will ignore clients that access your NFS shares and just put it to sleep. Fortunately there are some workarounds:

# Set '''Computer sleep''' in the Energy Saver pane of System Preferences to '''Never'''. Unfortunately this will affect the whole machine and you’ll have to put your Mac manually to sleep from now on.
# Get the [http://itunes.apple.com/app/caffeine/id411246225?mt=12 free Caffeine app from the Mac App Store]. The app will reside in your menu bar and you can prevent your Mac from sleeping with just one mouse-click. If you disable Caffeine (again with one click), your Mac will go to sleep as set in the System Preferences. This has the benefit of adjustable sleep behavior, i.e. you turn Caffeine on when you watch movies and you turn it off otherwise to preserve energy and save the planet.
# You can reach the same goal with the Terminal app <code>caffeinate</code> that gets shipped with the OS since OS X 10.8 Mountain Lion.

== NFS sharing from Linux ==

NFS sharing has been built into linux kernel for a long time.

;{{note|This article assumes some basic knowledge of the Linux/UNIX/BSD operating-system interface and environment.}}

The configuration of the NFS server takes place in the config file "/etc/exports". As already mentioned, the authentication to the NFS server is done through UIDs. For Kodi, this means the UID that the Kodi process is running under is used to authenticate on the NFS server. To find out what UID Kodi is using, just type "id" into a console:

penix:~ [your_user_name]$ id
uid=501(your_user_name)

In this example, my UID is 501. For iOS devices, keep in mind that Kodi is running as the user "mobile", whose UID should also be 501.

A basic configuration for exporting a path with NFS looks like this:

/nfs/export <ip or iprange which is allowed to connect>(rw,all_squash,insecure)

The important options here for use with Kodi are the "ip or iprange" and the "insecure" options. The "insecure" option is needed because we want to be able to run Kodi without root privileges. If the insecure option is not enabled, only the root user (uid 0) will have access to the nfs share. The "ip or iprange" specifies which hosts on the network will be allowed to access the exported NFS share.

By changing some of the options of that line, we can use any of three different approaches for getting the access rights configured as we want:

1. The option all_squash (most insecure) - all UIDs connected to the NFS server are mapped to UID 65534 (user nobody)
::* In this case all files which shall be accessed on the NFS exported path should have the correct rights for the user "nobody".
2. Using the option "all_squash" in conjunction with the option "anonuid" and "anongid"
::* By adding the options "anonuid=501" and "anongid=501" all accesses would be mapped to the user with UID 501 (user "mobile" on iOS or user "memphis" in my example above)
3. Removing the "all_squash" option the accesses will be done with the UID given from the user which is running Kodi
::* So if Kodi is started with username foobar (which has UID 1000) all accesses to the NFS export path will be made with UID 1000.

<big>Examples for exported paths:</big>
### access from ''all computers'' ("'''*'''"), ''readonly'' ("'''ro'''"), access for user ''nobody'' ("'''all_squash'''")
/nfs/allread *(ro,all_squash,insecure)

### access from the subnet 192.168.1.0/255.255.255.0, ''read/write'' ("'''rw'''"), access for user ''nobody''
### ("'''all_squash'''"). Remember that "'''rw'''" doesn't automatically allow writes; the user "nobody" must
### have write access to the path on the filesystem.
/nfs/allwrite 192.168.1.0/24(rw,all_squash,insecure)

### access from 192.168.1.5, ''read/write'' ("'''rw'''"), access for user with UID 501 (i.e. memphis, for me)
### ("'''all_squash,anonuid=501,anongid=501'''")
/nfs/writeAsMemphis 192.168.1.5(rw,all_squash,insecure,anonuid=501,anongid=501)

### access from ''all computers'' ("'''*'''"), ''read/write'' ("'''rw'''"), access for the UID connecting to the
### NFS server ("'''all_squash'''" removed)
/nfs/Kodiuser *(rw,insecure)

### NTFS export *SECURITY Warning: this gives the user ROOT access*
### access from the subnet 192.168.1.0/255.255.255.0, ''read/write'' ("'''rw'''"), nfs client connects
### as root ("'''no_root_squash'''"). Otherwise, permission is for ''nfsnobody'', (uid 65534).
### NTFS is non-POSIX permissions compliant, so you must access the share as ''root''
/nfs/NTFS_share 192.168.1.0/24(rw,'''no_root_squash''',insecure)

The UIDs which are used to connect to the NFS server or which are specified with "anonuid" and "anongid" have to exist on the NFS server. Otherwise the filesystem permission can't be set.

Remember - access rights are these you give in the filesystem. '''After each change to the exports config file issue "sudo exportfs -ra"!'''

<big>'''Notes on serving NFS from Ubuntu 20.04 and other distributions with more modern NFS'''</big>

Ubuntu 20.04 LTS has an updated version of NFS vs. the older version in 16.04 and 18.04.

Combined with the relatively old version of libnfs included with most Kodi distributions at time of writing, this can make NFS set up a little more difficult than with older versions of Ubuntu. (i.e. when using Ubuntu as the server).

The main issue is that server discovery is broken - that is, when you click on the 'nfs' option when adding a source, you will ''not'' see your Ubuntu 20.04 NFS IP appearing in the list of available servers.

In most Kodi locations, you can just explicitly manually enter the full share details (as above, e.g. <code>nfs://192.168.1.5/SomeExport</code>) and you will then be able to use the share that way.

Unfortunately, though, this does not work in ''all'' Kodi file browsers (e.g. when adding a folder for the Kodi Music Information in the Settings -> Media -> Music area). A better solution, then, is to add an explicit entry to your [[mediasources.xml]] file. Note, you don't need to add all the individual NFS ''exports'' - once you have the entry for the ''server'' working, you will then be able to browse the exported shares from that server as normal.

Example <code>mediasources.xml</code> - this one contains both an SMB (with a user/password) and nfs share - both of which will then come up as sources in all Kodi file browsers.

<mediasources>
<network>
<location id="0">smb://user:password@192.168.1.4/</location>
<location id="1">nfs://192.168.1.5/</location>
</network>
</mediasources>

Note, also, that the standard Ubuntu UFW firewall, if enabled, will block incoming NFS connection by default. With NFSv4 clients, where only one standard port (2049) is used, you can add a simple rule to allow NFS through:

sudo ufw allow from 192.168.1.0/24 to any port nfs comment "NFS"

However, Kodi generally mounts using NFSv3, and this is therefore not sufficient. So you'll need to to do two more things - one, force NFS to use a specific port, and then open that port, plus port 111, on UFW as well. The accepted answer to [https://askubuntu.com/questions/103910/nfs-is-blocked-by-ufw-even-though-ports-are-opened/104232 this question on the Ask Ubuntu Stack Exchange] is the solution.

Once all this is done, it is then easy to both find your exports, and you will be able to connect to them.

== NFS sharing from FreeBSD ==
This will get you going with NFSv3.
Edit rc.conf:
nfs_server_enable="YES"
rpcbind_enable="YES"
rpc_lockd_enable="YES"
rpc_statd_enable="YES"
weak_mountd_authentication="yes"

Edit /etc/exports (change to network as required):
/path/to/share -alldirs -maproot=root -network=192.168.1.0/24
After that you can reboot or start the daemons:
service rpcbind start
service nfsd start
service mountd start

For more information refer to the [https://www.freebsd.org/doc/handbook/network-nfs.html FreeBSD handbook entry on NFS]
== NFS sharing from NAS4Free 9.x (successor to legacy FreeNAS 7.x) ==
The information in the Linux section above also applies for *BSD based systems (such as FreeBSD). This section addresses some specific issues to bear in mind if you are using NAS4Free 9.x or FreeNAS 7.x (aka. legacy) installations.

;{{note|FREENAS 8.3.0-RELEASE or later does not require modifying the rc.conf file for Kodi to access NFS shares. You must however enable "allow non-root mount" which can be found under the SERVICES - NFS section in the Freenas 8.3.0 web GUI.}}

Setup your NFS shares as normal. Remember: don't create shares inside other shares. The following would be illegal...
/mnt/disk -alldirs,quiet -mapall=root -network 192.168.1.0 -mask 255.255.255.0
/mnt/disk/folder -alldirs,quiet -mapall=root -network 192.168.1.0 -mask 255.255.255.0
...because the "/mnt/disk/folder" directory is already shared by "/mnt/disk". If you remember to set the setting "All dirs" when creating your NFS shares, the flag "-alldirs" will be set. This flag allows you to mount any subdirectory of your share just as if it was a share itself. Said another way: It's not necessary to share "/mnt/disk/folder" because you can mount it through the "/mnt/disk" share.

After having set up a standard NFS share on your NAS4Free box, you need to add a few variables to rc.conf on NAS4Free. This is done by going into System > Advanced > rc.conf .
Here you need to add the following:
Variable Value Comment
mountd_flags -n Allow non-root mount requests to be served.
nfs_reserved_port_only NO Allow for insecure ports to be used by NFS.
nfs_server_flags -u -t -n 4 Serve UDP and TCP with 4 servers.

After this, apply your changes and reboot NAS4Free. You should now be able to mount your NFS shares, as well as any subdirectory of those shares.

== NFS sharing from ZFSGuru ==
Very similar to FreeNAS solution.
mountd needs the -n flag.
In ZFSGuru you can achieve this by adding
weak_mountd_authentication="YES"
to /etc/rc.conf

== NFS sharing from commercial NAS systems such as Synology or QNAP ==
Each NAS manufacturer, if it allows you to share folders via NFS on its NAS systems, does so in its own way. Often this will involve setup via the NAS's control panel or administrator interface. You can also connect to many NAS systems via ssh and manually edit files in order to set up and configure NFS (consult your NAS manual to see if this is possible/desirable/necessary). Since most NAS systems are based on Linux/UNIX, if you need to manually edit files, you should be able to make use of the [[#NFS sharing from Linux|Linux instructions above]] to create/edit your NFS shares.

=== Troubleshooting NFS on a commercial NAS with Kodi ===
Your NFS server on your NAS needs to be able to allow connections on so-called '''unprivileged ports''', which are port numbers higher than 1023. However, most NAS's are set up by default to deny incoming NFS connections on these unprivileged ports. This is one of the most common reasons why Kodi users experience problems when trying to connect to an NFS shared folder on a NAS.

If you are having trouble connecting to your NFS shares on your NAS from Kodi, make sure your NFS shares have the "insecure" option enabled, which will allow connections on unprivileged ports. To check, connect to your NAS via ssh and issue the '''cat /etc/exports''' command. Your shared folders will each have several parameters listed separated by commas. If the "insecure" parameter is not listed, you will need to add that parameter to the list. This will usually involve directly editing the /etc/exports file with a UNIX text editor and adding the "insecure" option manually, although some NAS's may offer the ability to add the option via an admin interface. Check your NAS manual for details, or explore the section below if your brand of NAS is listed.

=== Commercial NAS NFS setup instructions ===
Kodi users have contributed the following NFS setup instructions for various brands of NAS devices. If your NAS is listed below, feel free to follow the accompanying instructions to set up NFS on your system.

==== Synology ====
[[File:Synology.png|link=]]<br />
;{{note|You do not need to create a special user account on your Synology NAS in order to make use of NFS for Kodi. The following guide assumes you are comfortable with using the simplest (least secure) internal setup on your NAS, which will normally be the case for the vast majority of Kodi users.}}

<gallery widths=600px heights=340px>
File:Step1.png|'''<big>Step 1:</big>''' Log in to your Synology admin control panel.
File:Step2.png|'''<big>Step 2:</big>''' Enable SSH (if not enabled already): Control Panel --> Terminal --> Enable SSH service --> {{button|OK}}

File:Step3.png|'''<big>Step 3:</big>''' Enable NFS under Control Panel --> Win/MAC/NFS
File:Step4.png|'''<big>Step 4:</big>''' NFS Services --> Enable NFS --> {{button|OK}}

File:Step5.png|'''<big>Step 4:</big>''' Under Control Panel --> Shared Folder
File:Step6.png|'''<big>Step 6:</big>''' On NFS Privileges tab select entry for the folders you want to share e.g. '''Movies'''
File:Step7.png|'''<big>Step 7:</big>''' {{button|Create}} privileges for the selected share
File:Step8.png|'''<big>Step 8:</big>''' As per example allow all IPs (or the desired IP for your HTPC) with '''read/write''' permissions with no mapping and enable '''asynchronous'''. The option to '''allow connections from non-priviledged hosts''' is new in DSM version 4.3-3776. Using DSM 5.0-4482 I had to use the "Squash" option and "Map all users to admin".

'''With this option the steps 10 through 14 are no longer necessary.''' --> {{button|OK}}
File:Step9.png|'''<big>Step 9:</big>''' Press {{button|OK}}
</gallery>

;{{note|The below steps are necessary only if you are using a Synology DSM version less than 4.3-3776.}}

'''<big>Step 10:</big>''' On your computer, in a command line window (Terminal on a Mac, CMD on a Windows PC, etc), ssh into your Synology:
'''ssh root@<<YOUR.SYNOLOGY.IP.ADDRESS>>'''

'''<big>Step 11:</big>''' Type in '''cat /etc/exports''' to make sure your previous steps have created exported NFS directories. If no entries are found, go back to the previous steps and make sure you've followed them correctly. You should be seeing something like this:

[[File:Step11.png|600px]]

'''<big>Step 12:</big>''' Type '''vi /etc/exports''' to edit the /etc/exports file, and change all the "insecure_locks" entries to simply read "insecure". If you don't know vi: press the INS[SERT] key, use arrows to go to the line to edit, and delete/edit the line. Then press the ESC key, and type ''':x''' to 'Save & Exit'.<br />
13. Type '''cat /etc/exports''' again, and you should now see something like this (make sure it says "insecure" rather than "insecure_locks"):

[[File:Step15.png|600px]]

'''<big>Step 14:</big>''' Type '''exportfs -ra''' to initialize your newly exported directories, or reboot the NAS.<br />
'''<big>Step 15:</big>''' You should now be able to browse NFS and get to your exported Synology subfolders in Kodi.<br />
===== Synology DSM 5.1 =====
<gallery widths=600px heights=340px>
File:syn5step1.png|'''<big>Step 1:</big>''' Enable NFS under Control Panel --> File Services
File:syn5step2.png|'''<big>Step 2:</big>''' NFS Services --> Enable NFS --> Press Apply

File:syn5step3.png|'''<big>Step 3:</big>''' Under Control Panel --> Shared Folder
File:syn5step4.png|'''<big>Step 4:</big>''' Select entry for the folders you want to share e.g. '''video''' and click '''Edit'''
File:syn5step5.png|'''<big>Step 5:</big>''' Under '''permissions''' tab add permission '''read/write''' for user '''admin'''
File:syn5step6.png|'''<big>Step 6:</big>''' Under '''NFS Permissions''' tab add permission click '''Create''' to create NFS permissions
File:syn5step7.png|'''<big>Step 7:</big>''' As per example allow all IPs (or the desired IP for your HTPC) with '''read/write''' permissions, Squash '''Map all users to admin''', Security '''sys''', and enable '''asynchronous'''. The option '''allow connections from non-priviledged ports''' selected. '''Allow users to access mounted subfolders''' also selected.
</gallery>
'''<big>Step 8:</big>''' Click '''OK''' to save changes. And now you should be able to access video folder via NFS protocol
==== QNAP ====
[[File:QNAP.gif|link=]]<br />
;{{note|You do not need to create a special user account on your QNAP NAS in order to make use of NFS for Kodi. The following guide assumes you are comfortable with using the simplest (least secure) internal setup on your NAS, which will normally be the case for the vast majority of Kodi users.}}

This guide requires you to SSH into your QNAP, and also to use the terminal editor [http://en.wikipedia.org/wiki/Vi Vi] to edit files.

Here's a couple of guides if you wish to learn more, but feel free to google for further reading:

[http://www.tuxfiles.org/linuxhelp/vimcheat.html Vi Cheat Sheet]

1. Log into your QNAP admin control panel. (Web browser = IP-ADDRESS:8080).

<gallery widths=700px heights=340px>
File:QNAP_SSH.png|'''<big>Step 2:</big>''' Enable SSH (if not already): Network Services -> Telnet / SSH -> 'tick' Allow SSH connection, Press {{button|Apply}}
File:QNAP_NFS.png|'''<big>Step 3:</big>''' Enable NFS: Network Services -> NFS Service -> 'tick' Enable NFS Service, Press {{button|Apply}}
</gallery>
<gallery widths=600px heights=350px>
File:QNAP_Shares.png|'''<big>Step 3:</big>''' Set NFS Access Rights: Under "Enable NFS Service" Click on "Click here to set the NFS access right of the network share"
File:QNAP_NFS_Access.png|'''<big>Step 4:</big>''' Click on the NFS icon next to Qmultimedia (or whatever the name of your media share on the QNAP) and set Access Right to No Limit and put in the IP Address of each individual device that requires NFS connection (ATV2, Desktop, Laptop, etc.), Press {{button|Apply}}
</gallery>

6. On your computer, in a command line window (Terminal on a Mac, CMD on a Windows PC, etc), ssh into your QNAP:
'''ssh admin@<<YOUR QNAP IP ADDRESS>>'''

7. Type in '''cat /etc/exports''' to make sure your previous steps have created exported NFS directories. If no entries are found, go back to the previous steps and make sure you've followed them correctly. You should be seeing something like this:
"/share/MD0_DATA/Qmultimedia" 192.168.1.15(rw,async,no_root_squash) 192.168.1.20(rw,async,no_root_squash)
"/share/NFS/Qmultimedia" 192.168.1.15(rw,nohide,async,no_root_squash) 192.168.1.20(rw,nohide,async,no_root_squash)

8. Type '''vi /etc/exports''' to edit the /etc/exports file, and add "insecure" entries inside the brackets in front "rw"(separated with a comma ","). If you don't know vi: press the "i" key, use arrows to go to the line to edit, and add the entries. Then press the ESC key, and type ''':wq''' to 'Save & Exit'. Your exports file should now look something like this:
"/share/MD0_DATA/Qmultimedia" 192.168.1.15(insecure,rw,async,no_root_squash) 192.168.1.20(insecure,rw,async,no_root_squash)
"/share/NFS/Qmultimedia" 192.168.1.15(insecure,rw,nohide,async,no_root_squash) 192.168.1.20(insecure,rw,nohide,async,no_root_squash)

9. Type '''exportfs -ra''' to initialize your newly exported directories, <span style="color:#FF0000">'''DO NOT''' reboot the QNAP or restart NFS via the QNAP Admin page - If you do the QNAP will overwrite the changes you just made</span>.

<gallery widths=415px heights=168px>
File:QNAP_nfssetting_before.png|'''<big>Step 10:</big>''' Now type '''vi /etc/config/nfssetting'''. You'll see something like this:
File:QNAP_nfssetting_after.png‎|'''<big>Step 11:</big>'''Move your cursor to after the '''rw''' in the line '''/share/*****/Qmultimedia = rw''' (***** interchangeable with whatever yours says). Press {{keypress|i}} and add '''insecure''' separated by a ''',''' (comma). When you're done editing press {{keypress|esc}} and then ''':wq''' to save the changes and close the file. It will look something like this when finished:
</gallery>
<span style="color:#FF0000">'''CAUTION: If you reboot your QNAP NAS at any time after completing the steps above, but before completing the steps below, the changes you've made will be wiped out and you will need to redo the process.'''</span>

12. That should be it for getting it working.. You should now be able to browse NFS and get to your exported QNAP folders in Kodi. Now there's just a few more steps to ensure all your hard work survives a reboot/firmware upgrade.

* We're going to edit/create an autorun script that overwrites two files from backups we're going to make.

13. Okay, you need to make a folder to store the backup files. You need to use the absolute path in the Autorun script. Type '''mkdir /share/MD0_DATA/backups''' and press '''enter'''. (The MD0_DATA part could be different on your model, I'm running a TS-509).

14. Now type '''cp /etc/exports /share/MD0_DATA/backups/exports''' and press enter.

15. Type '''cp /etc/config/nfssetting /share/MD0_DATA/backups/nfssetting''' and press enter.

16. Now for the fun part. To mount the ramblock follow the procedure below. This is based on the guide here (Method 1): [http://wiki.qnap.com/wiki/Running_Your_Own_Application_at_Startup QNAP Autorun Wikiguide]

17. Pick the method that is applicable to your QNAP model.
## Model TS-201: Mount the config ramblock /dev/mtdblock4: <pre># mount -t ext2 /dev/mtdblock4 /tmp/config </pre>
## Models TS-109, TS-109P, TS-110, TS-119, TS-209, TS-209P, TS-219, TS-409 (Marvell ARM), TS-419P: Mount the config ramblock /dev/mtdblock5: <pre># mount -t ext2 /dev/mtdblock5 /tmp/config</pre>
## Models TS-439, TS-509, TS-639, TS-809, TS-809U (x86): Mount the config ramblock /dev/sdx6: <pre># mount -t ext2 /dev/sdx6 /tmp/config</pre>
# Create/Edit /tmp/config/autorun.sh .
## either using vi: <pre># vi /tmp/config/autorun.sh</pre>
### Get vi editor into edit mode: '''press i'''
### Add these lines to the autorun.sh script:
### '''cp /share/MD0_DATA/backups/exports /etc/exports'''
### '''cp /share/MD0_DATA/backups/nfssetting /etc/config/nfssetting'''
### Exit edit mode: '''press ESC'''
### Save and exit: ''':wq'''
## or editing it using a desktop PC and e.g. SFTP
# Ensure that /tmp/config/autorun.sh is executable: <pre># chmod +x /tmp/config/autorun.sh</pre>
# '''IMPORTANT:''' Unmount the mounted flash partition: <pre># cd /</pre> <pre># umount /tmp/config</pre>

18. Finish the linked guide, making sure to unmount the ramblock. (You will need to cd away from the /tmp/config directory to umount it.

19. Should be done!

==== Thecus ====
[[File:thecuslogo.png|link=]]<br />

<gallery widths=600px heights=340px>
File:Thecus1.png|'''<big>Step 1:</big>''' Log in to your ThecusOS interface and select '''Network Service'''.
File:Thecus2.png|'''<big>Step 2:</big>''' Enable NFS and click {{button|Apply}}
File:Thecus3.png|'''<big>Step 3:</big>''' Go to the '''Share Folders''' entry in the '''Storage'''-section. Select the folder, you want to share via NFS and click on NFS.
File:Thecus4.png|'''<big>Step 4:</big>''' You can now define specific hosts and access rights. '''!!!IMPORTANT!!!''' Activate AIX as OS support, otherwise Android Kodi won't be supported. {{button|Apply}}
</gallery>

{{Isengard updated}}

UPnP

2022-12-10T03:22:50Z

LGoosens: Structured markup for clarity

{{mininav|[[Video library]] {{l2| [[Music library]] }} | [[File sharing]] }}

= Introduction=

<section begin="intro" />{{Kodi}} can be used as a UPnP Server that will stream its library contents to other players on the network, or it can be used as a UPnP Client that can receive music and video from a UPnP Server on the network. <section end="intro" />

When using UPnP:
* The client player does not have direct access to the video and music files. It relies on the UPnP server to send a '''browse tree''' that will display on the client player.
* The UPnP Server cotrols the appearance of what is displayed in the browse tree which varies between different UPnP servers.
* The browse tree can provide a series of nodes through which you can browse the content (year, title, actors, artists, albums etc).
* If using the {{kodi}} UPnP Server, these browse tree nodes are based on the {{Kodi}} library nodes and you can create additional nodes in the {{kodi}} server to expand the browse tree.

{{note|UPnP file sharing cannot be used to create a {{kodi}} library on the client device, nor can you use any library features. You can only browse and play from the Browse Tree.}}

{{warning|UPnP has inherent security risks. If your router has the UPnP setting enabled, then malicious actors may be able to access your network. You should be able to disable UPnP in your router, but still use UPnP on your local network.}}

= Settings =
{{Kodi}} UPnP is disabled by default and must be activated before use.

* If you intend to use {{kodi}} as the UPnP Server, then select the {{Kodi}} installation that has the fully scanned/scraped library that you would like shared to your other devices.
* Then setup Clients to receive the UPnP video and music libraries from the Server. You would not normally set your {{Kodi}} install as both a Server and Client.

UPnP settings can be found in {{highlight|bordered=yes|[[Settings/Services/UPnP_DLNA|'''Settings -> Services -> UPnP / DLNA''']]}}

= Create UPnP Source in Client =
<gallery mode="packed" widths="500px" heights="283px">
File:Quick-start-2.1.png|'''Step 1:''' From '''Videos>Files''' select '''Add videos...'''<br />
File:Share-upnp-library.jpg|'''Step 2:''' Click '''Browse'''
File:Share-upnp-library2.png|'''Step 3:''' Select '''UPnP Devices'''
File:Share-upnp-library3.png|'''Step 4:''' All available UPnP servers on your network should show up here. Select the UPnP server you wish to add. If a server is not listed you may have incorrectly adjusted your settings
File:Share-upnp-library4.png|'''Step 5:''' Select which content to be added.
File:Share-upnp-library5.png|'''Step 6:''' Choose which method to use. '''Files''' will require you to constantly select a Source to browse. '''Movies / TV Shows''' will provide the full library list of movies/tv shows. '''Playlist''' Allows you to curate lists to browse.
File:Share-upnp-library6.png|'''Step 7:''' If selecting '''Movies / TV Shows''' in the previous step, further refine how to browse the listing or press '''OK''' to always browse from this point
File:Share-upnp-library7.png|'''Step 8:''' If you chose to further refine, press '''OK''' on this screen. At this point it is normal for the list to be empty
File:Share-upnp-library8.png|'''Step 9:''' If required, you can change the name of the Source. Either way, select '''OK'''
File:Share-upnp-library9.jpg|'''Step 10:''' Setup is complete. Browsing via UPnP is performed from this screen, or add the Source to your Favourites list, or create a [[Custom home items|New main menu item]].
</gallery>

= Stream to Clients =
{{kodi}} can also be a Control Point in addition to being a UPnP server, allowing you to select which client will commence playback of the currently selected title.

To enable and use this features:
# On the {{kodi}} server enable the setting '''Look for remote UPnP players''' in {{highlight|bordered=yes|[[Settings/Services/UPnP_DLNA|Settings → Services → UPnP / DLNA]]}}.
# When browsing on the {{kodi}} server, call up the [[Basic_controls#Context_Menu|Context Menu]]
# Select '''Play with...''' and a list of UPnP clients will be listed.
# Select the client that will be used for playback
# If playing to a {{kodi}} client, ensure the client has the setting '''Allow control of Kodi via UPnP''' enabled in {{highlight|bordered=yes|[[Settings/Services/UPnP_DLNA|Settings → Services → UPnP]]}}.

{{top}}

{{updated|19}}

[[Category:Karellen]]
[[Category:File_sharing]]
[[Category:Video library]]
[[Category:Music library]]

User:LGoosens

2022-12-10T03:11:57Z

LGoosens:

Hi there!

I've been running my own Kodi Media Center (on LibreELEC generic) for about 2-3 years now, and I must say I'm impressed by Kodi's robust foundation.
Given the great job other people already did, I'm mostly interested in polishing stuff (a bit of a hobby of mine) and helping to iron out some wrinkles.
As I do that for my own setup, I use the wiki a lot, so why not kill two birds with one stone?

'''In case you're wondering, currently I'm mostly editing the wiki for markup/readability.'''
I have experience (non-commercially) in graphic design, and I've noticed there is a lot of text in the wiki that only applies to certain scenarios. Visually differentiating between those could help people navigate and skim the wiki more easily.

{{warning|I just started however, so if you think I have misunderstood a convention or messed something up: please let me know what the problem is, and I will correct it.}}

As I get to know Kodi more and more on a day to day basis, in the future I might also be interested in contributing code. In the beginning though, I could use some pointers.

[[User:LGoosens|LGoosens]] ([[User talk:LGoosens|talk]]) 03:02, 10 December 2022 (UTC)

User:LGoosens

2022-12-10T03:10:40Z

LGoosens:

Hi there!

I've been running my own Kodi Media Center (on LibreELEC generic) for about 2-3 years now, and I must say I'm impressed by Kodi's robust foundation.
Given the great job other people already did, I'm mostly interested in polishing stuff (a bit of a hobby of mine) and helping to iron out some wrinkles.
As I do that for my own setup, I use the wiki a lot, so why not kill two birds with one stone?

'''In case you're wondering, currently I'm mostly editing the wiki for markup/readability.'''
I have experience (non-commercially) in graphic design, and I've noticed there is a lot of text in the wiki that only applies to certain scenarios. Visually differentiating between those could help people navigate and skim the wiki more easily.

{{warning|I just started however, so if you think I have misunderstood a convention or messed something up: please let me know what the problem is, and I will correct it.}}

As I get to know Kodi more and more on a day to day basis, in the future I might also be interested in contributing code.

[[User:LGoosens|LGoosens]] ([[User talk:LGoosens|talk]]) 03:02, 10 December 2022 (UTC)

User:LGoosens

2022-12-10T03:08:52Z

LGoosens:

Hi there!

I've been running my own Kodi Media Center (on LibreELEC generic) for about 2-3 years now, and I must say I'm impressed by Kodi's robust foundation.
Given the great job other people already did, I'm mostly interested in polishing stuff (a bit of a hobby of mine) and helping to iron out some wrinkles.
As I do that for my own setup, I use the wiki a lot, so why not kill two birds with one stone?

'''In case you're wondering, currently I'm mostly editing the wiki for markup/readability.'''
I have experience (non-commercially) in graphic design, and I've noticed there is a lot of text in the wiki that only applies to certain scenarios. Visually differentiating between those could help people navigate and skim the wiki more easily.

I just started however, so if you think I have misunderstood a convention or messed something up: please let me know what the problem is, and I will correct it.

{{note|As I get to know Kodi more and more on a day to day basis, in the future I might also be interested in contributing code.}}

[[User:LGoosens|LGoosens]] ([[User talk:LGoosens|talk]]) 03:02, 10 December 2022 (UTC)

User:LGoosens

2022-12-10T03:07:52Z

LGoosens:

Hi there!

I've been running my own Kodi Media Center (on LibreELEC generic) for about 2-3 years now, and I must say I'm impressed by Kodi's robust foundation.
Given the great job other people already did, I'm mostly interested in polishing stuff (a bit of a hobby of mine) and helping to iron out some wrinkles.

'''In case you're wondering, currently I'm mostly editing the wiki for markup/readability.'''
I have experience (non-commercially) in graphic design, and I've noticed there is a lot of text in the wiki that only applies to certain scenarios. Visually differentiating between those could help people navigate and skim the wiki more easily.

I just started however, so if you think I have misunderstood a convention or messed something up: please let me know what the problem is, and I will correct it.

{{note|As I get to know Kodi more and more on a day to day basis, in the future I might also be interested in contributing code.}}

[[User:LGoosens|LGoosens]] ([[User talk:LGoosens|talk]]) 03:02, 10 December 2022 (UTC)

User:LGoosens

2022-12-10T03:04:43Z

LGoosens:

Hi there!

I've been running my own Kodi Media Center (on LibreELEC generic) for about 2-3 years now, and I must say I'm impressed by Kodi's robust foundation.
Given the great job other people already did, I'm mostly interested in polishing stuff (a bit of a hobby of mine) and helping to iron out some wrinkles.

'''In case you're wondering, currently I'm mostly editing the wiki for markup/readability.'''
I have experience (non-commercially) in graphic design, and I've noticed there is a lot of text in the wiki that only applies to certain scenarios. Visually differentiating between those could help people navigate and skim the wiki more easily.

{{note|As I get to know Kodi more and more on a day to day basis, in the future I might also be interested in contributing code.}}

[[User:LGoosens|LGoosens]] ([[User talk:LGoosens|talk]]) 03:02, 10 December 2022 (UTC)

User:LGoosens

2022-12-10T03:02:56Z

LGoosens:

Hi there!

I've been running my own Kodi Media Center (on LibreELEC generic) for about 2-3 years now, and I must say I'm impressed by Kodi's robust foundation.
Given the great job other people already did, I'm mostly interested in polishing stuff (a hobby of mine) and helping to iron out some wrinkles.

In case you're wondering, currently I'm mostly editing the wiki for markup/readability. I have experience (non-commercially) in graphic design, and I've noticed there is a lot of text in the wiki that only applies to certain scenarios. Visually differentiating between those could help people navigate and skim the wiki more easily.

{{note|As I get to know Kodi more and more on a day to day basis, in the future I might also be interested in contributing code.}}

[[User:LGoosens|LGoosens]] ([[User talk:LGoosens|talk]]) 03:02, 10 December 2022 (UTC)

User:LGoosens

2022-12-10T03:02:41Z

LGoosens: Created page with "Hi there! I've been running my own Kodi Media Center (on LibreELEC generic) for about 2-3 years now, and I must say I'm impressed by Kodi's robust foundation. Given the great job other people already did, I'm mostly interested in polishing stuff (a hobby of mine) and helping to iron out some wrinkles. In case you're wondering, currently I'm mostly editing the wiki for markup/readability.|I have experience (non-commercially) in graphic design, and I've noticed there is..."

Hi there!

I've been running my own Kodi Media Center (on LibreELEC generic) for about 2-3 years now, and I must say I'm impressed by Kodi's robust foundation.
Given the great job other people already did, I'm mostly interested in polishing stuff (a hobby of mine) and helping to iron out some wrinkles.

In case you're wondering, currently I'm mostly editing the wiki for markup/readability.|I have experience (non-commercially) in graphic design, and I've noticed there is a lot of text in the wiki that only applies to certain scenarios. Visually differentiating between those could help people navigate and skim the wiki more easily.

{{note|As I get to know Kodi more and more on a day to day basis, in the future I might also be interested in contributing code.}}

[[User:LGoosens|LGoosens]] ([[User talk:LGoosens|talk]]) 03:02, 10 December 2022 (UTC)

SMB

2022-12-10T02:41:57Z

LGoosens: Fixed link I just broke (had to use escape character or divbox would break)

{{mininav| [[File sharing]] }}

__TOC__

= Introduction =
<section begin="intro"/>Windows File Sharing, aka Server Message Block (SMB), is the standard client-server protocol used by Windows to share resources over a local network. SMB is available on all Windows computers and can be easily setup by the home user. SMB can also be accessed by other operating systems, which makes SMB the most commonly used network protocol to access content on a NAS or other remote hardware.<section end="intro"/>

{{note|SMB v1 is not supported in {{kodi}}. SMB v2 or higher must be used.}}

{{divbox|yellow|This page will detail how to add a network source to {{kodi}} using SMB. It assumes you have already correctly set up your SMB network.|If you have not set up your SMB network, a Google search will return numerous online guides. The following links may help also.

* Android : [https://www.howtogeek.com/191378/how-to-access-shared-windows-folders-on-android-ipad-and-iphone/ How-To Geek]
* Linux : [http://www.samba.org SAMBA].
* Mac : [https://support.apple.com/en-au/guide/mac-help/mh17131/10.15 macOS User Guide site]
* Windows : [https://forum.kodi.tv/showthread.php?tid=362113 Forum step-by-step guide]}}

= Methods =
Once SMB is implemented and the Source folders containing your media have been given Read/Write permission the [[Source folder]](s) can be added to {{kodi}}

Two methods are available, the first method being the simplest.

From the '''Browse for new share''' window ''(image 1 in both sections)'', select one of the following methods:

== Windows Network (SMB) ==
When SMB v1 was deprecated by Microsoft due to security reasons, it was no longer possible to browse SMB shares. Instead it required you to add the specific IP Address or Device Name followed by the path to access shares. (detailed in the next section)

As of '''{{kodi}} v19.1''', the '''[[w:WS-Discovery|WS-Discovery protocol]]''' was implemented to allow browsing SMB shares again. <ref>https://github.com/xbmc/xbmc/pull/19499</ref> <ref>https://github.com/xbmc/xbmc/pull/19532</ref>

WS-Discovery is enabled by default on all Windows 10 installations and is well supported from Windows 7.

To add a share using this method, select '''Windows network (SMB)''' from the '''Browse for new shares''' list, then browse to the required '''[[Source_folder|Source folder]]'''.

<gallery mode="packed" widths="500px" heights="283px">
File:Add-Network-Location.png |Image 1- Select '''Windows network (SMB)''' from the '''Browse for new shares''' list.
File:Add-Network-Location_7.jpg|Image 2- Continue to drill down until the required Source folder is located, then select '''OK'''.
</gallery>

== Add Network Location ==
If the previous method is not available to you, then Shares can still be manually added using either the IP Address or Device Name method.

; IP address
: If using the IP Address method, ensure you reserve a DHCP address (static IP) for your NAS or other hardware. This ensures that your router will always allocate the same IP address to the server. If you choose not to do this, then you may find that the router has allocated a different address to your NAS and {{kodi}} will no longer be able to access the media files.

: To reserve a static IP address, log into your router and add the MAC address of the hardware to the Reservation list in your Router. If you do not know the MAC address, you should see it in the list of connected clients.

; Device Name
: If using Windows PC's you can use the Device Name of the PC.

: The Device Name can be found in your Windows PC under ''Settings > System > About''.

{{note|Choose either Step 4 (IP Address) or Step 5 (Device Name), not both}}

<gallery mode="packed" 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- Select '''Windows network (SMB)''' for '''Protocol'''.<br>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.
File:Add-Network-Location_4.png|Image 4- Using '''IP Address'''<br> '''4.1''' Browse is not supported. <br> '''4.2''' In the '''Shared folder''' section, type in the name of the folder to add.<br> Add the drive letter ''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'''
File:Add-Network-Location_5.jpg|Image 5- Using '''Device Name'''<br>'''5.1''' Browse is not supported. <br> '''5.2''' In the '''Shared folder''' section, type in the name of the folder to add <br>The drive letter is not required.<br>'''5.3''' If your share requires a '''Username''' and '''Password''' enter them in the appropriate sections.<br>'''5.4''' Select '''OK'''
File:Add-Network-Location_6.jpg|Image 6- Your share should appear in the '''Browse for new share''' list. <br>The share will show either the IP Address or Device Name depending on which method you used.
</gallery>

= References =
<references />

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

[[Category:Karellen]]
[[Category:File sharing]]

SMB

2022-12-10T02:39:20Z

LGoosens: Structured markup for clarity - if other conventions exist, please advise

{{mininav| [[File sharing]] }}

__TOC__

= Introduction =
<section begin="intro"/>Windows File Sharing, aka Server Message Block (SMB), is the standard client-server protocol used by Windows to share resources over a local network. SMB is available on all Windows computers and can be easily setup by the home user. SMB can also be accessed by other operating systems, which makes SMB the most commonly used network protocol to access content on a NAS or other remote hardware.<section end="intro"/>

{{note|SMB v1 is not supported in {{kodi}}. SMB v2 or higher must be used.}}

{{divbox|yellow|This page will detail how to add a network source to {{kodi}} using SMB. It assumes you have already correctly set up your SMB network.|If you have not set up your SMB network, a Google search will return numerous online guides. The following links may help also.

* Android : [https://www.howtogeek.com/191378/how-to-access-shared-windows-folders-on-android-ipad-and-iphone/ How-To Geek]
* Linux : [http://www.samba.org SAMBA].
* Mac : [https://support.apple.com/en-au/guide/mac-help/mh17131/10.15 macOS User Guide site]
* Windows : [https://forum.kodi.tv/showthread.php?tid%3D362113 Forum step-by-step guide]}}

= Methods =
Once SMB is implemented and the Source folders containing your media have been given Read/Write permission the [[Source folder]](s) can be added to {{kodi}}

Two methods are available, the first method being the simplest.

From the '''Browse for new share''' window ''(image 1 in both sections)'', select one of the following methods:

== Windows Network (SMB) ==
When SMB v1 was deprecated by Microsoft due to security reasons, it was no longer possible to browse SMB shares. Instead it required you to add the specific IP Address or Device Name followed by the path to access shares. (detailed in the next section)

As of '''{{kodi}} v19.1''', the '''[[w:WS-Discovery|WS-Discovery protocol]]''' was implemented to allow browsing SMB shares again. <ref>https://github.com/xbmc/xbmc/pull/19499</ref> <ref>https://github.com/xbmc/xbmc/pull/19532</ref>

WS-Discovery is enabled by default on all Windows 10 installations and is well supported from Windows 7.

To add a share using this method, select '''Windows network (SMB)''' from the '''Browse for new shares''' list, then browse to the required '''[[Source_folder|Source folder]]'''.

<gallery mode="packed" widths="500px" heights="283px">
File:Add-Network-Location.png |Image 1- Select '''Windows network (SMB)''' from the '''Browse for new shares''' list.
File:Add-Network-Location_7.jpg|Image 2- Continue to drill down until the required Source folder is located, then select '''OK'''.
</gallery>

== Add Network Location ==
If the previous method is not available to you, then Shares can still be manually added using either the IP Address or Device Name method.

; IP address
: If using the IP Address method, ensure you reserve a DHCP address (static IP) for your NAS or other hardware. This ensures that your router will always allocate the same IP address to the server. If you choose not to do this, then you may find that the router has allocated a different address to your NAS and {{kodi}} will no longer be able to access the media files.

: To reserve a static IP address, log into your router and add the MAC address of the hardware to the Reservation list in your Router. If you do not know the MAC address, you should see it in the list of connected clients.

; Device Name
: If using Windows PC's you can use the Device Name of the PC.

: The Device Name can be found in your Windows PC under ''Settings > System > About''.

{{note|Choose either Step 4 (IP Address) or Step 5 (Device Name), not both}}

<gallery mode="packed" 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- Select '''Windows network (SMB)''' for '''Protocol'''.<br>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.
File:Add-Network-Location_4.png|Image 4- Using '''IP Address'''<br> '''4.1''' Browse is not supported. <br> '''4.2''' In the '''Shared folder''' section, type in the name of the folder to add.<br> Add the drive letter ''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'''
File:Add-Network-Location_5.jpg|Image 5- Using '''Device Name'''<br>'''5.1''' Browse is not supported. <br> '''5.2''' In the '''Shared folder''' section, type in the name of the folder to add <br>The drive letter is not required.<br>'''5.3''' If your share requires a '''Username''' and '''Password''' enter them in the appropriate sections.<br>'''5.4''' Select '''OK'''
File:Add-Network-Location_6.jpg|Image 6- Your share should appear in the '''Browse for new share''' list. <br>The share will show either the IP Address or Device Name depending on which method you used.
</gallery>

= References =
<references />

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

[[Category:Karellen]]
[[Category:File sharing]]

Updating or removing videos

2022-12-10T02:00:46Z

LGoosens: Structured markup for clarity

{{VideoLibraryCreate}}
{{mininav|[[Video library]]}}

= Introduction =
<section begin="intro" />This page details the available methods to add, modify and remove videos from your '''existing''' video library. These instructions also apply to Music Videos<section end="intro" />

{{red|'''This page assumes you have an existing Movie, TV Show and/or Music Video library.'''}} If you do not have an existing video library, you will need to create one by following the '''''[[:HOW-TO:Create_Video_Library| Create Video Library]]''''' guide.

{{note|If you use File View or File Manager, this page does not apply.}}

= Locating Missing Titles =
The '''''[[Event_Log|Event Log]]''''' will record any files missed when an Update Library is performed. If the log is currently empty, or lists no missing movies, TV Shows or episodes, then perform an Update Library and check the Event Log again.
{{See|Event_Log}}
{{-}}

= Add To Library =
The following methods are available to scan folders and locate new titles to add to the Library. They can be performed on the entire library, a particular Source, or an individual title.

If you use '''''[[NFO_files|NFO Files]]''''', '''new''' titles will be added to the library.

If you have changed the information inside a NFO File for an '''existing''' title in the library, this section will '''not''' update the library with those changes. You will need to perform one of the '''''[[Updating_or_removing_videos#Refresh_Library|Refresh Library]]''''' methods detailed in Section 4 below.

== Update Library- Automatic ==
<gallery widths=500px heights=285px>
File:Settings_media_library_video_library.jpg|Image 1
</gallery>

By enabling the setting ''''Update library on startup'''' the library will be scanned for new content each time {{kodi}} is started.

If you do not add new titles to your library very often, you should disable this setting and use one of the other methods when new titles are added.

{{see|Settings/Media/Library}}

== Update Library- Manual ==
[[File:EstuarySideBarMenu_small.gif|right]]

Perform a manual Update Library from the '''''[[Basic_controls#Sideblade_Menu|Left Sideblade Menu]]''''' by selecting '''Update Library'''

{{see|Basic_controls}}
{{-}}

== Update Library- via Add-ons ==
* '''''[[Add-on:XBMC Library Auto Update]]''''' can be used to schedule automatic updates to the library.

== Scan By Source ==
<gallery widths=500px heights=285px>
File:EstuaryContextmenu3.png|Image 1- From the Context Menu select '''Scan for new content'''
</gallery>

When {{kodi}} performs an Update Library it scans each Source, and each file and folder in the Source, searching for new items. For larger libraries this can be quite a lengthy and unnecessary process.

It is possible to reduce the duration of this process by scanning a single source only.

#Navigate to '''Videos>Files'''
#Highlight the Source to be scanned for new videos
#Call up the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' (see image)
#Select '''Scan for new content''' (see image)

{{Kodi}} will scan the selected Source for new content.

== Add Individual Titles ==
To scan a single title into the library, follow these steps.

#Navigate to '''Videos/Files'''
#Select the Source that contains the title to be scraped into the library
#Locate and highlight the title to be added
#Either:
##Call up the Information page for the video by pressing {{keypress|i}} on your remote or keyboard. This will commence the scrape for this single title, or
##Using the '''''[[Basic_controls#Context_Menu|Context Menu]]''''', select '''Scan item to library'''

To add new '''Episodes''' to an existing TV Show...
#Follow the same steps as above
#Select '''Scan for new content''' instead

= Refresh Library =
The Refresh options are used to modify '''existing''' library entries. You would use these options when...

*The NFO File has been modified and you would like that change to show in the Library
*The information at the site of the Information Provider has changed, and you would like the new metadata or artwork in the library

These methods will not work in the following situations as they are seen as '''new''' titles.
*The path to the entry has changed. eg you moved a movie from D:\ drive to F:\ drive
*The name of the video file or folder has changed.
*The file format has been changed. eg you converted the Bluray folder to a *.mkv file

Use one of the '''''[[Updating_or_removing_videos#Add_To_Library|Add To Library]]''''' options above.

== Refresh Source ==
Use this procedure if there are multiple changes to be added to the library for existing library titles.

Can also be used to scrape bulk new Artwork

<gallery widths=500px heights=285px>
File:Quick-start-6.png|Image 1- Select '''This directory contains'''
File:Quick-start-6.1.png|Image 2- Select appropriate content
</gallery>

# Navigate to and enter '''Files'''
# Highlight the source to be refreshed
# Call up the '''''[[Basic_controls#Context_Menu|Context Menu]]'''''
# Select '''Change content'''
# Change the '''''[[Adding_video_sources#Set_Media_Type|Content Setting]]''''' by adjusting '''This directory contains''' to '''None'''
# Select '''OK'''
# {{Kodi}} will ask '''Do you want to remove all items within this path from your library?'''. Select '''Yes'''
# Perform a '''Clean Library''' from '''''[[Settings/Media/Library#Video_Library|Settings>Media>Library]]'''''
# From step 1 change the content setting back to its previous setting using '''Set Content''' in the context menu
# {{kodi}} will ask '''Do you want to refresh information for all items within this path?''' Answer '''Yes'''
# {{kodi}} will scan the Source and scrape the videos with the new information.

It is also possible to '''Refresh''' the Source by changing the Scraper in use. For example, you may want to change the Information Provider from TheMovieDB to, say, IMDB.
# Navigate to and enter '''Files'''
# Highlight the source to be refreshed
# Call up the '''''[[Basic_controls#Context_Menu|Context Menu]]'''''
# Select '''Change content'''
# Select '''Choose information provider'''
# Select the required scraper add-on
# Select '''OK'''
# {{Kodi}} will ask '''Do you want to refresh information for all items within this path?''' .
#* Select '''Yes''' if you want to refresh all entries in the library
#* Select '''No''' if you do not want to refresh all entries. All new titles added from this point on will use the new scraper

{{red|'''Be aware''' that many users have misused this option and overwritten their library when that was not their intent.}} If you are changing the scraper to enable you to scrape one title, then this is the wrong method. You should...
* Create a new Source folder which is set to use the new scraper. This ensures that you are not at risk of overwriting your library the next time you have a title that requires a particular scraper
* If you do not want to create a new Source, then follow the above steps '''but''' navigate to the actual video and '''Set Content''' on that video folder, '''not''' the Source folder.

== Individual Refresh ==
<gallery widths=500px heights=285px>
File:Artwork-Actors01.jpg|Image 1- Select '''Refresh''' from the bottom right corner
</gallery>

Refreshing/updating an individual title can be performed from either File View or Library View.

# Navigate to the title to be updated/refreshed.
# Press {{keypress|I}} on the remote control or keyboard to call up the Information Page (see image)
# Select '''Refresh'''

This will update the library data with the new information.
{{-}}

= Remove From Library =
To remove existing titles from your library, use one of the following solutions.

== Remove Source ==
<section begin="Remove A Source" /><gallery widths=500px heights=285px>
File:Quick-start-2.png|Image 1- Enter Videos>Files
File:EstuaryContextmenu3.png|Image 2- Select '''Remove source'''
File:CleanLibrary01.jpg|Image 3- Clean Library dialogue. See Step 7
</gallery>

To remove a source, follow these steps:
#Navigate to '''Videos''' and enter '''Files''' as illustrated in Image 1
#Highlight the source to be removed
#Call up the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' (Image 2)
#Select '''Remove source''' (Image 2)
#A confirmation prompt will display- '''Are you sure? Yes / No'''
#*Select '''Yes''' to remove the source
#*Select '''No''' to cancel the procedure
#If you selected '''Yes''' you will then be asked '''Do you want to remove all items within this path from your library?'''
#*'''Yes'''- Will remove the video titles in the Source from the library. (Use this option)
#*'''No'''- Will keep the library listing of all video titles that are in that source. The source will be removed from File View, but not Library View and all titles will remain.
#**Note: If you answered '''No''' but would now like to remove the items from the library...
#**#Re-add the Source in the same manner you first added the source. '''''See: [[Adding_video_sources#Adding_Sources|Adding Video Sources]]'''''
#**#Answer '''No''' when asked '''Do you want to add the media from this source to your library'''
#**#Now repeat these instructions from Step 1 ensuring in Step 6 you select '''Yes''' to the question '''Do you want to remove all items within this path from your library?'''
#To finalise the removal process (See Image 3)
#*Navigate to '''''[[Settings/Media/Library#Video_Library|Clean Library]]''''' in the settings menu
#*Perform a Clean Library.
#*You will be advised there is an Unavailable Source (the one you just removed) and asked '''What would you like to do with media items from <the source you removed>''''
#**'''Keep'''- Movies will still remain visible in the library
#**'''Remove'''- All database entries will be removed (use this option)
<section end="Remove A Source" />

== Remove Individual Titles ==
<gallery widths=500px heights=285px>
File:MovieSets02.jpg|Image 1- Call up the Context Menu
File:MovieSets03.jpg|Image 2- Select '''Remove from library'''
</gallery>

To remove a single title...

# Navigate to the title to be removed from the library
# Call up the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' (Image 1)
# Select '''Manage'''
# Select the last option '''Remove from library''' (Image 2)
# When asked '''Would you really like to remove <title> from library?''' answer '''Yes'''

If you would also like the file deleted from your hard drive, ensure the setting '''''[[Settings/Media/General#Allow_file_renaming_and_deletion|Allow file renaming and deletion]]''''' is enabled.

Be aware that the deletion setting will only delete the video file. Any artwork, nfo files, trailers, extras, movie folder etc, will '''not''' be deleted from the hard disk.

= Exclude =
It is possible to exclude a particular video type (eg. mkv) or a folder from the Video Scraping process.

== Exclude Video Types ==
With the use of the advancedsettings.xml file, you can limit the types of video files displayed. The process can also be used to include additional file types.
{{#lst:advancedsettings.xml|videoextensions}}
{{see also|advancedsettings.xml}}

== Exclude Folder ==
{{#lst:Update_Music_Library|ExcludeFolder}}

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

[[Category:Karellen]]
[[Category:Video library]]

Adding video sources

2022-12-10T01:59:24Z

LGoosens: Structured markup for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Introduction =
This step of the guide will enable you to complete the following actions:
#'''Add Sources''' - Add the Source folder to {{Kodi}}
#'''Set Content''' - Advise {{kodi}} what type of media is in the Source
#'''Scraper Settings''' - Adjust the scraper settings to your preferences, or change to a different scraper
#'''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.}}

{{warning|[[UPnP]] cannot be used to create a library. It is recommended that you share your media using another protocol such as [[SMB]].}}

= Adding Sources =
<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-2.png|'''{{big|Step 2}}:''' Select '''FILES'''
File:Quick-start-2.1.png|'''{{big|Step 3}}:''' Select '''ADD VIDEOS...'''.<br />
File:Quick-start-3.png|'''{{big|Step 4}}:''' Select the '''BROWSE'''
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-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'''.
</gallery>

= Set Content =
<gallery mode="packed" widths="600px" heights="337px">
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.
</gallery>

{|
! style="width: 45%;" | {{resize|1.4em|Set Content for Movies}}
! style="width: 10%;" |
! style="width: 45%;" | {{resize|1.4em|Set Content for TV Shows}}
|-
| style="width: 45%; text-align:center;" | [[File:Set-content-Movies.jpg|600px]]<br>'''{{big|Step 9a}}
| style="width: 10%;" |
| style="width: 45%; text-align:center;" | [[File:Set-content-TV-Shows.jpg|600px]]<br>'''{{big|Step 9b}}
|-
| || ||
|-
| style="width: 40%;" |
;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:If your preferred scraper is not listed, use the '''Get more...''' button.

;Settings
:Adjust the scraper settings for this Source.
:Changing settings here changes the setting for this Source only.
: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.

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

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

;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:If your preferred scraper is not listed, use the '''Get more...''' button.

;Settings
:Adjust the scraper settings for this Source.
:Changing settings here changes the setting for this Source only.
: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. <ref>https://github.com/xbmc/xbmc/pull/16273</ref>
|}

{{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.}}

{{divbox|yellow|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]]'''}}

= Add to Library =
<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 selected, it can be scanned later from the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' of the Source
</gallery>
<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.

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

<references />

<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}}
{{updated|19}}

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Adding video sources

2022-12-10T01:57:15Z

LGoosens: Structured markup for clarity - if other conventions exist, please advise

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Introduction =
This step of the guide will enable you to complete the following actions:
#'''Add Sources''' - Add the Source folder to {{Kodi}}
#'''Set Content''' - Advise {{kodi}} what type of media is in the Source
#'''Scraper Settings''' - Adjust the scraper settings to your preferences, or change to a different scraper
#'''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.}}

{{warning|[[UPnP]] cannot be used to create a library. It is recommended that you share your media using another protocol such as [[SMB]].}}

= Adding Sources =
<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-2.png|'''{{big|Step 2}}:''' Select '''FILES'''
File:Quick-start-2.1.png|'''{{big|Step 3}}:''' Select '''ADD VIDEOS...'''.<br />
File:Quick-start-3.png|'''{{big|Step 4}}:''' Select the '''BROWSE'''
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-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'''.
</gallery>

= Set Content =
<gallery mode="packed" widths="600px" heights="337px">
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.
</gallery>

{|
! style="width: 45%;" | {{resize|1.4em|Set Content for Movies}}
! style="width: 10%;" |
! style="width: 45%;" | {{resize|1.4em|Set Content for TV Shows}}
|-
| style="width: 45%; text-align:center;" | [[File:Set-content-Movies.jpg|600px]]<br>'''{{big|Step 9a}}
| style="width: 10%;" |
| style="width: 45%; text-align:center;" | [[File:Set-content-TV-Shows.jpg|600px]]<br>'''{{big|Step 9b}}
|-
| || ||
|-
| style="width: 40%;" |
;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:If your preferred scraper is not listed, use the '''Get more...''' button.

;Settings
:Adjust the scraper settings for this Source.
:Changing settings here changes the setting for this Source only.
: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.

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

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

;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:If your preferred scraper is not listed, use the '''Get more...''' button.

;Settings
:Adjust the scraper settings for this Source.
:Changing settings here changes the setting for this Source only.
: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. <ref>https://github.com/xbmc/xbmc/pull/16273</ref>
|}

{{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.}}

{{divbox|yellow|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]]'''}}

= Add to Library =
<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 selected, it can be scanned later from the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' of the Source
</gallery>
<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.

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

<references />

<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}}
{{updated|19}}

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Adding video sources

2022-12-10T01:50:12Z

LGoosens: Structured markup for clarity - if other conventions exist, please advise

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Introduction =
This step of the guide will enable you to complete the following actions:
#'''Add Sources''' - Add the Source folder to {{Kodi}}
#'''Set Content''' - Advise {{kodi}} what type of media is in the Source
#'''Scraper Settings''' - Adjust the scraper settings to your preferences, or change to a different scraper
#'''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.}}

{{warning|[[UPnP]] cannot be used to create a library. It is recommended that you share your media using another protocol such as [[SMB]].}}

= Adding Sources =
<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-2.png|'''{{big|Step 2}}:''' Select '''FILES'''
File:Quick-start-2.1.png|'''{{big|Step 3}}:''' Select '''ADD VIDEOS...'''.<br />
File:Quick-start-3.png|'''{{big|Step 4}}:''' Select the '''BROWSE'''
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-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'''.
</gallery>

= Set Content =
<gallery mode="packed" widths="600px" heights="337px">
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.
</gallery>

{|
! style="width: 45%;" | {{resize|1.4em|Set Content for Movies}}
! style="width: 10%;" |
! style="width: 45%;" | {{resize|1.4em|Set Content for TV Shows}}
|-
| style="width: 45%; text-align:center;" | [[File:Set-content-Movies.jpg|600px]]<br>'''{{big|Step 9a}}
| style="width: 10%;" |
| style="width: 45%; text-align:center;" | [[File:Set-content-TV-Shows.jpg|600px]]<br>'''{{big|Step 9b}}
|-
| || ||
|-
| style="width: 40%;" |
;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:If your preferred scraper is not listed, use the '''Get more...''' button.

;Settings
:Adjust the scraper settings for this Source.
:Changing settings here changes the setting for this Source only.
: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.

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

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

;Choose information provider
:Select this setting to change the scraper that this Source uses<br>
:If your preferred scraper is not listed, use the '''Get more...''' button.

;Settings
:Adjust the scraper settings for this Source.
:Changing settings here changes the setting for this Source only.
: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. <ref>https://github.com/xbmc/xbmc/pull/16273</ref>
|}

{{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.}}

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

= Add to Library =
<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 selected, it can be scanned later from the '''''[[Basic_controls#Context_Menu|Context Menu]]''''' of the Source
</gallery>
<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.

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

<references />

<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}}
{{updated|19}}

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Naming video files/Episodes

2022-12-10T01:47:58Z

LGoosens: Structured markup for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

__TOC__

= Introduction =
Be aware of the following:

* The '''only item in the episode file name''' that the {{kodi}} scanner searches for is the '''Season and Episode numbering''' (''SxxEyy''). Everything else is irrelevant.
* It is this SxxEyy that is used to match and scrape the episode metadata and artwork.
* To reduce the risk of the scanner becoming confused by complicated naming, ensure your episode filenames are clean and simple as described below.
* Contrary to advice from 3rd party internet guides, you cannot set season and episode numbering through NFO Files.

{{divbox|yellow|Do not refer to IMDB for episode orders. There is no IMDB Scraper.|
If you are using the default scraper then the site to check is [https://www.themoviedb.org/ TMDB]. If you have changed to [https://www.thetvdb.com/ TVDB] or [https://www.tvmaze.com/ TV Maze], check the appropriate site.}}

= Single Episode Files =
{{note|Episode files are assumed to contain a single episode. If you have files that contain two or more episodes, then read the Multi-Episodes section below.}}

The following table details the ''Minimum'' and ''Recommended'' naming for episodes files.

{| class="prettytable"
|-
| scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Minimum required episode name:''' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Recommended episode name:'''
|-
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"|''S01E01.mkv''
! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"|
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"| ''Angel (1999) S01E01.mkv''
|-
|Where:
|'''''S01E01''''' = Season 1, Episode 1 - no spaces || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| ||Where: ||'''''S01E01''''' = Season 1, Episode 1 - no spaces
|-
|
| || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || || '''''Angel (1999)''''' = TV Show name
|}

The Pattern '''S01E01''' is the most accurate available. Other Patterns are available in the table below with the most accurate at the top and accuracy decreasing down the list.

{|
|-
|
{|class="{{{1|prettytable}}}" style="margin: 0.5em 2.0em 0.5em 0em; font-size: 0.80em; {{border-radius|5px}}; float: top; clear: top;" width="500"
|-
! colspan="2" style="background-color:#;" | With Season
! colspan="2" style="background-color:#;" | No Season
! colspan="2" style="background-color:#;" | By Date
! colspan="2" style="background-color:#;" | By Title
|+
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01E02'''.ext
|style="width:50px; text-align:center;"|2
|style="width:50px; text-align:left;"|''Name'' '''ep02'''.ext
|style="width:50px; text-align:center;"|3
|style="width:50px; text-align:left;"|''Name'' '''yyyy.mm.dd'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|'''Name'''.''special''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S1E2'''.ext
|style="width:50px; text-align:center;"|2
|style="width:50px; text-align:left;"|''Name'' '''ep_02'''.ext
|style="width:50px; text-align:center;"|3
|style="width:50px; text-align:left;"|''Name'' '''yyyy-mm-dd'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01.E02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''part.II'''.ext
|style="width:50px; text-align:center;"|4
|style="width:50px; text-align:left;"|''Name'' '''dd.mm.yyyy'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01_E02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''pt.II'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01xE02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''pt_II'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|5
|style="width:50px; text-align:left;"|''Name'' '''1x02'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|6
|style="width:50px; text-align:left;"|''Name'' '''102'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|}
|
;With Season
:The most commonly used for nearly all TV Shows.
;No Season
:Normally used for Anime or single season TV Shows. Not commonly used.
;By date
:Used for long-running daily shows. Check the scraper site for numbering method used.
;By title (added in v.20 "Nexus")
:Used for special episodes in case if a data provider does not support "zero season" convention for specials, e.g. TVmaze. It allows to match special episodes by their titles.
|}

= Multi-Episode Files =
If you video files contain two or more episodes, then the following naming is required to scan multiple episodes from a single file.

{| class="prettytable"
|-
| scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Minimum required episode name:''' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Recommended episode name:'''
|-
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"|''S01E01E02E04.mkv''
! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"|
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"| ''Angel (1999) S01E01E02E04.mkv''
|-
|Where:
|'''''S01E01E02E04''''' = Season 1, Episode 1, 2 & 4 || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| ||Where: ||'''''S01E01E02E04''''' = Season 1, Episode 1, 2 & 4
|-
|
| ''Note that Episode 3 is not included'' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || || '''''Angel (1999)''''' = TV Show name
|}

{|
|-
|
{|class="{{{1|prettytable}}}" style="margin: 0.5em 2.0em 0.5em 0em; font-size: 0.80em; {{border-radius|5px}}; float: top; clear: top;" width="500"
|-
! colspan="2" style="background-color:#;" | Complex Pattern
! colspan="2" style="background-color:#;" | Short Pattern
|+
! style="background-color:#;" | Order
! style="background-color:#; width:350px" | Example Name
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Example Name
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-'''s01e02'''.ext
|style="width:50px; text-align:center;"|1
|style="width:150px; text-align:left;"|''name'' '''s01e01e02'''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-''episode1.title''-'''s01e02'''-''episode2.title''.ext
|style="width:50px; text-align:center;"|1
|style="width:150px; text-align:left;"|''name'' '''s01e01-02-03'''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-'''s01e02'''-'''s01e03'''.ext
|style="width:50px; text-align:center;"|5
|style="width:150px; text-align:left;"|''name'' '''1x01x02'''.ext
|-
|style="width:50px; text-align:center;"|5
|style="width:300px; text-align:left;"|''name'' '''1x01'''-'''1x02'''.ext
|style="width:50px; text-align:center;"|2
|style="width:150px; text-align:left;"|''name'' '''ep01-02'''.ext
|-
|style="width:50px; text-align:center;"|2
|style="width:300px; text-align:left;"|''name'' '''ep01'''-'''ep02'''.ext
|style="width:50px; text-align:center;"|
|style="width:150px; text-align:left;"|
|}
|
{{note|It is recommended that multi-episode files be split into Single Episode files.}}

In cases where the video file contains more than one episode, you must nominate each episode in the filename.

* The patterns are the same as Single Episode numbering, but extended to include multiple episodes.
* Only the episodes in the file name will be added, e.g. '''''Angel (1999) S01E01E04.mkv''''' will scrape episodes 1 and 4 but not include episodes 2 and 3.
* When using a single video file for multiple episodes it is possible to tell set episode bookmarks for each episode in the file. See: '''''[[bookmarks|Episode Bookmarks]]'''''

:'''''See also: [[Advancedsettings.xml#tvmultipartmatching|Multi-Episode Matching]]''''' to create additional pattern matches
|}

= Specials =
* Specials are extras or episodes that don't belong to a season.
* Movies based on TV shows are usually ''not'' added as specials. Instead you [[Linking_movies_to_TV_shows|link a movie]] to a TV show. It will then appear at the bottom of the season list.
* Specials are named as season 00 and start at E01, e.g. S'''00'''E01. Which episode number they'll have depends on the website the scraper use. At TMDB you access the specials by going to "View All Seasons">Specials.
In Kodi specials will appear under ''Specials'' in the season list.

= Episode Groups =
* Episode Groups or Orders are listings with alternate episode orders.
* Some TV Shows are broadcast in one order but the DVD/Bluray release may have a different screening order. A well known example is the TV Show ''Firefly'' where the Studio opted to broadcast high action episodes for ratings first, while the Producer wanted a different order to correctly unfold the storyline.
Each Information Provider uses a different method to make alternate orders available. Check which scraper you are using and select the correct method below.

== TheMovieDB-TV Shows ==
See... '''[[Add-on:TMDb_TV_Shows#Episode_Orders|TheMovieDB Episode Groups]]'''

Only available when using the python scraper ''TMDB TV Shows.''

== The TVDB ==
See... '''[[Add-on:The_TVDB_v4#Flexible_Orders|TheTVDB Flexible Orders]]

Only available when using TheTVDB v4 python scraper by TVDB Team.

== TVmaze ==
See... '''[[Add-on:TVmaze#Episode_Orders|TVmaze Episode Orders]]'''

= References =
<references />

<center>
{| style="border: 1px solid black;"
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Mergefrom.gif|60px|link=Naming_video_files/Seasons]]
| style="width:200px; text-align:center;" | '''Previous step'''
| style="width:200px; text-align:center;" | '''Next step'''
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Merge-arrow.gif|60px|link=Adding_video_sources]]
|-
| style="width:200px; text-align:center;" | '''[[Naming_video_files/Seasons|Seasons Setup]]'''
| style="width:200px; text-align:center;" | '''[[Adding_video_sources|Add Source & Scrape]]'''
|}</center>

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

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Naming video files/Episodes

2022-12-10T01:47:16Z

LGoosens: Structured markup for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

__TOC__

= Introduction =
Be aware of the following:

* The '''only item in the episode file name''' that the {{kodi}} scanner searches for is the '''Season and Episode numbering''' (''SxxEyy''). Everything else is irrelevant.
* It is this SxxEyy that is used to match and scrape the episode metadata and artwork.
* To reduce the risk of the scanner becoming confused by complicated naming, ensure your episode filenames are clean and simple as described below.
* Contrary to advice from 3rd party internet guides, you cannot set season and episode numbering through NFO Files.

{{divbox|yellow|Do not refer to IMDB for episode orders. There is no IMDB Scraper.|
If you are using the default scraper then the site to check is [https://www.themoviedb.org/ TMDB]. If you have changed to [https://www.thetvdb.com/ TVDB] or [https://www.tvmaze.com/ TV Maze], check the appropriate site.}}

= Single Episode Files =
{{note|Episode files are assumed to contain a single episode. If you have files that contain two or more episodes, then read the Multi-Episodes section below.}}

The following table details the ''Minimum'' and ''Recommended'' naming for episodes files.

{| class="prettytable"
|-
| scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Minimum required episode name:''' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Recommended episode name:'''
|-
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"|''S01E01.mkv''
! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"|
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"| ''Angel (1999) S01E01.mkv''
|-
|Where:
|'''''S01E01''''' = Season 1, Episode 1 - no spaces || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| ||Where: ||'''''S01E01''''' = Season 1, Episode 1 - no spaces
|-
|
| || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || || '''''Angel (1999)''''' = TV Show name
|}

The Pattern '''S01E01''' is the most accurate available. Other Patterns are available in the table below with the most accurate at the top and accuracy decreasing down the list.

{|
|-
|
{|class="{{{1|prettytable}}}" style="margin: 0.5em 2.0em 0.5em 0em; font-size: 0.80em; {{border-radius|5px}}; float: top; clear: top;" width="500"
|-
! colspan="2" style="background-color:#;" | With Season
! colspan="2" style="background-color:#;" | No Season
! colspan="2" style="background-color:#;" | By Date
! colspan="2" style="background-color:#;" | By Title
|+
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01E02'''.ext
|style="width:50px; text-align:center;"|2
|style="width:50px; text-align:left;"|''Name'' '''ep02'''.ext
|style="width:50px; text-align:center;"|3
|style="width:50px; text-align:left;"|''Name'' '''yyyy.mm.dd'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|'''Name'''.''special''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S1E2'''.ext
|style="width:50px; text-align:center;"|2
|style="width:50px; text-align:left;"|''Name'' '''ep_02'''.ext
|style="width:50px; text-align:center;"|3
|style="width:50px; text-align:left;"|''Name'' '''yyyy-mm-dd'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01.E02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''part.II'''.ext
|style="width:50px; text-align:center;"|4
|style="width:50px; text-align:left;"|''Name'' '''dd.mm.yyyy'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01_E02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''pt.II'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01xE02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''pt_II'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|5
|style="width:50px; text-align:left;"|''Name'' '''1x02'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|6
|style="width:50px; text-align:left;"|''Name'' '''102'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|}
|
;With Season
:The most commonly used for nearly all TV Shows.
;No Season
:Normally used for Anime or single season TV Shows. Not commonly used.
;By date
:Used for long-running daily shows. Check the scraper site for numbering method used.
;By title (added in v.20 "Nexus")
:Used for special episodes in case if a data provider does not support "zero season" convention for specials, e.g. TVmaze. It allows to match special episodes by their titles.
|}

= Multi-Episode Files =
If you video files contain two or more episodes, then the following naming is required to scan multiple episodes from a single file.

{| class="prettytable"
|-
| scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Minimum required episode name:''' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Recommended episode name:'''
|-
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"|''S01E01E02E04.mkv''
! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"|
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"| ''Angel (1999) S01E01E02E04.mkv''
|-
|Where:
|'''''S01E01E02E04''''' = Season 1, Episode 1, 2 & 4 || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| ||Where: ||'''''S01E01E02E04''''' = Season 1, Episode 1, 2 & 4
|-
|
| ''Note that Episode 3 is not included'' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || || '''''Angel (1999)''''' = TV Show name
|}

{|
|-
|
{|class="{{{1|prettytable}}}" style="margin: 0.5em 2.0em 0.5em 0em; font-size: 0.80em; {{border-radius|5px}}; float: top; clear: top;" width="500"
|-
! colspan="2" style="background-color:#;" | Complex Pattern
! colspan="2" style="background-color:#;" | Short Pattern
|+
! style="background-color:#;" | Order
! style="background-color:#; width:350px" | Example Name
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Example Name
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-'''s01e02'''.ext
|style="width:50px; text-align:center;"|1
|style="width:150px; text-align:left;"|''name'' '''s01e01e02'''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-''episode1.title''-'''s01e02'''-''episode2.title''.ext
|style="width:50px; text-align:center;"|1
|style="width:150px; text-align:left;"|''name'' '''s01e01-02-03'''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-'''s01e02'''-'''s01e03'''.ext
|style="width:50px; text-align:center;"|5
|style="width:150px; text-align:left;"|''name'' '''1x01x02'''.ext
|-
|style="width:50px; text-align:center;"|5
|style="width:300px; text-align:left;"|''name'' '''1x01'''-'''1x02'''.ext
|style="width:50px; text-align:center;"|2
|style="width:150px; text-align:left;"|''name'' '''ep01-02'''.ext
|-
|style="width:50px; text-align:center;"|2
|style="width:300px; text-align:left;"|''name'' '''ep01'''-'''ep02'''.ext
|style="width:50px; text-align:center;"|
|style="width:150px; text-align:left;"|
|}
|
{{note|It is recommended that multi-episode files be split into Single Episode files.}}

In cases where the video file contains more than one episode, you must nominate each episode in the filename.

* The patterns are the same as Single Episode numbering, but extended to include multiple episodes.
* Only the episodes in the file name will be added, e.g. '''''Angel (1999) S01E01E04.mkv''''' will scrape episodes 1 and 4 but not include episodes 2 and 3.
* When using a single video file for multiple episodes it is possible to tell set episode bookmarks for each episode in the file. See: '''''[[bookmarks|Episode Bookmarks]]'''''

:'''''See also: [[Advancedsettings.xml#tvmultipartmatching|Multi-Episode Matching]]''''' to create additional pattern matches
|}

= Specials =
* Specials are extras or episodes that don't belong to a season.
* Movies based on TV shows are usually ''not'' added as specials. Instead you [[Linking_movies_to_TV_shows|link a movie]] to a TV show. It will then appear at the bottom of the season list.
* Specials are named as season 00 and start at E01, e.g. S'''00'''E01. Which episode number they'll have depends on the website the scraper use. At TMDB you access the specials by going to "View All Seasons">Specials.
* In Kodi specials will appear under ''Specials'' in the season list.

= Episode Groups =
* Episode Groups or Orders are listings with alternate episode orders.
* Some TV Shows are broadcast in one order but the DVD/Bluray release may have a different screening order. A well known example is the TV Show ''Firefly'' where the Studio opted to broadcast high action episodes for ratings first, while the Producer wanted a different order to correctly unfold the storyline.
Each Information Provider uses a different method to make alternate orders available. Check which scraper you are using and select the correct method below.

== TheMovieDB-TV Shows ==
See... '''[[Add-on:TMDb_TV_Shows#Episode_Orders|TheMovieDB Episode Groups]]'''

Only available when using the python scraper ''TMDB TV Shows.''

== The TVDB ==
See... '''[[Add-on:The_TVDB_v4#Flexible_Orders|TheTVDB Flexible Orders]]

Only available when using TheTVDB v4 python scraper by TVDB Team.

== TVmaze ==
See... '''[[Add-on:TVmaze#Episode_Orders|TVmaze Episode Orders]]'''

= References =
<references />

<center>
{| style="border: 1px solid black;"
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Mergefrom.gif|60px|link=Naming_video_files/Seasons]]
| style="width:200px; text-align:center;" | '''Previous step'''
| style="width:200px; text-align:center;" | '''Next step'''
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Merge-arrow.gif|60px|link=Adding_video_sources]]
|-
| style="width:200px; text-align:center;" | '''[[Naming_video_files/Seasons|Seasons Setup]]'''
| style="width:200px; text-align:center;" | '''[[Adding_video_sources|Add Source & Scrape]]'''
|}</center>

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

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Naming video files/Episodes

2022-12-10T01:45:07Z

LGoosens: Structured markup for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

__TOC__

= Introduction =
Be aware of the following:

* The '''only item in the episode file name''' that the {{kodi}} scanner searches for is the '''Season and Episode numbering''' (''SxxEyy''). Everything else is irrelevant.
* It is this SxxEyy that is used to match and scrape the episode metadata and artwork.
* To reduce the risk of the scanner becoming confused by complicated naming, ensure your episode filenames are clean and simple as described below.
* Contrary to advice from 3rd party internet guides, you cannot set season and episode numbering through NFO Files.

{{divbox|yellow|Do not refer to IMDB for episode orders. There is no IMDB Scraper.|
If you are using the default scraper then the site to check is [https://www.themoviedb.org/ TMDB]. If you have changed to [https://www.thetvdb.com/ TVDB] or [https://www.tvmaze.com/ TV Maze], check the appropriate site.}}

= Single Episode Files =
{{note|Episode files are assumed to contain a single episode. If you have files that contain two or more episodes, then read the Multi-Episodes section below.}}

The following table details the ''Minimum'' and ''Recommended'' naming for episodes files.

{| class="prettytable"
|-
| scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Minimum required episode name:''' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Recommended episode name:'''
|-
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"|''S01E01.mkv''
! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"|
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"| ''Angel (1999) S01E01.mkv''
|-
|Where:
|'''''S01E01''''' = Season 1, Episode 1 - no spaces || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| ||Where: ||'''''S01E01''''' = Season 1, Episode 1 - no spaces
|-
|
| || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || || '''''Angel (1999)''''' = TV Show name
|}

The Pattern '''S01E01''' is the most accurate available. Other Patterns are available in the table below with the most accurate at the top and accuracy decreasing down the list.

{|
|-
|
{|class="{{{1|prettytable}}}" style="margin: 0.5em 2.0em 0.5em 0em; font-size: 0.80em; {{border-radius|5px}}; float: top; clear: top;" width="500"
|-
! colspan="2" style="background-color:#;" | With Season
! colspan="2" style="background-color:#;" | No Season
! colspan="2" style="background-color:#;" | By Date
! colspan="2" style="background-color:#;" | By Title
|+
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01E02'''.ext
|style="width:50px; text-align:center;"|2
|style="width:50px; text-align:left;"|''Name'' '''ep02'''.ext
|style="width:50px; text-align:center;"|3
|style="width:50px; text-align:left;"|''Name'' '''yyyy.mm.dd'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|'''Name'''.''special''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S1E2'''.ext
|style="width:50px; text-align:center;"|2
|style="width:50px; text-align:left;"|''Name'' '''ep_02'''.ext
|style="width:50px; text-align:center;"|3
|style="width:50px; text-align:left;"|''Name'' '''yyyy-mm-dd'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01.E02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''part.II'''.ext
|style="width:50px; text-align:center;"|4
|style="width:50px; text-align:left;"|''Name'' '''dd.mm.yyyy'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01_E02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''pt.II'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01xE02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''pt_II'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|5
|style="width:50px; text-align:left;"|''Name'' '''1x02'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|6
|style="width:50px; text-align:left;"|''Name'' '''102'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|}
|
;With Season
:The most commonly used for nearly all TV Shows.
;No Season
:Normally used for Anime or single season TV Shows. Not commonly used.
;By date
:Used for long-running daily shows. Check the scraper site for numbering method used.
;By title (added in v.20 "Nexus")
:Used for special episodes in case if a data provider does not support "zero season" convention for specials, e.g. TVmaze. It allows to match special episodes by their titles.
|}

= Multi-Episode Files =
If you video files contain two or more episodes, then the following naming is required to scan multiple episodes from a single file.

{| class="prettytable"
|-
| scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Minimum required episode name:''' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Recommended episode name:'''
|-
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"|''S01E01E02E04.mkv''
! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"|
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"| ''Angel (1999) S01E01E02E04.mkv''
|-
|Where:
|'''''S01E01E02E04''''' = Season 1, Episode 1, 2 & 4 || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| ||Where: ||'''''S01E01E02E04''''' = Season 1, Episode 1, 2 & 4
|-
|
| ''Note that Episode 3 is not included'' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || || '''''Angel (1999)''''' = TV Show name
|}

{|
|-
|
{|class="{{{1|prettytable}}}" style="margin: 0.5em 2.0em 0.5em 0em; font-size: 0.80em; {{border-radius|5px}}; float: top; clear: top;" width="500"
|-
! colspan="2" style="background-color:#;" | Complex Pattern
! colspan="2" style="background-color:#;" | Short Pattern
|+
! style="background-color:#;" | Order
! style="background-color:#; width:350px" | Example Name
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Example Name
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-'''s01e02'''.ext
|style="width:50px; text-align:center;"|1
|style="width:150px; text-align:left;"|''name'' '''s01e01e02'''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-''episode1.title''-'''s01e02'''-''episode2.title''.ext
|style="width:50px; text-align:center;"|1
|style="width:150px; text-align:left;"|''name'' '''s01e01-02-03'''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-'''s01e02'''-'''s01e03'''.ext
|style="width:50px; text-align:center;"|5
|style="width:150px; text-align:left;"|''name'' '''1x01x02'''.ext
|-
|style="width:50px; text-align:center;"|5
|style="width:300px; text-align:left;"|''name'' '''1x01'''-'''1x02'''.ext
|style="width:50px; text-align:center;"|2
|style="width:150px; text-align:left;"|''name'' '''ep01-02'''.ext
|-
|style="width:50px; text-align:center;"|2
|style="width:300px; text-align:left;"|''name'' '''ep01'''-'''ep02'''.ext
|style="width:50px; text-align:center;"|
|style="width:150px; text-align:left;"|
|}
|
{{note|It is recommended that multi-episode files be split into Single Episode files.}}

In cases where the video file contains more than one episode, you must nominate each episode in the filename.

* The patterns are the same as Single Episode numbering, but extended to include multiple episodes.
* Only the episodes in the file name will be added, e.g. '''''Angel (1999) S01E01E04.mkv''''' will scrape episodes 1 and 4 but not include episodes 2 and 3.
* When using a single video file for multiple episodes it is possible to tell set episode bookmarks for each episode in the file. See: '''''[[bookmarks|Episode Bookmarks]]'''''

:'''''See also: [[Advancedsettings.xml#tvmultipartmatching|Multi-Episode Matching]]''''' to create additional pattern matches
|}

= Specials =
* Specials are extras or episodes that don't belong to a season.
* Movies based on TV shows are usually ''not'' added as specials. Instead you [[Linking_movies_to_TV_shows|link a movie]] to a TV show. It will then appear at the bottom of the season list.
* Specials are named as season 00 and start at E01, e.g. S'''00'''E01. Which episode number they'll have depends on the website the scraper use. At TMDB you access the specials by going to "View All Seasons">Specials.
* In Kodi specials will appear under ''Specials'' in the season list.

= Episode Groups =
Episode Groups or Orders are listings with alternate episode orders. Some TV Shows are broadcast in one order but the DVD/Bluray release may have a different screening order. A well known example is the TV Show ''Firefly'' where the Studio opted to broadcast high action episodes for ratings first, while the Producer wanted a different order to correctly unfold the storyline.

Each Information Provider uses a different method to make alternate orders available. Check which scraper you are using and select the correct method below.

== TheMovieDB-TV Shows ==
See... '''[[Add-on:TMDb_TV_Shows#Episode_Orders|TheMovieDB Episode Groups]]'''

Only available when using the python scraper ''TMDB TV Shows.''

== The TVDB ==
See... '''[[Add-on:The_TVDB_v4#Flexible_Orders|TheTVDB Flexible Orders]]

Only available when using TheTVDB v4 python scraper by TVDB Team.

== TVmaze ==
See... '''[[Add-on:TVmaze#Episode_Orders|TVmaze Episode Orders]]'''

= References =
<references />

<center>
{| style="border: 1px solid black;"
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Mergefrom.gif|60px|link=Naming_video_files/Seasons]]
| style="width:200px; text-align:center;" | '''Previous step'''
| style="width:200px; text-align:center;" | '''Next step'''
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Merge-arrow.gif|60px|link=Adding_video_sources]]
|-
| style="width:200px; text-align:center;" | '''[[Naming_video_files/Seasons|Seasons Setup]]'''
| style="width:200px; text-align:center;" | '''[[Adding_video_sources|Add Source & Scrape]]'''
|}</center>

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

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Naming video files/Episodes

2022-12-10T01:43:48Z

LGoosens: Structured markup for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

__TOC__

= Introduction =
Be aware of the following:

* The '''only item in the episode file name''' that the {{kodi}} scanner searches for is the '''Season and Episode numbering''' (''SxxEyy''). Everything else is irrelevant.
* It is this SxxEyy that is used to match and scrape the episode metadata and artwork.
* To reduce the risk of the scanner becoming confused by complicated naming, ensure your episode filenames are clean and simple as described below.
* Contrary to advice from 3rd party internet guides, you cannot set season and episode numbering through NFO Files.

{{divbox|yellow|Do not refer to IMDB for episode orders. There is no IMDB Scraper.|
If you are using the default scraper then the site to check is [https://www.themoviedb.org/ TMDB]. If you have changed to [https://www.thetvdb.com/ TVDB] or [https://www.tvmaze.com/ TV Maze], check the appropriate site.}}

= Single Episode Files =
{{note|Episode files are assumed to contain a single episode. If you have files that contain two or more episodes, then read the Multi-Episodes section below.}}

The following table details the ''Minimum'' and ''Recommended'' naming for episodes files.

{| class="prettytable"
|-
| scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Minimum required episode name:''' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Recommended episode name:'''
|-
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"|''S01E01.mkv''
! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"|
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"| ''Angel (1999) S01E01.mkv''
|-
|Where:
|'''''S01E01''''' = Season 1, Episode 1 - no spaces || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| ||Where: ||'''''S01E01''''' = Season 1, Episode 1 - no spaces
|-
|
| || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || || '''''Angel (1999)''''' = TV Show name
|}

The Pattern '''S01E01''' is the most accurate available. Other Patterns are available in the table below with the most accurate at the top and accuracy decreasing down the list.

{|
|-
|
{|class="{{{1|prettytable}}}" style="margin: 0.5em 2.0em 0.5em 0em; font-size: 0.80em; {{border-radius|5px}}; float: top; clear: top;" width="500"
|-
! colspan="2" style="background-color:#;" | With Season
! colspan="2" style="background-color:#;" | No Season
! colspan="2" style="background-color:#;" | By Date
! colspan="2" style="background-color:#;" | By Title
|+
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01E02'''.ext
|style="width:50px; text-align:center;"|2
|style="width:50px; text-align:left;"|''Name'' '''ep02'''.ext
|style="width:50px; text-align:center;"|3
|style="width:50px; text-align:left;"|''Name'' '''yyyy.mm.dd'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|'''Name'''.''special''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S1E2'''.ext
|style="width:50px; text-align:center;"|2
|style="width:50px; text-align:left;"|''Name'' '''ep_02'''.ext
|style="width:50px; text-align:center;"|3
|style="width:50px; text-align:left;"|''Name'' '''yyyy-mm-dd'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01.E02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''part.II'''.ext
|style="width:50px; text-align:center;"|4
|style="width:50px; text-align:left;"|''Name'' '''dd.mm.yyyy'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01_E02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''pt.II'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01xE02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''pt_II'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|5
|style="width:50px; text-align:left;"|''Name'' '''1x02'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|6
|style="width:50px; text-align:left;"|''Name'' '''102'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|}
|
;With Season
:The most commonly used for nearly all TV Shows.
;No Season
:Normally used for Anime or single season TV Shows. Not commonly used.
;By date
:Used for long-running daily shows. Check the scraper site for numbering method used.
;By title (added in v.20 "Nexus")
:Used for special episodes in case if a data provider does not support "zero season" convention for specials, e.g. TVmaze. It allows to match special episodes by their titles.
|}

= Multi-Episode Files =
If you video files contain two or more episodes, then the following naming is required to scan multiple episodes from a single file.

{| class="prettytable"
|-
| scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Minimum required episode name:''' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Recommended episode name:'''
|-
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"|''S01E01E02E04.mkv''
! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"|
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"| ''Angel (1999) S01E01E02E04.mkv''
|-
|Where:
|'''''S01E01E02E04''''' = Season 1, Episode 1, 2 & 4 || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| ||Where: ||'''''S01E01E02E04''''' = Season 1, Episode 1, 2 & 4
|-
|
| ''Note that Episode 3 is not included'' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || || '''''Angel (1999)''''' = TV Show name
|}

{|
|-
|
{|class="{{{1|prettytable}}}" style="margin: 0.5em 2.0em 0.5em 0em; font-size: 0.80em; {{border-radius|5px}}; float: top; clear: top;" width="500"
|-
! colspan="2" style="background-color:#;" | Complex Pattern
! colspan="2" style="background-color:#;" | Short Pattern
|+
! style="background-color:#;" | Order
! style="background-color:#; width:350px" | Example Name
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Example Name
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-'''s01e02'''.ext
|style="width:50px; text-align:center;"|1
|style="width:150px; text-align:left;"|''name'' '''s01e01e02'''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-''episode1.title''-'''s01e02'''-''episode2.title''.ext
|style="width:50px; text-align:center;"|1
|style="width:150px; text-align:left;"|''name'' '''s01e01-02-03'''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-'''s01e02'''-'''s01e03'''.ext
|style="width:50px; text-align:center;"|5
|style="width:150px; text-align:left;"|''name'' '''1x01x02'''.ext
|-
|style="width:50px; text-align:center;"|5
|style="width:300px; text-align:left;"|''name'' '''1x01'''-'''1x02'''.ext
|style="width:50px; text-align:center;"|2
|style="width:150px; text-align:left;"|''name'' '''ep01-02'''.ext
|-
|style="width:50px; text-align:center;"|2
|style="width:300px; text-align:left;"|''name'' '''ep01'''-'''ep02'''.ext
|style="width:50px; text-align:center;"|
|style="width:150px; text-align:left;"|
|}
|
{{note|It is recommended that multi-episode files be split into Single Episode files.}}

In cases where the video file contains more than one episode, you must nominate each episode in the filename.

* The patterns are the same as Single Episode numbering, but extended to include multiple episodes.
* Only the episodes in the file name will be added, e.g. '''''Angel (1999) S01E01E04.mkv''''' will scrape episodes 1 and 4 but not include episodes 2 and 3.
* When using a single video file for multiple episodes it is possible to tell set episode bookmarks for each episode in the file. See: '''''[[bookmarks|Episode Bookmarks]]'''''

:'''''See also: [[Advancedsettings.xml#tvmultipartmatching|Multi-Episode Matching]]''''' to create additional pattern matches
|}

= Specials =
Specials are extras or episodes that don't belong to a season.

Movies based on TV shows are usually ''not'' added as specials. Instead you [[Linking_movies_to_TV_shows|link a movie]] to a TV show. It will then appear at the bottom of the season list.

Specials are named as season 00 and start at E01, e.g. S'''00'''E01. Which episode number they'll have depends on the website the scraper use. At TMDB you access the specials by going to "View All Seasons">Specials.

In Kodi specials will appear under ''Specials'' in the season list.

= Episode Groups =
Episode Groups or Orders are listings with alternate episode orders. Some TV Shows are broadcast in one order but the DVD/Bluray release may have a different screening order. A well known example is the TV Show ''Firefly'' where the Studio opted to broadcast high action episodes for ratings first, while the Producer wanted a different order to correctly unfold the storyline.

Each Information Provider uses a different method to make alternate orders available. Check which scraper you are using and select the correct method below.

== TheMovieDB-TV Shows ==
See... '''[[Add-on:TMDb_TV_Shows#Episode_Orders|TheMovieDB Episode Groups]]'''

Only available when using the python scraper ''TMDB TV Shows.''

== The TVDB ==
See... '''[[Add-on:The_TVDB_v4#Flexible_Orders|TheTVDB Flexible Orders]]

Only available when using TheTVDB v4 python scraper by TVDB Team.

== TVmaze ==
See... '''[[Add-on:TVmaze#Episode_Orders|TVmaze Episode Orders]]'''

= References =
<references />

<center>
{| style="border: 1px solid black;"
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Mergefrom.gif|60px|link=Naming_video_files/Seasons]]
| style="width:200px; text-align:center;" | '''Previous step'''
| style="width:200px; text-align:center;" | '''Next step'''
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Merge-arrow.gif|60px|link=Adding_video_sources]]
|-
| style="width:200px; text-align:center;" | '''[[Naming_video_files/Seasons|Seasons Setup]]'''
| style="width:200px; text-align:center;" | '''[[Adding_video_sources|Add Source & Scrape]]'''
|}</center>

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

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Naming video files/Episodes

2022-12-10T01:39:23Z

LGoosens: Structured markup for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

__TOC__

= Introduction =
Be aware of the following:

* The '''only item in the episode file name''' that the {{kodi}} scanner searches for is the '''Season and Episode numbering''' (''SxxEyy''). Everything else is irrelevant.
* It is this SxxEyy that is used to match and scrape the episode metadata and artwork.
* To reduce the risk of the scanner becoming confused by complicated naming, ensure your episode filenames are clean and simple as described below.
* Contrary to advice from 3rd party internet guides, you cannot set season and episode numbering through NFO Files.

{{divbox|yellow|Do not refer to IMDB for episode orders. There is no IMDB Scraper.|
If you are using the default scraper then the site to check is [https://www.themoviedb.org/ TMDB]. If you have changed to [https://www.thetvdb.com/ TVDB] or [https://www.tvmaze.com/ TV Maze], check the appropriate site.}}

= Single Episode Files =
{{note|Episode files are assumed to contain a single episode. If you have files that contain two or more episodes, then read the Multi-Episodes section below.}}

The following table details the ''Minimum'' and ''Recommended'' naming for episodes files.

{| class="prettytable"
|-
| scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Minimum required episode name:''' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Recommended episode name:'''
|-
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"|''S01E01.mkv''
! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"|
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"| ''Angel (1999) S01E01.mkv''
|-
|Where:
|'''''S01E01''''' = Season 1, Episode 1 - no spaces || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| ||Where: ||'''''S01E01''''' = Season 1, Episode 1 - no spaces
|-
|
| || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || || '''''Angel (1999)''''' = TV Show name
|}

The Pattern '''S01E01''' is the most accurate available. Other Patterns are available in the table below with the most accurate at the top and accuracy decreasing down the list.

{|
|-
|
{|class="{{{1|prettytable}}}" style="margin: 0.5em 2.0em 0.5em 0em; font-size: 0.80em; {{border-radius|5px}}; float: top; clear: top;" width="500"
|-
! colspan="2" style="background-color:#;" | With Season
! colspan="2" style="background-color:#;" | No Season
! colspan="2" style="background-color:#;" | By Date
! colspan="2" style="background-color:#;" | By Title
|+
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01E02'''.ext
|style="width:50px; text-align:center;"|2
|style="width:50px; text-align:left;"|''Name'' '''ep02'''.ext
|style="width:50px; text-align:center;"|3
|style="width:50px; text-align:left;"|''Name'' '''yyyy.mm.dd'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|'''Name'''.''special''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S1E2'''.ext
|style="width:50px; text-align:center;"|2
|style="width:50px; text-align:left;"|''Name'' '''ep_02'''.ext
|style="width:50px; text-align:center;"|3
|style="width:50px; text-align:left;"|''Name'' '''yyyy-mm-dd'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01.E02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''part.II'''.ext
|style="width:50px; text-align:center;"|4
|style="width:50px; text-align:left;"|''Name'' '''dd.mm.yyyy'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01_E02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''pt.II'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01xE02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''pt_II'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|5
|style="width:50px; text-align:left;"|''Name'' '''1x02'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|6
|style="width:50px; text-align:left;"|''Name'' '''102'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|}
|
;With Season
:The most commonly used for nearly all TV Shows.
;No Season
:Normally used for Anime or single season TV Shows. Not commonly used.
;By date
:Used for long-running daily shows. Check the scraper site for numbering method used.
;By title (added in v.20 "Nexus")
:Used for special episodes in case if a data provider does not support "zero season" convention for specials, e.g. TVmaze. It allows to match special episodes by their titles.
|}

= Multi-Episode Files =
If you video files contain two or more episodes, then the following naming is required to scan multiple episodes from a single file.

{| class="prettytable"
|-
| scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Minimum required episode name:''' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Recommended episode name:'''
|-
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"|''S01E01E02E04.mkv''
! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"|
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"| ''Angel (1999) S01E01E02E04.mkv''
|-
|Where:
|'''''S01E01E02E04''''' = Season 1, Episode 1, 2 & 4 || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| ||Where: ||'''''Angel (1999)''''' = TV Show name
|-
|
| ''Note that Episode 3 is not included'' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || || '''''S01E01E02E04''''' = Season 1, Episode 1, 2 & 4
|}

{|
|-
|
{|class="{{{1|prettytable}}}" style="margin: 0.5em 2.0em 0.5em 0em; font-size: 0.80em; {{border-radius|5px}}; float: top; clear: top;" width="500"
|-
! colspan="2" style="background-color:#;" | Complex Pattern
! colspan="2" style="background-color:#;" | Short Pattern
|+
! style="background-color:#;" | Order
! style="background-color:#; width:350px" | Example Name
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Example Name
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-'''s01e02'''.ext
|style="width:50px; text-align:center;"|1
|style="width:150px; text-align:left;"|''name'' '''s01e01e02'''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-''episode1.title''-'''s01e02'''-''episode2.title''.ext
|style="width:50px; text-align:center;"|1
|style="width:150px; text-align:left;"|''name'' '''s01e01-02-03'''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-'''s01e02'''-'''s01e03'''.ext
|style="width:50px; text-align:center;"|5
|style="width:150px; text-align:left;"|''name'' '''1x01x02'''.ext
|-
|style="width:50px; text-align:center;"|5
|style="width:300px; text-align:left;"|''name'' '''1x01'''-'''1x02'''.ext
|style="width:50px; text-align:center;"|2
|style="width:150px; text-align:left;"|''name'' '''ep01-02'''.ext
|-
|style="width:50px; text-align:center;"|2
|style="width:300px; text-align:left;"|''name'' '''ep01'''-'''ep02'''.ext
|style="width:50px; text-align:center;"|
|style="width:150px; text-align:left;"|
|}
|
'''It is recommended that multi-episode files be split into Single Episode files.'''

In cases where the video file contains more than one episode, you must nominate each episode in the filename.

* The patterns are the same as Single Episode numbering, but extended to include multiple episodes.
* Only the episodes in the file name will be added, e.g. '''''Angel (1999) S01E01E04.mkv''''' will scrape episodes 1 and 4 but not include episodes 2 and 3.
* When using a single video file for multiple episodes it is possible to tell set episode bookmarks for each episode in the file. See: '''''[[bookmarks|Episode Bookmarks]]'''''

:'''''See also: [[Advancedsettings.xml#tvmultipartmatching|Multi-Episode Matching]]''''' to create additional pattern matches
|}

= Specials =
Specials are extras or episodes that don't belong to a season.

Movies based on TV shows are usually ''not'' added as specials. Instead you [[Linking_movies_to_TV_shows|link a movie]] to a TV show. It will then appear at the bottom of the season list.

Specials are named as season 00 and start at E01, e.g. S'''00'''E01. Which episode number they'll have depends on the website the scraper use. At TMDB you access the specials by going to "View All Seasons">Specials.

In Kodi specials will appear under ''Specials'' in the season list.

= Episode Groups =
Episode Groups or Orders are listings with alternate episode orders. Some TV Shows are broadcast in one order but the DVD/Bluray release may have a different screening order. A well known example is the TV Show ''Firefly'' where the Studio opted to broadcast high action episodes for ratings first, while the Producer wanted a different order to correctly unfold the storyline.

Each Information Provider uses a different method to make alternate orders available. Check which scraper you are using and select the correct method below.

== TheMovieDB-TV Shows ==
See... '''[[Add-on:TMDb_TV_Shows#Episode_Orders|TheMovieDB Episode Groups]]'''

Only available when using the python scraper ''TMDB TV Shows.''

== The TVDB ==
See... '''[[Add-on:The_TVDB_v4#Flexible_Orders|TheTVDB Flexible Orders]]

Only available when using TheTVDB v4 python scraper by TVDB Team.

== TVmaze ==
See... '''[[Add-on:TVmaze#Episode_Orders|TVmaze Episode Orders]]'''

= References =
<references />

<center>
{| style="border: 1px solid black;"
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Mergefrom.gif|60px|link=Naming_video_files/Seasons]]
| style="width:200px; text-align:center;" | '''Previous step'''
| style="width:200px; text-align:center;" | '''Next step'''
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Merge-arrow.gif|60px|link=Adding_video_sources]]
|-
| style="width:200px; text-align:center;" | '''[[Naming_video_files/Seasons|Seasons Setup]]'''
| style="width:200px; text-align:center;" | '''[[Adding_video_sources|Add Source & Scrape]]'''
|}</center>

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

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Naming video files/Episodes

2022-12-10T01:33:10Z

LGoosens: Structured markup for clarity - if other conventions exist, please advise

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

__TOC__

= Introduction =
Be aware of the following:

* The '''only item in the episode file name''' that the {{kodi}} scanner searches for is the '''Season and Episode numbering''' (''SxxEyy''). Everything else is irrelevant.
* It is this SxxEyy that is used to match and scrape the episode metadata and artwork.
* To reduce the risk of the scanner becoming confused by complicated naming, ensure your episode filenames are clean and simple as described below.
* Contrary to advice from 3rd party internet guides, you cannot set season and episode numbering through NFO Files.

{{divbox|yellow|Do not refer to IMDB for episode orders. There is no IMDB Scraper.|
If you are using the default scraper then the site to check is [https://www.themoviedb.org/ TMDB]. If you have changed to [https://www.thetvdb.com/ TVDB] or [https://www.tvmaze.com/ TV Maze], check the appropriate site.}}

= Single Episode Files =
Episode files are assumed to contain a single episode. If you have files that contain two or more episodes, then read the Multi-Episodes section below.

The following table details the ''Minimum'' and ''Recommended'' naming for episodes files.

{| class="prettytable"
|-
| scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Minimum required episode name:''' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Recommended episode name:'''
|-
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"|''S01E01.mkv''
! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"|
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"| ''Angel (1999) S01E01.mkv''
|-
|Where:
|'''''S01E01''''' = Season 1, Episode 1 - no spaces || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| ||Where: ||'''''Angel (1999)''''' = TV Show name
|-
|
| || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || || '''''S01E01''''' = Season 1, Episode 1 - no spaces
|}

The Pattern '''S01E01''' is the most accurate available. Other Patterns are available in the table below with the most accurate at the top and accuracy decreasing down the list.

{|
|-
|
{|class="{{{1|prettytable}}}" style="margin: 0.5em 2.0em 0.5em 0em; font-size: 0.80em; {{border-radius|5px}}; float: top; clear: top;" width="500"
|-
! colspan="2" style="background-color:#;" | With Season
! colspan="2" style="background-color:#;" | No Season
! colspan="2" style="background-color:#;" | By Date
! colspan="2" style="background-color:#;" | By Title
|+
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Episode Naming
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01E02'''.ext
|style="width:50px; text-align:center;"|2
|style="width:50px; text-align:left;"|''Name'' '''ep02'''.ext
|style="width:50px; text-align:center;"|3
|style="width:50px; text-align:left;"|''Name'' '''yyyy.mm.dd'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|'''Name'''.''special''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S1E2'''.ext
|style="width:50px; text-align:center;"|2
|style="width:50px; text-align:left;"|''Name'' '''ep_02'''.ext
|style="width:50px; text-align:center;"|3
|style="width:50px; text-align:left;"|''Name'' '''yyyy-mm-dd'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01.E02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''part.II'''.ext
|style="width:50px; text-align:center;"|4
|style="width:50px; text-align:left;"|''Name'' '''dd.mm.yyyy'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01_E02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''pt.II'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|1
|style="width:50px; text-align:left;"|''Name'' '''S01xE02'''.ext
|style="width:50px; text-align:center;"|7
|style="width:50px; text-align:left;"|''Name'' '''pt_II'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|5
|style="width:50px; text-align:left;"|''Name'' '''1x02'''.ext
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:center;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|-
|style="width:50px; text-align:center;"|6
|style="width:50px; text-align:left;"|''Name'' '''102'''.ext
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|style="width:50px; text-align:left;"|
|}
|
;With Season
:The most commonly used for nearly all TV Shows.
;No Season
:Normally used for Anime or single season TV Shows. Not commonly used.
;By date
:Used for long-running daily shows. Check the scraper site for numbering method used.
;By title (added in v.20 "Nexus")
:Used for special episodes in case if a data provider does not support "zero season" convention for specials, e.g. TVmaze. It allows to match special episodes by their titles.
|}

= Multi-Episode Files =
If you video files contain two or more episodes, then the following naming is required to scan multiple episodes from a single file.

{| class="prettytable"
|-
| scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Minimum required episode name:''' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || scope="row" colspan="2" style="text-align:center; background-color:#a1f5e4;" | '''Recommended episode name:'''
|-
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"|''S01E01E02E04.mkv''
! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"|
! scope="row" colspan="2" style="width:400px; background-color:#f5f5a1; text-align:center;"| ''Angel (1999) S01E01E02E04.mkv''
|-
|Where:
|'''''S01E01E02E04''''' = Season 1, Episode 1, 2 & 4 || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| ||Where: ||'''''Angel (1999)''''' = TV Show name
|-
|
| ''Note that Episode 3 is not included'' || ! scope="row" colspan="1" style="width:10px; background-color:#d3d3d5; text-align:center;"| || || '''''S01E01E02E04''''' = Season 1, Episode 1, 2 & 4
|}

{|
|-
|
{|class="{{{1|prettytable}}}" style="margin: 0.5em 2.0em 0.5em 0em; font-size: 0.80em; {{border-radius|5px}}; float: top; clear: top;" width="500"
|-
! colspan="2" style="background-color:#;" | Complex Pattern
! colspan="2" style="background-color:#;" | Short Pattern
|+
! style="background-color:#;" | Order
! style="background-color:#; width:350px" | Example Name
! style="background-color:#;" | Order
! style="background-color:#; width:200px" | Example Name
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-'''s01e02'''.ext
|style="width:50px; text-align:center;"|1
|style="width:150px; text-align:left;"|''name'' '''s01e01e02'''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-''episode1.title''-'''s01e02'''-''episode2.title''.ext
|style="width:50px; text-align:center;"|1
|style="width:150px; text-align:left;"|''name'' '''s01e01-02-03'''.ext
|-
|style="width:50px; text-align:center;"|1
|style="width:300px; text-align:left;"|''name'' '''s01e01'''-'''s01e02'''-'''s01e03'''.ext
|style="width:50px; text-align:center;"|5
|style="width:150px; text-align:left;"|''name'' '''1x01x02'''.ext
|-
|style="width:50px; text-align:center;"|5
|style="width:300px; text-align:left;"|''name'' '''1x01'''-'''1x02'''.ext
|style="width:50px; text-align:center;"|2
|style="width:150px; text-align:left;"|''name'' '''ep01-02'''.ext
|-
|style="width:50px; text-align:center;"|2
|style="width:300px; text-align:left;"|''name'' '''ep01'''-'''ep02'''.ext
|style="width:50px; text-align:center;"|
|style="width:150px; text-align:left;"|
|}
|
'''It is recommended that multi-episode files be split into Single Episode files.'''

In cases where the video file contains more than one episode, you must nominate each episode in the filename.

* The patterns are the same as Single Episode numbering, but extended to include multiple episodes.
* Only the episodes in the file name will be added, e.g. '''''Angel (1999) S01E01E04.mkv''''' will scrape episodes 1 and 4 but not include episodes 2 and 3.
* When using a single video file for multiple episodes it is possible to tell set episode bookmarks for each episode in the file. See: '''''[[bookmarks|Episode Bookmarks]]'''''

:'''''See also: [[Advancedsettings.xml#tvmultipartmatching|Multi-Episode Matching]]''''' to create additional pattern matches
|}

= Specials =
Specials are extras or episodes that don't belong to a season.

Movies based on TV shows are usually ''not'' added as specials. Instead you [[Linking_movies_to_TV_shows|link a movie]] to a TV show. It will then appear at the bottom of the season list.

Specials are named as season 00 and start at E01, e.g. S'''00'''E01. Which episode number they'll have depends on the website the scraper use. At TMDB you access the specials by going to "View All Seasons">Specials.

In Kodi specials will appear under ''Specials'' in the season list.

= Episode Groups =
Episode Groups or Orders are listings with alternate episode orders. Some TV Shows are broadcast in one order but the DVD/Bluray release may have a different screening order. A well known example is the TV Show ''Firefly'' where the Studio opted to broadcast high action episodes for ratings first, while the Producer wanted a different order to correctly unfold the storyline.

Each Information Provider uses a different method to make alternate orders available. Check which scraper you are using and select the correct method below.

== TheMovieDB-TV Shows ==
See... '''[[Add-on:TMDb_TV_Shows#Episode_Orders|TheMovieDB Episode Groups]]'''

Only available when using the python scraper ''TMDB TV Shows.''

== The TVDB ==
See... '''[[Add-on:The_TVDB_v4#Flexible_Orders|TheTVDB Flexible Orders]]

Only available when using TheTVDB v4 python scraper by TVDB Team.

== TVmaze ==
See... '''[[Add-on:TVmaze#Episode_Orders|TVmaze Episode Orders]]'''

= References =
<references />

<center>
{| style="border: 1px solid black;"
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Mergefrom.gif|60px|link=Naming_video_files/Seasons]]
| style="width:200px; text-align:center;" | '''Previous step'''
| style="width:200px; text-align:center;" | '''Next step'''
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Merge-arrow.gif|60px|link=Adding_video_sources]]
|-
| style="width:200px; text-align:center;" | '''[[Naming_video_files/Seasons|Seasons Setup]]'''
| style="width:200px; text-align:center;" | '''[[Adding_video_sources|Add Source & Scrape]]'''
|}</center>

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

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Naming video files/Seasons

2022-12-10T01:28:52Z

LGoosens: Structured markup for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Season Folders =
{|
! scope="row" colspan="10" style="width:300px; background-color:#; text-align:left;"|
! scope="row" ! |
|-
| style="background-color:#;"| [[File:Video-TVShow Folder.png|left|400px|Image 1- TV Show folders]] || style="background-color:#;"|

* '''Season folders are optional'''. They are useful to reduce clutter in the main TV Show folder.
* If you use Season folders, the name of the season folder can be anything you prefer as '''the season folder plays no part in the scraping process'''.
* For some shows TVDB uses the '''Year''' as the season number ''(see images below)''. This is quite common with older shows, daytime soaps and talk shows.
{{note|Once your TV Shows have been scanned into the Library, it is possible to rename the Season folder displayed by {{kodi}}. '''''See: [[Season_rename|Season Rename]]'''''}}
|-
! scope="row" colspan="10" style="width:300px; background-color:#; text-align:left;"|
|}

<gallery mode="packed-overlay" widths="500px" heights="283px">
File:TVDB04.JPG|Image 1- Standard Season Numbers
File:TVDB03.JPG|Image 2- '''Year''' as Season Number
</gallery>

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

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

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Naming video files/Movies

2022-12-10T01:21:33Z

LGoosens: Structured markup for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Introduction =
There are two methods to organise your movies:
# '''Movie Folders'''- Each movie is saved in its own folder within the Source. ''(recommended)''
# '''Flat Folder'''- All movie files are saved in the Source folder

While {{kodi}} can be a little bit flexible, and some users have come up with "unusual" setups for their media files, {{kodi}} will only recommend the Movie Folder method described below.

We also recommend that your media is ripped to single files, like .mkv, rather than keeping the needlessly complex structure of Bluray and DVD folders.

= Naming =
The naming of your files and folders is '''critical''' to ensure the scrapers can correctly identify the movie, and it is simple to achieve.

'''''Movie Name (Year)''''' - This is the correct naming format for both the movie files and movie folders.

{{divbox|yellow||If you are unsure of the name or year, then look it up at '''''[https://www.themoviedb.org/ TheMovieDB website]'''''}}

= Movie Folders =
{|
! scope="row" colspan="10" style="width:300px; background-color:#a1f5e4; text-align:left;"|
! scope="row" ! |
|-
| style="background-color:#c4ffe2;"| [[File:Video-Movie Folder File Structure.png|left|400px|Image 1- Movie Folders]] || style="background-color:#c4ffe2;"|
{{resize|1.3em|This is the '''recommended''' method for organising your movies}}

All files and folders should be simply named with the name of the movie and the year in brackets. The name should match the name shown at the scraper site.

Each movie file is placed into its own folder which is then added to your Source.
* Placing movies in their own folder allows saving of local artwork and NFO files alongside the movie file.
* You have the choice of using the Short or Long name format for the artwork. See: '''''[[Movie_artwork#Local_Artwork | Local Artwork]] '''''
* Using this method will provide the safest and most accurate scrape of your media collection.
* Most library related add-ons will only work correctly with this method.
* Some skins use modified file naming to display additional '''''[[Media_flags|Media Flags]]'''''. These apply to the filename, not the folder name.
|-
! scope="row" colspan="10" style="width:300px; background-color:#a1f5e4; text-align:left;"|
|}

= Flat Folder =
{|
! scope="row" colspan="10" style="width:300px; text-align:left;"|
! scope="row" ! |
|-
| [[File:Video-Movie File Structure.png|left|400px|Image 2- Flat Folder]] ||
An alternate method of storing your movies 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 filename must contain the '''Title''' with the '''Year''' in parenthesis. The name should match the name shown at the scraper site.

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 Source folder will become even more cluttered
* Some library related add-ons will not work with this method as they require a Movie Folder
* Some skins use modified file naming to display additional '''''[[Media_flags|Media Flags]]'''''. In rare instances, there may be a mismatch due to conflict with the modified file name.
|}

= Split Video Files =
{{warning|File Stacking for ISO files, Bluray and DVD folders is currently broken and cannot be used. See [https://github.com/xbmc/xbmc/issues/16109 Issue report: 16109]}}
{|
! scope="row" colspan="10" style="width:300px; text-align:left;"|
! scope="row" ! |
|-
| [[File:Video-Movie FolderStacking.png|left|400px|Image 3- Split Video Files]] ||
Also known as ''File Stacking'', allows you to combine multiple movie files so they appear and play as a single movie. No longer a common requirement, but still available in {{kodi}} should it be needed.

To use this function the following steps are required:
# This feature can only be used when '''Movie Folders''' are used.
# Modify the video file names, as described in the table below, so that Kodi recognises them as Split Video Files

{{note|The setting '''[[Settings/Media/Videos#Files|Combine split video items]]''' has no effect on how this feature works. This setting simply combines the split titles when viewing the entry in Videos>Files.}}
{| class="prettytable"
|-
! colspan="1" style="background-color:#ffffcc; text-align:left;" | Type
! colspan="7" style="background-color:#ffffcc;" | Stacking Flags
|-
| scope="row" ! style="width:250px; text-align:left;"| Split single files- ''mkv, mp4 etc''
|style="width:50px; text-align:left;"|cd#
|style="width:50px; text-align:left;"|dvd#
|style="width:50px; text-align:left;"|disc#
|style="width:50px; text-align:left;"|disk#
|style="width:50px; text-align:left;"|part#
|style="width:50px; text-align:left;"|pt#
|style="width:90px; text-align:left;"|A, B, C, D <sup>1</sup>
|-
| scope="row" ! style="width:250px; text-align:left;"| DVD & Bluray folders & ISO files
|style="width:50px; text-align:left;"|cd#
|style="width:50px; text-align:left;"|dvd#
|style="width:50px; text-align:left;"|disc#
|style="width:50px; text-align:left;"|disk#
|}

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.

<sup>1</sup> Example of A, B, C, D flags (no space):
::''The Lord of the Rings The Fellowship of the Ring (2001)A.mkv''
::''The Lord of the Rings The Fellowship of the Ring (2001)B.mkv''
|}

= Other =
; [[3D]]
: {{#lst:3D|intro}}

; [[Extras]]
: Use one of the Extras add-ons to save related videos such as bloopers, interviews with cast and crew, production methods, behind the scenes, so they are accessible within {{kodi}}

; [[Internet_video_and_audio_streams|Internet Streams]]
: {{#lst:Internet_video_and_audio_streams|intro}}

; [[Media_flags|Media Flags]]
: Where supported by the skin, allows displaying of extra video file information through the use of modified file naming

; [[Media_stubs|Stub Files]]
: {{#lst:Media_stubs|intro}}

; [[Trailers]]
: {{#lst:Trailers|intro}}

<center>
{| style="border: 1px solid black;"
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Mergefrom.gif|60px|link=Source_folder]]
| style="width:200px; text-align:center;" | '''Previous step'''
| style="width:200px; text-align:center;" | '''Next step'''
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Merge-arrow.gif|60px|link=Naming_video_files/TV_shows]]
|-
| style="width:200px; text-align:center;" | '''[[Source folder]]'''
| style="width:200px; text-align:center;" | '''[[Naming_video_files/TV_shows|TV Show Setup]]'''
|}</center>

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

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Naming video files/Movies

2022-12-10T01:19:21Z

LGoosens: Structured markup for clarity - if other conventions exist, please advise

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Introduction =
There are two methods to organise your movies:
# '''Movie Folders'''- Each movie is saved in its own folder within the Source. ''(recommended)''
# '''Flat Folder'''- All movie files are saved in the Source folder

While {{kodi}} can be a little bit flexible, and some users have come up with "unusual" setups for their media files, {{kodi}} will only recommend the Movie Folder method described below.

We also recommend that your media is ripped to single files, like .mkv, rather than keeping the needlessly complex structure of Bluray and DVD folders.

= Naming =
The naming of your files and folders is '''critical''' to ensure the scrapers can correctly identify the movie, and it is simple to achieve.

'''''Movie Name (Year)''''' - This is the correct naming format for both the movie files and movie folders.

{{divbox|yellow||If you are unsure of the name or year, then look it up at '''''[https://www.themoviedb.org/ TheMovieDB website]'''''}}

= Movie Folders =
{|
! scope="row" colspan="10" style="width:300px; background-color:#a1f5e4; text-align:left;"|
! scope="row" ! |
|-
| style="background-color:#c4ffe2;"| [[File:Video-Movie Folder File Structure.png|left|400px|Image 1- Movie Folders]] || style="background-color:#c4ffe2;"|
{{resize|1.3em|This is the '''recommended''' method for organising your movies}}

All files and folders should be simply named with the name of the movie and the year in brackets. The name should match the name shown at the scraper site.

Each movie file is placed into its own folder which is then added to your Source.
* Placing movies in their own folder allows saving of local artwork and NFO files alongside the movie file.
* You have the choice of using the Short or Long name format for the artwork. See: '''''[[Movie_artwork#Local_Artwork | Local Artwork]] '''''
* Using this method will provide the safest and most accurate scrape of your media collection.
* Most library related add-ons will only work correctly with this method.
* Some skins use modified file naming to display additional '''''[[Media_flags|Media Flags]]'''''. These apply to the filename, not the folder name.
|-
! scope="row" colspan="10" style="width:300px; background-color:#a1f5e4; text-align:left;"|
|}

= Flat Folder =
{|
! scope="row" colspan="10" style="width:300px; text-align:left;"|
! scope="row" ! |
|-
| [[File:Video-Movie File Structure.png|left|400px|Image 2- Flat Folder]] ||
An alternate method of storing your movies 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 filename must contain the '''Title''' with the '''Year''' in parenthesis. The name should match the name shown at the scraper site.

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 Source folder will become even more cluttered
* Some library related add-ons will not work with this method as they require a Movie Folder
* Some skins use modified file naming to display additional '''''[[Media_flags|Media Flags]]'''''. In rare instances, there may be a mismatch due to conflict with the modified file name.
|}

= Split Video Files =
{{warning|File Stacking for ISO files, Bluray and DVD folders is currently broken and cannot be used. See [https://github.com/xbmc/xbmc/issues/16109 Issue report: 16109]}}
{|
! scope="row" colspan="10" style="width:300px; text-align:left;"|
! scope="row" ! |
|-
| [[File:Video-Movie FolderStacking.png|left|400px|Image 3- Split Video Files]] ||
Also known as ''File Stacking'', allows you to combine multiple movie files so they appear and play as a single movie. No longer a common requirement, but still available in {{kodi}} should it be needed.

To use this function the following steps are required:
# This feature can only be used when '''Movie Folders''' are used.
# Modify the video file names, as described in the table below, so that Kodi recognises them as Split Video Files

The setting '''[[Settings/Media/Videos#Files|Combine split video items]]''' has no effect on how this feature works. This setting simply combines the split titles when viewing the entry in Videos>Files.
{| class="prettytable"
|-
! colspan="1" style="background-color:#ffffcc; text-align:left;" | Type
! colspan="7" style="background-color:#ffffcc;" | Stacking Flags
|-
| scope="row" ! style="width:250px; text-align:left;"| Split single files- ''mkv, mp4 etc''
|style="width:50px; text-align:left;"|cd#
|style="width:50px; text-align:left;"|dvd#
|style="width:50px; text-align:left;"|disc#
|style="width:50px; text-align:left;"|disk#
|style="width:50px; text-align:left;"|part#
|style="width:50px; text-align:left;"|pt#
|style="width:90px; text-align:left;"|A, B, C, D <sup>1</sup>
|-
| scope="row" ! style="width:250px; text-align:left;"| DVD & Bluray folders & ISO files
|style="width:50px; text-align:left;"|cd#
|style="width:50px; text-align:left;"|dvd#
|style="width:50px; text-align:left;"|disc#
|style="width:50px; text-align:left;"|disk#
|}

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.

<sup>1</sup> Example of A, B, C, D flags (no space):
::''The Lord of the Rings The Fellowship of the Ring (2001)A.mkv''
::''The Lord of the Rings The Fellowship of the Ring (2001)B.mkv''
|}

= Other =
; [[3D]]
: {{#lst:3D|intro}}

; [[Extras]]
: Use one of the Extras add-ons to save related videos such as bloopers, interviews with cast and crew, production methods, behind the scenes, so they are accessible within {{kodi}}

; [[Internet_video_and_audio_streams|Internet Streams]]
: {{#lst:Internet_video_and_audio_streams|intro}}

; [[Media_flags|Media Flags]]
: Where supported by the skin, allows displaying of extra video file information through the use of modified file naming

; [[Media_stubs|Stub Files]]
: {{#lst:Media_stubs|intro}}

; [[Trailers]]
: {{#lst:Trailers|intro}}

<center>
{| style="border: 1px solid black;"
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Mergefrom.gif|60px|link=Source_folder]]
| style="width:200px; text-align:center;" | '''Previous step'''
| style="width:200px; text-align:center;" | '''Next step'''
| scope="row" rowspan="2" style=" text-align:center;" | [[File:Merge-arrow.gif|60px|link=Naming_video_files/TV_shows]]
|-
| style="width:200px; text-align:center;" | '''[[Source folder]]'''
| style="width:200px; text-align:center;" | '''[[Naming_video_files/TV_shows|TV Show Setup]]'''
|}</center>

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

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Naming video files/TV shows

2022-12-10T01:18:00Z

LGoosens: Structured markup for clarity - if other conventions exist, please advise

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Introduction =
There are two components to TV Shows that need to be accurate for a successful scrape:
# Correct '''naming''' of the TV Show
# Correct '''numbering''' of the Episodes

{{note|This page details the TV Show folder. Season folders and episodes are discussed in the following pages.}}

= TV Show Folders =
{|
! scope="row" colspan="10" style="width:300px; background-color:#; text-align:left;"|
! scope="row" ! |
|-
| style="background-color:#;"| [[File:Video-TVShow Folder.png|left|400px|Image 1- TV Show folders]] || style="background-color:#;"|
'''{{resize|1.3em|{{red|Each TV Show requires its own folder in the Source folder}} }}'''

The naming of your TV Show folder is '''critical''' to ensure the scrapers can correctly identify the TV Show and its episodes.

'''''TV Show Name (Year)''''' - This is the correct naming format for the TV Show folder

* The TV Show folders are saved inside the '''''[[Source_folder|Source folder]]'''''
* Adding the (Year) makes scraping more accurate and differentiates between original and remake versions.
* For '''Country of Origin''' TV Shows, the (Year) is replaced with the country code. eg ''Hells Kitchen (UK), Hells Kitchen (US), Hells Kitchen (AU)'' etc.
* '''The title and (year) displayed at the scraper site is how you should name your show.'''

{{divbox|yellow|If you are unsure of the name or year, then check which scraper you are using and visit the appropriate site for correct naming:|
* '''''[https://www.themoviedb.org/ TheMovieDB]''''' - ''(the default scraper)''
* '''''[https://www.thetvdb.com/ TVDB]'''''
* '''''[https://www.tvmaze.com/ TV Maze]'''''}}
|-
! scope="row" colspan="10" style="width:300px; background-color:#; text-align:left;"|
|}

== Split folders ==
Split folders are TV Shows that have episodes split between two or more folders located in different Sources. This may occur when a long running show is progressively saved on one drive but, over time, the drive has been filled with other content, forcing you to save new episodes on another drive.

{{warning|To ensure these split TV Shows are correctly scraped as the same show, you '''must''' ensure that the TV Show folder names are identical. A slight variance could see a different show scraped for the second folder.}}
{{warning|If using NFO Files, then copy the NFO file from one location into the other split folders.}}

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

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

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Naming video files/TV shows

2022-12-10T01:03:38Z

LGoosens: Structured markup for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Introduction =
There are two components to TV Shows that need to be accurate for a successful scrape:
# Correct '''naming''' of the TV Show
# Correct '''numbering''' of the Episodes

{{note|This page details the TV Show folder. Season folders and episodes are discussed in the following pages.}}

= TV Show Folders =
{|
! scope="row" colspan="10" style="width:300px; background-color:#; text-align:left;"|
! scope="row" ! |
|-
| style="background-color:#;"| [[File:Video-TVShow Folder.png|left|400px|Image 1- TV Show folders]] || style="background-color:#;"|
'''{{resize|1.3em|{{red|Each TV Show requires its own folder in the Source folder}} }}'''

The naming of your TV Show folder is '''critical''' to ensure the scrapers can correctly identify the TV Show and its episodes.

'''''TV Show Name (Year)''''' - This is the correct naming format for the TV Show folder

* The TV Show folders are saved inside the '''''[[Source_folder|Source folder]]'''''
* Adding the (Year) makes scraping more accurate and differentiates between original and remake versions.
* For '''Country of Origin''' TV Shows, the (Year) is replaced with the country code. eg ''Hells Kitchen (UK), Hells Kitchen (US), Hells Kitchen (AU)'' etc.
* '''The title and (year) displayed at the scraper site is how you should name your show.'''

If you are unsure of the name or year, then check which scraper you are using and visit the appropriate site for correct naming:
* '''''[https://www.themoviedb.org/ TheMovieDB]''''' - ''(the default scraper)''
* '''''[https://www.thetvdb.com/ TVDB]'''''
* '''''[https://www.tvmaze.com/ TV Maze]'''''
|-
! scope="row" colspan="10" style="width:300px; background-color:#; text-align:left;"|
|}

== Split folders ==
Split folders are TV Shows that have episodes split between two or more folders located in different Sources. This may occur when a long running show is progressively saved on one drive but, over time, the drive has been filled with other content, forcing you to save new episodes on another drive.

{{warning|To ensure these split TV Shows are correctly scraped as the same show, you '''must''' ensure that the TV Show folder names are identical. A slight variance could see a different show scraped for the second folder.}}
{{warning|If using NFO Files, then copy the NFO file from one location into the other split folders.}}

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

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

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]

Naming video files/TV shows

2022-12-10T01:00:29Z

LGoosens: Structured markup for clarity

{{VideoLibraryCreate}}
{{mininav| [[Video library]] |[[HOW-TO:Create_Video_Library|Create Video Library]] }}

= Introduction =
There are two components to TV Shows that need to be accurate for a successful scrape:
# Correct '''naming''' of the TV Show
# Correct '''numbering''' of the Episodes

'''This page details the TV Show folder. Season folders and episodes are discussed in the following pages.'''

= TV Show Folders =
{|
! scope="row" colspan="10" style="width:300px; background-color:#; text-align:left;"|
! scope="row" ! |
|-
| style="background-color:#;"| [[File:Video-TVShow Folder.png|left|400px|Image 1- TV Show folders]] || style="background-color:#;"|
'''{{resize|1.3em|{{red|Each TV Show requires its own folder in the Source folder}} }}'''

The naming of your TV Show folder is '''critical''' to ensure the scrapers can correctly identify the TV Show and its episodes.

'''''TV Show Name (Year)''''' - This is the correct naming format for the TV Show folder

* The TV Show folders are saved inside the '''''[[Source_folder|Source folder]]'''''
* Adding the (Year) makes scraping more accurate and differentiates between original and remake versions.
* For '''Country of Origin''' TV Shows, the (Year) is replaced with the country code. eg ''Hells Kitchen (UK), Hells Kitchen (US), Hells Kitchen (AU)'' etc.
* '''The title and (year) displayed at the scraper site is how you should name your show.'''

If you are unsure of the name or year, then check which scraper you are using and visit the appropriate site for correct naming:
* '''''[https://www.themoviedb.org/ TheMovieDB]''''' - ''(the default scraper)''
* '''''[https://www.thetvdb.com/ TVDB]'''''
* '''''[https://www.tvmaze.com/ TV Maze]'''''
|-
! scope="row" colspan="10" style="width:300px; background-color:#; text-align:left;"|
|}

== Split folders ==
Split folders are TV Shows that have episodes split between two or more folders located in different Sources. This may occur when a long running show is progressively saved on one drive but, over time, the drive has been filled with other content, forcing you to save new episodes on another drive.

{{warning|To ensure these split TV Shows are correctly scraped as the same show, you '''must''' ensure that the TV Show folder names are identical. A slight variance could see a different show scraped for the second folder.}}
{{warning|If using NFO Files, then copy the NFO file from one location into the other split folders.}}

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

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

[[Category:Guides]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:First time user]]