{{VideoLibraryCreate}}
{{mininav|[[Video library]]|[[Naming video files]]}}

= Introduction =
<section begin="intro" />Setting up TV Shows correctly is a little bit more involved than the Movies section. The first part of this page will describe the '''{{Kodi}} best practice''' to name TV Shows and Episode files and to create the folder structure to save them in. These methods are proven to be the simplest and most robust method which provides the most accurate scrape.<section end="intro" />

= TV Show Folder =
[[File:Video-TVShow Folder.png|500px|right]]
'''{{red|Each TV Show requires its own folder. The TV Show folder name is used to match the show at the scraper site.}}'''.

{{Kodi}} '''does not''' support the flat folder structure for TV Shows where all episodes from different TV Shows are in the same folder.

*The TV Show folders are located inside the '''''[[Naming_video_files#Source_Folder|Source folder]]'''''.
*The folder name will be '''''[[Advancedsettings.xml#.3Ccleanstrings.3E|cleaned]]''''' of commonly used strings, such as ''DVDRip, 1080p, x264,'' etc. before being passed to the scraper. If the year of release is included, this will be '''''[[advancedsettings.xml#.3Ccleandatetime.3E|extracted]]''''' and used by the scraper to assist in making a match.
*Spaces, periods, or underscores may be used to separate words in the folder and file names, but should not be mixed. Note also the issue with Split-episodes regarding file names with periods.

Naming TV Shows follows the same guidelines as for Movies.
*Name the TV Show folder the same way as shown on the TV Show page at the scraper site.
*It is always best practice to include the year along with the title. This makes scraping more accurate and differentiates between original and remake versions.
*This guideline also applies to '''Country of Origin''' TV Shows. For example Hells Kitchen (UK), Hells Kitchen (US), Hells Kitchen (AU), Hells Kitchen (IT) etc.
*'''The title and (year) displayed at the scraper site is how you should name your show.'''

The '''best practice''' method is detailed in the image to the right. (season folders are optional)
*''Angel (1999)''- TV Show folder containing Single File episodes
*''Battlestar Galactica (1978)''- TV Show folder containing DVD folders for episodes
*''Battlestar Galactica (2004)''- TV Show folder containing Bluray folders for episodes

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

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. If using NFO Files, then copy the NFO file from one location into the other split folders.

= Season Folder =
Season folders are optional. They are useful to reduce clutter in the main TV Show folder.

Even though {{kodi}} can accommodate the Season folder, it will ignore them. Instead it looks for the correctly numbered episode files.

