Skip to content

Latest commit

 

History

History
97 lines (80 loc) · 4.31 KB

TVDb-Builders.md

File metadata and controls

97 lines (80 loc) · 4.31 KB
Raw

You can build different collections using the features of TheTVDb.com (TVDb).

No configuration is required for these builders.

Name Attribute Description Works with Movies Works with Shows
TVDb List tvdb_list Gets every show in a TVDb List or TVDb Userlist ✔️ ✔️
TVDb List Details tvdb_list_details Gets every show in a TVDb List or TVDb Userlist and updates the collection summary with the TVDb list description ✔️ ✔️
TVDb Show tvdb_show Gets the series specified ❌ ✔️
TVDb Show Details tvdb_show_details Gets the series specified and updates the collection with the summary, poster, and background from the TVDb series ❌ ✔️
TVDb Movie tvdb_movie Gets the movie specified ✔️ ❌
TVDb Movie Details tvdb_movie_details Gets the movie specified and updates the collection with the summary, poster, and background from the TVDb movie ✔️ ❌

TVDb List

Gets every show 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.

collections:
  Arrowverse:
    tvdb_list: https://www.thetvdb.com/lists/arrowverse
collections:
  Saved by the Bell:
    tvdb_list: https://www.thetvdb.com/lists/6957
  • You can update the collection details with the TVDb list's description 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

TVDb Show

Gets 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

Gets 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