Skip to content

Latest commit

 

History

History
93 lines (77 loc) · 2.58 KB

configure_series.md

File metadata and controls

93 lines (77 loc) · 2.58 KB
Raw
title description published date tags editor dateCreated
configure_series
true
2023-01-30 03:03:47 UTC
markdown
2022-09-18 05:02:52 UTC

Configure series

Generates series plugin configuration from titles produced by any input. Using this doesn't prevent configuring series plugin additionally.

Commonly used with:

Syntax

configure_series:
  [settings]:
    # any series option
    # e.g. quality, timeframe etc
  from:
    # any input(s)

Settings

You can use any of the settings for the series plugin within the 'settings' block in configure_series. This section is optional, but if included, the settings will be applied to every show configured.

NOTE: If you need to set different options for individual series, you can do so using the series plugin alongside configure_series as shown in this recipe.

From

In this section you must include one or more configured input plugins. The titles of the entries created by this plugin will be used as the names of the series that you desire.

Examples

Filesystem

Let's say you have a directory where all your series are stored in each in the own folder. Something like:

/media/series/pioneer one/
/media/series/south park/

To automatically configure series plugin with all these you could do following:

configure_series:
  settings:
    quality: 720p
  from:
    filesystem:
      - /media/series/

This will make adding new series easy too, just create new directory there :)

TheTVDB list

configure_series:
  from:
    thetvdb_list:
      username: <username>
      account_id: <account identifier>
  settings:
    timeframe: 12 hours
    target: 720p
    propers: 3 days

Cross-task settings

You can store settings with set and configure_series_<option> to be reused on other tasks

task1:
  trakt_list:
    account: <trakt account>
    list: <trakt list>
    type: shows
    strip_dates: yes
  set:
    # Strip non-alphanumeric characters from title and add as an alternate_title during configure_series
    configure_series_alternate_name: "{{trakt_series_name|d(title)|re_replace('[^\\w\\s]',''}}"
  list_add:
    - entry-list: my-list

task2:
  configure_series:
    # Series will be configured with a symbol-less alternate_title defined
    from: my-list