As a side 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]]'''''

When scraping be aware that season numbers may not be basic numbers. Many shows use the '''Year''' as the season number. This is quite common with older shows, daytime soaps and talk shows. '''Always check the site'''
<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>

= Episode Files =
'''Check the site of the information provider to confirm your files are in the same order and that the episodes exist at the scraper site. If not, images and metadata will not match your episode files or your scrape will fail if the episodes do not exist.'''

*The episode files (or folders if using DVD or Bluray folders) are located inside the TV Show folder or inside Season folders if using them.
*The file name (or folder name) will be '''''[[Advancedsettings.xml#.3Ccleanstrings.3E|cleaned]]''''' of commonly used strings, such as ''DVDRip, 1080p, x264,'' etc. before being passed to the scraper.
*Spaces, periods, or underscores may be used to separate words in the folder and file names, but should not be mixed. Note also the issue with Split-episodes regarding file names with periods.

All episode files must be named and numbered correctly for the scanner to match the correct episode to the ''<episodeguide>'' URL of the TV Show downloaded from the scraper site. You cannot nominate season and episode numbering through NFO Files.

The following is the simplest and most accurate way to name your episode files:

:{| class="prettytable"
|-
! scope="row" colspan="2" style="width:300px; background-color:#a1f5e4; text-align:center;"| Angel (1999) S01E01.mkv 
|-
|Where:
|'''''Angel (1999)''''' = TV Show name
|-
|
|'''''S01E01''''' = Season 1, Episode 1
|}

For information on alternate or advanced episode naming conventions, see the ''Advanced Setup'' section further down this page.

For information on '''''alternate episode orders''''', see the ''Episode Groups'' section further down this page.

== Specials Episodes ==
'''All Special Episodes use Season 00'''
:{| class="prettytable"
|-
! scope="row" ! style="width:300px; background-color:#a1f5e4; text-align:left;"| Doctor Who (2005) S00E50
|}

They are listed at TheMovieDB in the Specials section of the Season listing.

Special Episdes are episodes that do not fit into the normal storyline of the TV Show. They may include items such as Christmas Specials, Season recap episodes, Made for TV Movies that extend the storyline, Unaired Pilots etc

Special Episodes can be displayed in amongst the regular episodes through the use of '''[[NFO_files/TV_shows|NFO Files]]'''. this is specified using the '''<displayepisode></displayepisode>''' and '''<displayseason></displayseason>''' tags.

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

== TheMovieDB-TV Shows ==
TheMovieDB uses Episode Groups for additional episode orders.
*Numerous Groups can be added which should cater to the different releases between countries
*Creating Groups and adding episodes is quite simplistic, using drag and drop which should encourage contributors to complete the entries
*Where available, the listings are easily accessible for viewing as shown in the images below

<gallery mode="traditional" widths="500px" heights="283px">
File:EpisodeGroups01.jpg|Image 1- Accessing Episode Groups
File:EpisodeGroups02.jpg|Image 2- Available Episode Groups
File:EpisodeGroups03.jpg|Image 3- Select a Group, then copy the address for use in a Parsing NFO file.
</gallery>

To use one of the orders for scraping, follow the images above and place the address in a '''''[[NFO_files#Parsing_nfo|Parsing NFO file]]''''' then scrape. The Parsing NFO File will point the scraper to the listing. <ref>https://forum.kodi.tv/showthread.php?tid=338467&pid=2801494#pid2801494</ref>

== The TVDB ==
The TVDB allows for three listing orders as detailed below.
*These are the only three orders available.
*The current web site is flawed and does not allow the display of the different orders.

;Aired Order
*This is the default order set in the scraper settings.
*TVDB lists all TV shows in the original '''Aired Order'''. The first time a show is ever broadcast, that is the listing shown. The site is not concerned with how it was broadcast the 2nd, 3rd or 15th time, or how it was broadcast in other countries, or during syndication. It only lists the order of the FIRST TIME ever broadcast, whether that be on Free To Air or Subscription Television.
*Episodes are grouped and listed into Seasons and each episode is numbered sequentially from 1, which resets for each season.

;DVD Order
*In many cases, DVD's are released with a different episode listing, normally being the original order envisioned by the Director. To accommodate this, the site also has a '''DVD Order''' listing.
*Episodes are grouped and listed into Seasons and each episode is numbered sequentially from 1, which resets for each season.
*There are many TV Shows on the TVDB site that do not have the DVD Order data entered. The scraper will default back to Aired Order if there is no DVD Order information listed.
*Note: As the data at TVDB is created by the open community, it is not uncommon for errors to occur with DVD Order details. As it is seen as secondary information, the errors can go unnoticed. One major error that affects the scrapers is incomplete DVD Order details. For example, some episodes have no DVD Order data, while other episodes in the same season do have the data.
*Early May 2018, TVDB upgraded their website to v2.0. Unfortunately a glitch has prevented the display of DVD Order and Absolute Order information. It is unknown when it will be rectified.

;Absolute Order
*This order ignores Seasons and gives each episode an incremental number starting at 1.
*This order is used for Anime type shows.

The Order you use can be set in the settings page for the TVDB Scraper.

----
'''{{big|{{red|The remainder of this page deals with Special Use cases and can be safely ignored. Most libraries will not require implementing the following additional name extensions.}}}}'''
----

<div style="{{linear-gradient|left|#a1f5e4, #f5f5a1}}">{{next|[[Adding_video_sources|'''Add Source & Scrape''']]}} </div>

= Advanced Setup =
The previous section details the simplest method to set up your TV Show library. It is considered the '''''best practice''''' method.

The sections from here onwards are alternate or advanced methods. With added complexity comes higher maintenance and more potential problems and scraping errors.

== TV Show folder ==
'''{{red|These other methods are available but NOT recommended. The sub-folders are easily mistaken and scraped as false TV shows. While it is possible to find and fix the ghost entries, the extra time and work involved will override any possible benefits. If you need to re-build your library at a later stage, the problems will need to be solved again.}}'''

In more complex situations where your top-level directory is further sub-divided before the show folders, you can add the top-level as source but not set the content, and then set the content to TV shows on each sub-folder.

;Example

:{| class="prettytable" style="width:500px; background-color:#a1f5e4; text-align:left;"
|
<pre>
TV Shows <<Source folder, Content: None>>
|----A-M <<Content: TV shows>>
| |----TV Show 1
| |--Files
|----N-Z <<Content: TV shows>>
| |----TV Show 2
| |--Files
</pre>
|}

It is also possible to have a sub-folder group multiple shows together in an otherwise normal directory structure. Just change the content on the sub-folder and de-select the "Selected folder contains a single TV show" setting.

;Example

:{| class="prettytable" style="width:500px; background-color:#a1f5e4; text-align:left;"
|
<pre>
TV Shows <<Source folder, Content: TV shows>>
|----TV Show 1
| |----Season #
| |--Files
|----Star Trek Series <<Content:TV shows>>
| |----Star Trek
| | |--Files
| |----Star Trek The Next Generation
| |--Files
</pre>
|}

In these cases, it's best to refrain from scanning the files into the library until the content is set correctly for all folders, to avoid incorrect results and the need to rescan.

== Seasons ==
Nil availble options. Season folders are ignored by {{kodi}} which means you can name them as you please.

== Single Episodes ==
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 structure of the episode name is as follows:

:{| class="prettytable"
|-
! scope="row" ! style="width:300px; background-color:#a1f5e4; text-align:left;"| name <<pattern>>.ext
|}

:where:
:*'''name''' is the title of the show and is optional. It could just as easily be after the pattern, or excluded entirely.
:*'''<<pattern>>''' is one of the expressions in the following tables. ''S'' = Season number; ''E'' = Episode number
:*'''.ext''' is a recognized video file extension, (mkv, avi, ts, mp4, etc) or ommitted entirely if using DVD or Bluray folders.

Kodi uses a series of regular expressions to determine the season and episode numbers from the file name. These are checked in a pre-determined order with the first match being the one used and everything else in the file name is ignored. NFO Files are '''never''' checked for season and episode numbers.

There are 8 default patterns, plus a separate multi-episode pattern. Using any other numbering convention outside of the ones provided in the list below will require you to edit your advancedsettings.xml and insert your custom RegEx.

Spaces, periods, or underscores may be used to separate words in the folder and file names, but shouldn't be mixed in the same name. The regex is not case-sensitive and either uppercase or lowercase may be used. The examples on this page use uppercase.

The following table lists:
*The pattern that {{kodi}} will search for.
*The order of the search. ie. Patterns numbered '''1''' will be matched first and those numbered '''7''' will be matched last.

;With Season
:The most common usage and used for nearly all TV Shows.
;No Season
:In cases where you only have one season (or are using absolute order in the TVDB scraper), you may want to forego the inclusion of the season number.
;By date
:Common for long-running daily shows, allows the use of aired date of the episode.

{| class="prettytable"
|-
! colspan="2" style="background-color:#a1f5e4;" | With Season
! colspan="2" style="background-color:#a1f5e4;" | No Season
! colspan="2" style="background-color:#a1f5e4;" | By Date
|+
! style="background-color:#f5f5a1;" | Order
! style="background-color:#f5f5a1; width:200px" | Episode Naming
! style="background-color:#f5f5a1;" | Order
! style="background-color:#f5f5a1; width:200px" | Episode Naming
! style="background-color:#f5f5a1;" | Order
! style="background-color:#f5f5a1; 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;"|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: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: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: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: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: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;"|
|}

== Multi-Episodes ==
In cases where the file contains more than one episode, it is possible to specify all the episodes included in that file. Everything after the first found pattern match will be checked for further matches to the same pattern.

*When using a single video file for multiple episodes it is possible to tell Kodi when each episode starts using '''''[[Bookmarks_and_chapters|Episode Bookmarks]]'''''
*Two versions are shown- Long version and Short version. Only the episodes in the file name will be added, e.g. ''name''.'''s01e01-03'''.ext will not include episode 2.
*The patterns are the same for Single Episode numbering, but extended to include multiple episodes.

:'''''See also: [[Advancedsettings.xml#.3Ctvmultipartmatching.3E|multi-episode pattern]]'''''

{| class="prettytable"
|-
! colspan="2" style="background-color:#a1f5e4;" | Complex Pattern
! colspan="2" style="background-color:#a1f5e4;" | Short Pattern
|+
! style="background-color:#f5f5a1;" | Order
! style="background-color:#f5f5a1; width:350px" | Example Name
! style="background-color:#f5f5a1;" | Order
! style="background-color:#f5f5a1; 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;"|
|}

== Split Episodes ==
{{warning|{{resize|1.4em|The November 2019 upgrade of the TVDB site has removed the ''E01.1, E01.2'' type numbering of episodes. This naming technique no longer applies for any scraper and has been removed from the wiki.}}}}
If your files still contain this numbering scheme, and you intend to re-scrape your library, check the episode listing at [https://www.thetvdb.com/ TheTVDB] to ensure your episodes are numbered correctly.

= Stub and Stream Files =
{{main|Media_stubs}}
{{#lst:Media_stubs|intro}}

{{main|Internet_video_and_audio_streams}}
{{#lst:Internet_video_and_audio_streams|intro}}

= Media Tags / Flags =
{{main|Media flags}}

[[File:480.png|50px]] [[File:1080.png|50px]] [[File:720.png|50px]] [[File:1080 n.png|50px]] [[File:480-1.png|50px]]
[[File:Divx.png|80px]] [[File:Xvid.png|80px]] [[File:H264.png|80px]] [[File:Bluray.png|80px]] [[File:Dvd.png|80px]] [[File:Avc1.png|80px]]
[[File:1.33.png|50px]] [[File:1.66.png|50px]] [[File:2.20.png|50px]] [[File:2.35.png|50px]]

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

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

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

Example- note that movie folders are used, and the folder is simply named while the filename has been modified with extensions.
{| class="prettytable"
|-
! scope="row" ! style="width:400px; background-color:#a1f5e4; text-align:left;"| ...\Paul (2011)\Paul (2011).4K.HDR.Atmos.mkv
|}

== 3D Episodes ==
{{Main|3D}}
Some 3D episodes might need an additional file name extension to be identified by Kodi as 3D. See '''''[[3D]]''''' for details on that additional extension, and when it is needed.

= Custom Filenames =
It's possible to use custom file names that don't match any of the default patterns by editing your [[advancedsettings.xml]] file to include a [[advancedsettings.xml#.3Ctvshowmatching.3E|tvshowmatching]] tag containing regular expressions.

A tvshowmatching regexp needs up to three capturing groups:
:1 capturing group = episode number (season will default to season 1), no multi-episode matches will be attempted
:2 capturing groups = season number + episode number (in that order), no multi-episode matches will be attempted
:3 capturing groups = season number + episode number + multi-episode matching part (typically just the remainder of the file name)

(A capturing group is essentially a part of the regexp contained inside brackets.)

To have no season but multi-episode matching, use three groups but leave the first empty.

Date-based regexps are also possible, and are marked by a bydate="true" attribute in the regexp. These also use three capturing groups, either as year-month-day or day-month-year, the lengths must be exactly 4-2-2 or 2-2-4.

Your custom tvshowmatching regexps can be either checked for before the default set using <code>action="prepend"</code>, or after using <code>action="append"</code>. Not including an action will result in only your regexps being tested. Care should be taken to ensure that the right regexp matches your file names, particularly in regard to the three digit "102" pattern seen [[#Single_Episodes|above]].
The regexps should be grouped together inside a single tvshowmatching tag, although you can use two if you wish to prepend ''and'' append different regexps.

You can also change the multi-episode matching regexp by including a [[Advancedsettings.xml#.3Ctvmultipartmatching.3E|tvmultipartmatching]] tag in your advancedsettings.xml (separate from the tvshowmatching tag).
There can be only one tvmultipartmatching expression, whatever you use will overwrite the default, so take care to only expand on the default pattern unless you are certain.
The tvmultipartmatching requires one capturing group for the episode number.

For simplicity, the split-episode pattern has been excluded from the examples below. To allow for split-episodes, replace the <code>[0-9]+</code> in the episode capturing group with <code>[0-9]+(?:(?:[a-i]|\.[1-9])(?![0-9]))?</code>

== Examples ==
A fairly straightforward example to begin.
;Season ## - Episode ##
:"Season [season#] - Episode [episode#]" anywhere in the file name
:{| class="prettytable" style="width:900px; background-color:#a1f5e4; text-align:left;"
|-
|
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching action="prepend">
<regexp>Season ([0-9]+) - Episode ([0-9]+)([^\\/]*)$</regexp>
</tvshowmatching>
</syntaxhighlight>
|}
:'''Example''' : TV Shows\Scrubs\Season 1\Scrubs - '''Season 1 - Episode 01''' - Pilot.avi
:The first two capturing groups should be obvious, the third group <code>([^\\/]*)</code> captures everything up to the end of the file name <code>$</code>, this allows for multi-part file names such as ''name''.'''Season 1 - Episode 01''' - '''Season 1 - Episode 02'''.ext as well as the simpler ''name''.'''Season 1 - Episode 01-02'''.ext

----
The entire file path is passed to the regexps, so care should be taken to ensure the matches can't occur earlier in the path, but this does mean for example, you can capture the season number from a sub-folder name.
;\Season #\##
:Season [season#] at the end of the directory name, file name starts with [episode#]
:{| class="prettytable" style="width:900px; background-color:#a1f5e4; text-align:left;"
|-
|
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching action="prepend">
<regexp>Season[\._ ]([0-9]+)[\\/]([0-9]+)([^\\/]*)$</regexp>
</tvshowmatching>
</syntaxhighlight>
|}
:'''Example''' : \Battlestar Galactica (2003)\'''Season 3\01''' - Occupation.avi (Season 3, Episode 1)
:Again we use three groups here to allow for multi-episode, but in this case (obviously) only the shorter multi-episode pattern can occur, e.g. '''Season 1\01x02''' - Episode title.ext.

----
For numbering without a season, you should ensure that only the episode number gets matched against and not another number in the title or episode title, or a number as part of a different pattern.
; - ## -
:" - [episode#] - " anywhere in the file name
:{| class="prettytable" style="width:900px; background-color:#a1f5e4; text-align:left;"
|-
|
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching action="prepend">
<regexp> - ()([0-9]+)((?:-[0-9]+)*) - [^\\/]*$</regexp>
</tvshowmatching>
</syntaxhighlight>
|}
:'''Example''' : \One Piece\One Piece''' - 099 - '''Spirit of the Fakes! Heart of the Rebel Army, Kamyu!.avi ("Season 1", Episode 99) (Using Absolute order)
:Here, the first capturing group is left empty, and there is a distinct pattern before and after the episode number to ensure only it gets matched. Also instead of capturing the remainder of the file name for multi-part matching, we only capturing a single repeating pattern so only a '''- 01-02-03 -''' format will work.

----
It's also possible to specify a different default season for without-season regexps.
;\Specials\##
:Directory name is Specials, file name starts with [episode#]
:{| class="prettytable" style="width:900px; background-color:#a1f5e4; text-align:left;"
|-
|
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching action="prepend">
<regexp defaultseason="0">Specials[\\/]()([0-9]+)([^\\/]*)$</regexp>
</tvshowmatching>
</syntaxhighlight>
|}
:'''Example''' : \Firefly\'''Specials\04''' - Browncoats Unite.mkv (Season 0, Episode 4)
:A combination of the previous two examples, allowing special episodes to reside in a "Specials" folder rather than a "Season 0" folder.

----
The default date-based regexps only allow for periods or hyphens as delimiters...
;<nowiki>####_##_##</nowiki>
:[year]_[month]_[day] anywhere in the file name
:{| class="prettytable" style="width:900px; background-color:#a1f5e4; text-align:left;"
|-
|
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching action="prepend">
<regexp bydate="true">([0-9]{4})_([0-9]{2})_([0-9]{2})[^\\/]*$</regexp>
</tvshowmatching>
</syntaxhighlight>
|}
:'''Example:''' : \The Colbert Report\'''2005_10_17'''.avi
:The exact number of digits is specified for each group to ensure compliance. A separate [month]_[day]_[year] regexp would be needed if both formats are in use.

----
The default regexps don't allow for DVD folder structures, this can usually be remedied by replacing the final <code>$</code> with <code>(?:(?:[\\/]video_ts)?[\\/]video_ts\.ifo)$</code>
;S##E##\VIDEO_TS\VIDEO_TS.IFO
:{| class="prettytable" style="width:900px; background-color:#a1f5e4; text-align:left;"
|-
|
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching action="append">
<regexp>[Ss]([0-9]+)[ ._-]*[Ee]([0-9]+)([^\\/]*)(?:(?:[\\/]VIDEO_TS)?[\\/]VIDEO_TS\.IFO)$</regexp>
</tvshowmatching>
</syntaxhighlight>
|}
:'''Example:''' \Battlestar Galactica (2003)\The Mini-Series '''S00E01E02'''\VIDEO_TS\VIDEO_TS.IFO
:The VIDEO_TS folder is optional, e.g. '''S01E01'''\VIDEO_TS.IFO will also work.

----
Similarly for Bluray folder structures, you can replace the final <code>$</code> with <code>(?:(?:[\\/]bdmv)?[\\/]index\.bdmv)$</code>
;<nowiki>#</nowiki>x##\BDMV\index.bdmv
:{| class="prettytable" style="width:900px; background-color:#a1f5e4; text-align:left;"
|-
|
<syntaxhighlight lang=xml enclose="div">
<tvshowmatching action="append">
<regexp>[\\/\._ \[\(-]([0-9]+)x([0-9]+)([^\\/]*)(?:(?:[\\/]bdmv)?[\\/]index\.bdmv)$</regexp>
</tvshowmatching>
</syntaxhighlight>
|}
:With Bluray folders, you'll also run into trouble with the various mpls and m2ts files incorrectly matching other patterns, so you should also exclude all the other folders and files from being scanned:
:{| class="prettytable" style="width:900px; background-color:#a1f5e4; text-align:left;"
|-
|
<syntaxhighlight lang=xml enclose="div">
<video>
<excludetvshowsfromscan action="append">
<regexp>[\\/](auxdata|backup|clipinf|playlist|stream|certificate)[\\/]</regexp>
<regexp>movieobject\.bdmv</regexp>
</excludetvshowsfromscan>
</video>
</syntaxhighlight>
|}

----
Finally, a tvmultipartmatching example.
;S##E##+##
:Multiple episode numbers, separated by a + sign
:{| class="prettytable" style="width:900px; background-color:#a1f5e4; text-align:left;"
|-
|
<syntaxhighlight lang=xml enclose="div">
<tvmultipartmatching>^[-_EeXx+]+([0-9]+)</tvmultipartmatching>
</syntaxhighlight>
|}
:'''Example:''' : \Lost\Lost.'''S01E23+24'''.Exodus.mkv
:In this case we can simply add the + sign to the default symbols, thus preserving the defaults as well.

= advancedsettings.xml =
{{main|advancedsettings.xml}}
The following settings allow user customisation for TV Show and Episode matching.

* [[advancedsettings.xml#tvshowmatching|<tvshowmatching>]]
* [[advancedsettings.xml#tvmultipartmatching|<tvmultipartmatching>]]
* [[advancedsettings.xml#excludetvshowsfromscan|<excludetvshowsfromscan>]]
* [[advancedsettings.xml#cleanstrings|<cleanstrings>]]
* [[advancedsettings.xml#videoextensions|<videoextensions>]]
* [[advancedsettings.xml#discstubextensions|<discstubextensions>]]

= References =
<references />

{{top}}

<div style="{{linear-gradient|left|#a1f5e4, #f5f5a1}}">{{next|[[Adding_video_sources|'''Add Source & Scrape''']]}} </div>

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:How-to]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:General topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

User talk:Muddysteel

2019-06-18T13:45:55Z

Muddysteel: /* Segmenting page info into current/best practices vs. out-of-date */ new section

'''Welcome to ''Official Kodi Wiki''!'''
We hope you will contribute much and well.
You will probably want to read the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents help pages].
Again, welcome and have fun! [[User:Davu|Davu]] ([[User talk:Davu|talk]]) 05:36, 7 February 2019 (UTC)

== Who Be Muddysteel? ==

Long time computer geek. Started a ways back with BASIC, migrated to COBOL, then Pascal, then C then.. lost count. (Never got much past C++ primers; too much a hack-over of C vs. other from-the-ground-up languages like Java. REALLY interested in [https://en.wikipedia.org/wiki/Rust_(programming_language Rust] and [https://en.wikipedia.org/wiki/Go_(programming_language) GO], especially since Java did not fuse to the underlying O/S all that well.)

Professionally, software engineer with a pedigree that ranges from discrete real-time control system stuff, to enterprise application apps and the surrounding infrastructure / support. Currently employed with an eye on developing enterprise apps that are from the ground up, built to be secure. Lots of time under the hood with [https://en.wikipedia.org/wiki/Java_Cryptography_Extension JCE] and [https://en.wikipedia.org/wiki/Hardware_security_module HSMs] of different flavors.

Nosing into Kodi and its Wiki 'cause there's a ton of spare-time work to be done cleaning stuff up - as my experience with Kodi evolves, will turn my Wiki-izing towards those topics I have the opportunity to touch upon. Might even try a (C++) patch or two.. :)

[[User:Muddysteel|Muddysteel]] ([[User talk:Muddysteel|talk]]) 16:53, 16 June 2019 (UTC)

== Segmenting page info into current/best practices vs. out-of-date ==

On a per-page basis, it would be helpful to delineate between "current/best practices" and "other" in some manner.

I've been reviewing the Wiki guidelines, FAQs, etc., and do not really see something concrete along these lines.

I'm going to take a stab at this with the [[LIRC]] page: My contribs will be limited to the Linux side of things, as my Windoze systems only exist to support stuff that is windows-only (e.g., URC Remote control editor).

I'll ask for some review/feedback as the effort yields something concrete.

[[User:Muddysteel|Muddysteel]] ([[User talk:Muddysteel|talk]]) 13:45, 18 June 2019 (UTC)

Naming video files/Movies

2019-06-17T13:16:20Z

Muddysteel: Indicate use of the open/close parenthesis '()' vs. open /close bracket '[]' characters. Brackets are Wiki markup.

{{VideoLibraryCreate}}
{{mininav|[[Video library]]|[[Naming video files]]}}

= Introduction =
<section begin="intro" />This page will describe the '''{{Kodi}} best practice''' to name Movie files and create the folder structure to save them in. Your movie folder and files will be placed within your Source folder.<section end="intro" />

The default scraper used by {{kodi}} for '''Movies''' is the TheMovieDB (TMDB). Other scrapers are available and can be found by searching the {{kodi}} site '''''[https://kodi.tv/addons/browse?keyword=&category=1185&author=&sort=title+ASC here]'''''
:'''''See: [https://www.themoviedb.org/ TheMovieDB]'''''
:'''''See: [[Add-on:The_Movie_Database|TheMovieDB Add-on]]'''''
:'''''See: [[Add-on:Universal_Movie_Scraper|Universal Movie Scraper Add-on]]'''''
{{-}}

= Folder & Naming Conventions =
Once the Source has been created on your drive, there are are two options on how to store your movies.

== Movie Folder ==
This is the '''{{Kodi}} best practide''' method for naming and storing movie media. See the two images below.

*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 artwork
*Using this method will provide the safest and most accurate scrape of your media collection.
*If using VIDEO_TS or BDMV folder structure you must enable '''Recursive''' lookup when adding the source directory.

<gallery mode="packed-overlay" widths="600px" heights="350px">
File:Video-Movie Folder File Structure.png|Image 1- Folder structure
File:MovieNaming02.jpg|Image 2- Movie Names
</gallery>

'''Notes:'''
*There is some limited flexibility to correct naming, but not all methods are 100% guaranteed to work.
*Some skins use modified filenaming to display '''''[[Media_flags|Media Flags]]'''''. These apply to the filename, not the folder name. Check the forum of your skin for correct use.

'''Naming'''
*The name used for the folder and video file is the movie name as displayed at TheMovieDB (we are using default TheMovieDB scraper).
*The second image above is a screenshot of the ''Blade Runner 2049'' movie entry at TheMovieDatabase site. The name of the movie folder and video file should match the name displayed at the scraper site, as shown in the two images above.

'''Folder'''
*Inside the Source folder, create a folder named with the movie title
*Movie '''Folder''' names must contain the '''Title''' and should contain the '''Year'''. Although not a strict requirement, the year should be in open/close parenthesis (the '''(''' and ''')''' characters, respectively).

'''File'''
*Within the new movie folder, save the video file
*The setting '''Movies are in separate folders that match the movie title''' which is located in the Set Content settings page of the Source has the following effect:
**If '''Enabled''' {{Kodi}} will use the '''folder''' name to scrape the movie
**If '''Disabled''' {{kodi}} will use the '''filename''' to scrape the movie
*In light of the above, and because many users are unaware or forget this setting, {{Kodi}} recommends naming the movie file the same as the folder name as shown in the example image above
*The '''filename''' can be modified to include '''''[[Media_flags|Media Flags]]'''''

== Filename Only ==
[[File:Video-Movie File Structure.png|400px|right]]

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. See image to right.

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''' and should contain the '''Year'''. Although not a strict requirement, the year should be in parenthesis. It should match the entry at the scraper site as shown in the above images.

There are disadvantages using this method:
*With larger libraries, this method can become untidy and cumbersome to maintain
*If you use nfo files and save local artwork, the folder will become even more cluttered
*Some Artwork add-ons will not work with this method as they require a Movie Folder
*Saving locally stored Artwork will be problematic.
*The option '''Movies are in separate folders that match the movie title''' in the Set Content settings page of the Source does not apply to this method.
{{-}}

== Extra Video Files ==
It is not uncommon to have extra video files that are somehow related to the main movie. Clips such as bloopers, interviews with cast and crew, production methods, behind the scenes, etc.

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

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

'''Requires the use of Movie Folders'''
:{{see|Extras}}

----
'''{{big|{{red|The remainder of this page deals with Special Use cases and can be safely ignored. Most libraries will not require implementing the following additional name extensions.}}}}'''
----

<div style="{{linear-gradient|left|#a1f5e4, #f5f5a1}}">{{next|[[Naming_video_files/TV_shows|'''Naming TV Shows''']]}} </div>

= Stub and Stream Files =
{{main|Media_stubs}}
{{#lst:Media_stubs|intro}}

{{main|Internet_video_and_audio_streams}}
{{#lst:Internet_video_and_audio_streams|intro}}

= Media Tags / Flags =
{{main|Media flags}}

[[File:480.png|50px]] [[File:1080.png|50px]] [[File:720.png|50px]] [[File:1080 n.png|50px]] [[File:480-1.png|50px]]
[[File:Divx.png|80px]] [[File:Xvid.png|80px]] [[File:H264.png|80px]] [[File:Bluray.png|80px]] [[File:Dvd.png|80px]] [[File:Avc1.png|80px]]
[[File:1.33.png|50px]] [[File:1.66.png|50px]] [[File:2.20.png|50px]] [[File:2.35.png|50px]]

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

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

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

Example- note that movie folders are used, and the folder is simply named while the filename has been modified with extensions.
{| class="prettytable"
|-
! scope="row" ! style="width:400px; background-color:#ffffcc; text-align:left;"| ...\Paul (2011)\Paul (2011).4K.HDR.Atmos.mkv
|}

== 3D movies ==
{{Main|3D}}
Some 3D movies might need an additional file name extension to be identified by Kodi as a 3D movie. See '''[[3D]]''' for details on that additional extension, and when it is needed.

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

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

Two options to overcome this issue:
#Combine both movie files into a single movie file.
#Leave them as Split Video Files, but allow Kodi to combine them into the one library entry (kodi does not combine the actual movie files)

To use this function the following steps are required:
#The setting '''Combine split video items''' must be enabled in the Settings menu. '''''See: [[Settings/Media/Videos#Files|Settings>Media>Files]]'''''
#Modify the movie file names, as described below, so that Kodi recognises them as Split Video Files
#Can only be used with the '''Movie Folder & Filename''' method described above

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

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

The following are default stacking extensions that can be added to file names.
[[File:Video-Movie FolderStacking.png|600px|right]]

{| class="prettytable"
|-
! colspan="7" style="background-color:#ffffcc;" | # = 1 thru 9 OR A thru D. No space.
|-
! scope="row" ! style="width:100px; text-align:left;"| Default Stacking Extensions
|style="width:50px; text-align:left;"|part#
|style="width:50px; text-align:left;"|cd#
|style="width:50px; text-align:left;"|dvd#
|style="width:50px; text-align:left;"|pt#
|style="width:50px; text-align:left;"|disk#
|style="width:50px; text-align:left;"|disc#
|-
! colspan="7" style="background-color:#ffffcc;" | # = A thru D. No space.
|-
! scope="row" ! style="width:100px; text-align:left;"| Default Stacking Extensions
| colspan="7" |moviename'''#'''.ext 
eg. 
e:\Movies 1\Lucy (2014)A.mkv 
e:\Movies 1\Lucy (2014)B.mkv
|}

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

{| class="prettytable"
|-
! colspan="5" style="background-color:#ffffcc;" | # = 1 thru 9. No space.
|-
! scope="row" ! style="width:100px; text-align:left;"| Default Stacking Extensions
|style="width:50px; text-align:left;"|cd#
|style="width:50px; text-align:left;"|dvd#
|style="width:50px; text-align:left;"|disk#
|style="width:50px; text-align:left;"|disc#
|}

== Advanced Stacking Options ==
File stacking can be fine-tuned by the user to match obscure cases using the '''[[Advancedsettings.xml#moviestacking|<moviestacking>]]''' and '''[[Advancedsettings.xml#folderstacking|<folderstacking>]]''' advancedsettings.xml settings.

{{top}}

<div style="{{linear-gradient|left|#a1f5e4, #f5f5a1}}">{{next|[[Naming_video_files/TV_shows|'''Naming TV Shows''']]}} </div>

{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:How-to]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:General topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

2019-06-15T20:39:49Z

Muddysteel:

Template:Tip

2019-06-15T20:39:22Z

Muddysteel:

{{#if: {{{1|}}}|<table cellspacing="0" cellpadding="0" border="0" style="background: transparent;"><tr><td nowrap="nowrap" valign="top">}}[[File:Light bulb icon tips.png|18px|Tip|link=]] '''Tip''':{{#if: {{{1|}}}|</td><td valign="top" style="padding-left:0.5em;">{{{1|}}}</td></tr></table>}}<noinclude>
== Usage ==

=== Method 1 ===
The following displays the tip icon, the word 'Tip' followed by whatever text, images, etc. you like:

This is a paragraph with the <nowiki>{{tip}}</nowiki> big inline tip. And whatever else goes there.

will render as:

This is a paragraph with the {{tip}} big inline tip. And whatever else goes there.

=== Method 2 ===
The following will render the tip into its own block:

This is a paragraph with the <nowiki>{{tip|big tip in its own block}}</nowiki>. And whatever else goes there.

will render as:

This is a paragraph with the {{tip|big tip in its own block}}. And whatever else goes there.

</noinclude>

Template:Tip

2019-06-15T20:38:50Z

Muddysteel:

{{#if: {{{1|}}}|<table cellspacing="0" cellpadding="0" border="0" style="background: transparent;"><tr><td nowrap="nowrap" valign="top">}}[[File:Light bulb icon tips.png|18px|Tip|link=]] '''Tip''':{{#if: {{{1|}}}|</td><td valign="top" style="padding-left:0.5em;">{{{1|}}}</td></tr></table>}}<noinclude>
== Usage ==

=== Method 1 ===
The following displays the tip icon, the word 'Tip' followed by whatever text, images, etc. you like:

This is a paragraph with the <nowiki>{{tip}}</nowiki> big inline tip. And whatever else goes there.

will render as:

This is a paragraph with the {{tip}} big inline tip. And whatever else goes there.

=== Method 2 ===
The following will render the tip into its own block:

This is a paragraph with the <nowiki>{{tip|big tip in its own block}}</nowiki>. And whatever else goes there.

will render as:

This is a paragraph with the {{tip|big tip in its own block}}. And whatever else goes there.

</noinclude>

Template:Tip

2019-06-15T20:38:17Z

Muddysteel:

{{#if: {{{1|}}}|<table cellspacing="0" cellpadding="0" border="0" style="background: transparent;"><tr><td nowrap="nowrap" valign="top">}}[[File:Light bulb icon tips.png|18px|Tip|link=]] '''Tip''':{{#if: {{{1|}}}|</td><td valign="top" style="padding-left:0.5em;">{{{1|}}}</td></tr></table>}}<noinclude>
== Usage ==

=== Method 1 ===
The following displays the tip icon, the word 'Tip' followed by whatever text, images, etc. you like:

This is a paragraph with the <nowiki>{{tip}}</nowiki> big iline tip. And whatever else goes there.

will render as:

This is a paragraph with the {{tip}} big inline tip. And whatever else goes there.

=== Method 2 ===
The following will render the tip into its own block:

This is a paragraph with the <nowiki>{{tip|big tip in its own block}}</nowiki>. And whatever else goes there.

will render as:

This is a paragraph with the {{tip|big tip in its own block}}. And whatever else goes there.

</noinclude>

Template:Tip

2019-06-15T20:38:02Z

Muddysteel:

{{#if: {{{1|}}}|<table cellspacing="0" cellpadding="0" border="1" style="background: transparent;"><tr><td nowrap="nowrap" valign="top">}}[[File:Light bulb icon tips.png|18px|Tip|link=]] '''Tip''':{{#if: {{{1|}}}|</td><td valign="top" style="padding-left:0.5em;">{{{1|}}}</td></tr></table>}}<noinclude>
== Usage ==

=== Method 1 ===
The following displays the tip icon, the word 'Tip' followed by whatever text, images, etc. you like:

This is a paragraph with the <nowiki>{{tip}}</nowiki> big iline tip. And whatever else goes there.

will render as:

This is a paragraph with the {{tip}} big inline tip. And whatever else goes there.

=== Method 2 ===
The following will render the tip into its own block:

This is a paragraph with the <nowiki>{{tip|big tip in its own block}}</nowiki>. And whatever else goes there.

will render as:

This is a paragraph with the {{tip|big tip in its own block}}. And whatever else goes there.

</noinclude>

Template:Tip

2019-06-15T20:33:35Z

Muddysteel:

{{#if: {{{1|}}}|<table cellspacing="0" cellpadding="0" border="0" style="background: transparent;"><tr><td nowrap="nowrap" valign="top">}}[[File:Light bulb icon tips.png|18px|Tip|link=]] '''Tip''': {{#if: {{{1|}}}|</td><td valign="top" style="padding-left:0.5em;">{{{1|}}}</td></tr></table>}}<noinclude>
== Usage ==

=== Method 1 ===
The following displays the tip icon, the word 'Tip' followed by whatever text, images, etc. you like:

This is a paragraph with the <nowiki>{{tip}}</nowiki> big iline tip. And whatever else goes there.

will render as:

This is a paragraph with the {{tip}} big inline tip. And whatever else goes there.

=== Method 2 ===
The following will render the tip into its own block:

This is a paragraph with the <nowiki>{{tip|big tip in its own block}}</nowiki>. And whatever else goes there.

will render as:

This is a paragraph with the {{tip|big tip in its own block}}. And whatever else goes there.

</noinclude>