Difference between revisions of "Add-on:The TVDB v4"

From Official Kodi Wiki
Jump to navigation Jump to search
(Add Flexible Orders)
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|provider-name=TVDB Team
|provider-name=TVDB Team
|ID=metadata.tvshows.thetvdb.com.v4.python
|ID=metadata.tvshows.thetvdb.com.v4.python
|latest-version=1.0.16
|latest-version=1.1.0
|extension point=xbmc.metadata.scraper.tvshows
|extension point=xbmc.metadata.scraper.tvshows
|provides=
|provides=
Line 17: Line 17:
|broken=
|broken=
|icon url=http://mirrors.kodi.tv/addons/matrix/metadata.tvshows.thetvdb.com.v4.python/media/icon.png}}
|icon url=http://mirrors.kodi.tv/addons/matrix/metadata.tvshows.thetvdb.com.v4.python/media/icon.png}}




Line 32: Line 30:


= Settings =
= Settings =
Scraper settings can be adjusted in two locations, each location having a different result. When adjusting the settings be mindful of where:
{{#lst:Add-on:The_Movie_Database_Python|ScraperSettings}}
 
;Settings>Add-ons>Information Providers>TV Shows
:Scrapers are installed with default settings. Adjusting settings in this location sets the new '''default''' settings for your scraper. From this point on any source you change to use this scraper will use the new default settings. '''Existing sources are not changed'''
:If an existing source is already using this scraper, and you would like the new settings to take effect, change the source to use another scraper, save and answer no to updating the library. Then change the scraper back and the new default settings will be loaded for the source. Alternatively, use the next method.
 
;Videos>Files>Source>Context Menu>Change Source>Settings
:Changing settings at the source will affect that source only.
 
 
'''Note:''' Changing scraper settings '''does not''' change the metadata or artwork already in your library. Only items scraped after the setting changes will be affected.






== General ==
== General ==
<gallery mode="packed" widths="500px" heights="293px">
[[File:TVDBv4-Settings01.jpg|700px]]
File:TVDBv4-Settings01.jpg|Image 1- General Settings
File:TVDBv4-Settings02.jpg|Image 2- Season Order Type
File:TVDBv4-Settings03.jpg|Image 3- Matching Season Order Type at TheTVDB
</gallery>




Line 58: Line 42:


; Season Type
; Season Type
: TV Shows may have more than one order for seasons and episodes. eg, the DVD release may have a different order to original Aired Order. eg (Firefly, Money Heist)
: See next section ''Flexible Orders''
: TheTVDB allows for up to 6 different Orders as follows:
 
:: Standard Orders
::: * Default (Aired Order) - the primary order for the episodes of the TV show
::: * Absolute - Absolute ordering places all episodes in a single ordered season. This is generally used for anime.
::: * DVD - Used if the DVD/Bluray release uses a different order to the default order
 
:: Flexible Orders
::: * Alternate - The first available flexible order
::: * Regional - The second available flexible order
::: * Alternate DVD - The third available flexible order
: To use one of the Flexible Orders, select the Order Type in box 1 <small>(image 3)</small> and match the Order name in box 2 <small>(image 3)</small> with the Season Type in {{kodi}} <small>(image 2)</small>.
 
:'''Note:''' Not all order types are available for each TV Show. Check the available orders for your show at TheTVDB


; Gender
; Gender
Line 82: Line 52:
; PIN
; PIN
: Enter an optional TheTVDB subscriber PIN. Future extended functionality within this plugin may benefit from being a TheTVDB subscriber, which grants you a unique PIN to use within all of your TheTVDB-connected systems.  This is not required for the functionality most users would expect, but it does help support TheTVDB as a free resource.
: Enter an optional TheTVDB subscriber PIN. Future extended functionality within this plugin may benefit from being a TheTVDB subscriber, which grants you a unique PIN to use within all of your TheTVDB-connected systems.  This is not required for the functionality most users would expect, but it does help support TheTVDB as a free resource.
= Flexible Orders =
<gallery mode="packed" widths="500px" heights="293px">
File:TVDBv4-Settings03.jpg|Image 3- Check Season Order Type at TheTVDB
File:TVDBv4-Settings01.jpg|Image 1- General Settings
File:TVDBv4-Settings02.jpg|Image 2- Season Order Type
</gallery>
Some TV Shows are originally broadcast in one order (default order) but the order may be different when broadcasting in a different country (La Casa De Papel), or the DVD/Bluray release may have a different screening order (Firefly).
TheTVDB allows for up to 6 different Orders as follows:
: Standard Orders
:: * Default (Aired Order) - the primary order for the episodes of the TV show
:: * Absolute - Absolute ordering places all episodes in a single ordered season. This is generally used for anime.
:: * DVD - Used if the DVD/Bluray release uses a different order to the default order
: Flexible Orders
:: * Alternate - The first available flexible order
:: * Regional - The second available flexible order
:: * Alternate DVD - The third available flexible order
To use one of the Flexible Orders:
# Locate the TV show at TheTVDB and confirm that Flexible Orders are available (box 1, image 1)
# Confirm which order you require and ensure it matches your episode files
# Note the order name used by the API (box 2, image 1)
# In the scraper settings, select the same order (image 2 & 3). Change scraper settings using method 3 detailed above in ''Settings''
# Scrape as per normal.
:'''Note:''' Not all order types are available for each TV Show. Check the available orders for your show at TheTVDB




Line 93: Line 96:
; I mess up my scrape because I forget to change the Season Type from the previous scrape
; I mess up my scrape because I forget to change the Season Type from the previous scrape
: Leave the Source settings with the default settings, which you would use for most scrapes. For the shows requiring a different order, drill down to the TV show folder, and change the scraper setting for the individual TV show by selecting ''Change content'' from the context menu.
: Leave the Source settings with the default settings, which you would use for most scrapes. For the shows requiring a different order, drill down to the TV show folder, and change the scraper setting for the individual TV show by selecting ''Change content'' from the context menu.





Latest revision as of 00:52, 25 May 2022

The TVDB v4

See this add-on on the kodi.tv showcase

Author: TVDB Team

Type: TV information
Repo: Kodi.tv repo v20
Kodi.tv repo v19

License: GPL-3.0-or-later

Summary: Fetch TV show metadata from TheTVDB.com
Home icon grey.png   ▶ Add-ons ▶ The TVDB v4

TheTVDB.com is a TV Scraper. The site is a massive open database that can be modified by anybody and contains full meta data for many shows in different languages. All content and images on the site have been contributed by their users for users and have a high standard or quality. The database schema and website are open source under the GPL.

1 Installing

This add-on is installed from the Add-on browser located in Kodi as follows:

  1. Settings
  2. Add-ons
  3. Install from repository
  4. Information providers (v16 and higher)
  5. TV information
  6. The TVDB v4
  7. Install


2 Introduction

TheTVDB v4 is the latest scraper developed by TheTVDB Team. It is written in Python and accesses the new v4 of the TheTVDB API.

This scraper is intended to replace all other scrapers that currently utilise TheTVDB site. It is expected that v1, v2 and v3 of TheTVDB API will be shutdown by then end of 2022, rendering the existing TheTVDB scrapers as broken.

TheTVDB v4 scraper accesses the following site to scrape your TV Shows, seasons and episodes:


3 Settings

Scraper settings can be adjusted in three locations, each location having a different result. When adjusting the settings be mindful of where:

1. Kodi System Settings ▶ Add-ons ▶ Information Providers ▶ (Select Scraper)
Scrapers are installed with default settings. Adjusting settings in this location sets the new default settings for your scraper. From this point on any source you change to use this scraper will use the new default settings. Existing sources are not changed
If an existing source is already using this scraper, and you would like the new settings to take effect, change the source to use another scraper, save and answer no to updating the library. Then change the scraper back and the new default settings will be loaded for the source. Alternatively, use the next method.
2. Videos ▶ Files ▶ Source ▶ Context Menu ▶ Change Content ▶ Settings
Changing settings at the source will affect that source only.
3. Videos ▶ Files ▶ Source ▶ Movie/TV Show folder ▶ Context Menu ▶ Change Content ▶ Settings
Changing settings on the folder containing a movie or TV show will affect only that movie or TV show.


Note: Changing scraper settings does not change the metadata or artwork already in your library. Only items scraped after the setting changes will be affected.


3.1 General

TVDBv4-Settings01.jpg


Language
Set which language of metadata to scrape. If the selected language is not available for a TV show, it will fall back to English.
Season Type
See next section Flexible Orders
Gender
Please provide the gender of the primary user of this information. TheTVDB collects basic demographic information that we anonymize and combine to track worldwide TV and movie popularity. We provide this summarized information to partners in the entertainment space to help influence the production and licensing of content.
Birth Year
Please provide the birth year of the primary user of this information. TheTVDB collects basic demographic information that we anonymize and combine to track worldwide TV and movie popularity. We provide this summarized information to partners in the entertainment space to help influence the production and licensing of content.
PIN
Enter an optional TheTVDB subscriber PIN. Future extended functionality within this plugin may benefit from being a TheTVDB subscriber, which grants you a unique PIN to use within all of your TheTVDB-connected systems. This is not required for the functionality most users would expect, but it does help support TheTVDB as a free resource.


4 Flexible Orders


Some TV Shows are originally broadcast in one order (default order) but the order may be different when broadcasting in a different country (La Casa De Papel), or the DVD/Bluray release may have a different screening order (Firefly).

TheTVDB allows for up to 6 different Orders as follows:

Standard Orders
* Default (Aired Order) - the primary order for the episodes of the TV show
* Absolute - Absolute ordering places all episodes in a single ordered season. This is generally used for anime.
* DVD - Used if the DVD/Bluray release uses a different order to the default order
Flexible Orders
* Alternate - The first available flexible order
* Regional - The second available flexible order
* Alternate DVD - The third available flexible order

To use one of the Flexible Orders:

  1. Locate the TV show at TheTVDB and confirm that Flexible Orders are available (box 1, image 1)
  2. Confirm which order you require and ensure it matches your episode files
  3. Note the order name used by the API (box 2, image 1)
  4. In the scraper settings, select the same order (image 2 & 3). Change scraper settings using method 3 detailed above in Settings
  5. Scrape as per normal.
Note: Not all order types are available for each TV Show. Check the available orders for your show at TheTVDB


5 Troubleshooting

Having problems? Check these common problems and solutions

No seasons or episodes are scraped, or are partially scraped
Normally caused by setting an episode order in the scraper that is not available at TheTVDB. Check the Season Type setting, and select an order that is available at TheTVDB.
I mess up my scrape because I forget to change the Season Type from the previous scrape
Leave the Source settings with the default settings, which you would use for most scrapes. For the shows requiring a different order, drill down to the TV show folder, and change the scraper setting for the individual TV show by selecting Change content from the context menu.


Return to top