Plex-Meta-Manager/docs/metadata/builders/tvdb.md
2022-12-19 16:36:51 -05:00

5.9 KiB

TVDb Builders

You can find items using the features of TheTVDb.com (TVDb).

No configuration is required for these builders.

Attribute Description Works with Movies Works with Shows Works with Playlists and Custom Sort
tvdb_list Finds every item in a TVDb List or TVDb Userlist
tvdb_list_details Finds every item in a TVDb List or TVDb Userlist and updates the collection summary and poster with the TVDb list metadata
tvdb_show Finds the series specified
tvdb_show_details Finds the series specified and updates the collection with the summary, poster, and background from the TVDb series
tvdb_movie Finds the movie specified
tvdb_movie_details Finds the movie specified and updates the collection with the summary, poster, and background from the TVDb movie

TVDb List

Finds every item in a TVDb List or TVDb Userlist

The expected input is a TVDb List URL or TVDb Userlist URL. Multiple values are supported as either a list or a comma-separated string.

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Arrowverse:
    tvdb_list: https://www.thetvdb.com/lists/arrowverse
    collection_order: custom
    sync_mode: sync
collections:
  Saved by the Bell:
    tvdb_list: https://www.thetvdb.com/lists/6957
    collection_order: custom
    sync_mode: sync
  • You can update the collection details with the TVDb list's description and poster by using tvdb_list_details.
  • You can specify multiple lists in tvdb_list_details but it will only use the first one to update the collection details.
collections:
  Arrowverse:
    tvdb_list_details: https://www.thetvdb.com/lists/arrowverse
    collection_order: custom
    sync_mode: sync

TVDb Show

Finds the show specified

The expected input is a TVDb Series ID or TVDb Series URL. Multiple values are supported as either a list or a comma-separated string.

collections:
  Star Wars (Animated Shows):
    tvdb_show: 83268, 283468
collections:
  Star Wars (Animated Shows):
    tvdb_show:
      - https://www.thetvdb.com/series/star-wars-the-clone-wars
      - https://www.thetvdb.com/series/star-wars-rebels
  • You can update the collection details with the TVDb show's summary, poster, and background by using tvdb_show_details.
  • You can specify multiple shows in tvdb_show_details but it will only use the first one to update the collection details.
  • Posters and background in the library's asset directory will be used over the collection details unless tvdb_poster/tvdb_background is also specified.
collections:
  Star Wars (Animated Shows):
    tvdb_show_details: 83268, 283468

TVDb Movie

Finds the movie specified

The expected input is a TVDb Movie ID or TVDb Movie URL. Multiple values are supported as either a list or a comma-separated string.

collections:
  The Lord of the Rings:
    tvdb_movie: 107, 157, 74
collections:
  The Lord of the Rings:
    tvdb_movie:
      - https://www.thetvdb.com/movies/the-lord-of-the-rings-the-fellowship-of-the-ring
      - https://www.thetvdb.com/movies/the-lord-of-the-rings-the-two-towers
      - https://www.thetvdb.com/movies/the-lord-of-the-rings-the-return-of-the-king
  • You can update the collection details with the TVDb movie's summary, poster, and background by using tvdb_movie_details.
  • You can specify multiple movies in tvdb_movie_details but it will only use the first one to update the collection details.
  • Posters and background in the library's asset directory will be used over the collection details unless tvdb_poster/tvdb_background is also specified.
collections:
  The Lord of the Rings:
    tvdb_movie_details:
      - https://www.thetvdb.com/movies/the-lord-of-the-rings-the-fellowship-of-the-ring
      - https://www.thetvdb.com/movies/the-lord-of-the-rings-the-two-towers
      - https://www.thetvdb.com/movies/the-lord-of-the-rings-the-return-of-the-king