wiki:Plugins/series
Last modified 4 months ago Last modified on 01/10/12 22:19:33

Series

Intelligent filter for TV-series.

Features

  • Episode tracking, no duplicate downloads
  • Plenty of quality options
  • Timeframe, get best quality in given timeframe
  • Episode advancement (for season, episode).
  • Proper & Repack aware
  • Specials aware (grabs episodes with the series title and the word 'special')
  • Tries to ignore season packs, you can use content_size for extra insurance against them.

Simple configuration:

series:
  - some series
  - another series

If some series and another series have understandable episode numbering any given episode is downloaded only once. FlexGet should support all known episode numbering schemes without any configuration, including dates.

So if we get same episode twice:

  • Some.Series.S2E10.720p.x264-FlexGet
  • Some.Series.S2E10.HR.x264-FooBar

Only one of them is downloaded, with default configuration best quality is chosen.

Related plugins

These plugins are complementary to the series plugin.

Settings

The series plugin supports a number of settings to customize it's behavior.

OptionDescription
qualityRequired quality.
min_qualityAccept only qualities equal or above this.
max_qualityAccept only qualities equal or below this.
qualitiesDownload all listed qualities when they become available.
upgradeKeeps getting the better qualities as they become available.
timeframeWait given amount of time for specified quality to become available, after that fall back to best so far.
pathSet path field for this series.
setUse set plugin to set any fields for this series.
exactConfigure exact matching behavior. Needed for series which have similar named series. Uses 'auto' mode as default.
from_groupsAccept series only from given groups.
identified_byConfigure how episode numbering is detected. Uses 'auto' mode as default.
propersConfigure how propers are handled.
watchedManually specify minimum season and episode from where to continue.
name_regexpManually specify regexp(s) that matches to series name.
ep_regexpManually specify regexp(s) that matches to episode, season numbering.
id_regexpManually specify regexp(s) that matches to series identifier (numbering).

All settings can be applied in either of the formats.

How to configure settings per series
How to configure settings with groups

Notes

  • If the series appears in feed(s) with slightly different naming conventions and spinoffs like FooBar and FooBar US read this guide.
  • FlexGet respects propers which means that the same episode will be downloaded twice if the second one contains words such as proper, repack, rerip, or real.
  • If series name is written in multiple different ways, don't add them as separate series. This will confuse episode tracking.
  • Check series cookbook for more complete examples and advanced uses.

Commandline Arguments

The series plugin provides following commandline arguments.

--series

Display series summary. To get more details from any listed series you can use --series <name>.

--series-forget

Delete episodes from database or whole series completely.

To delete single episode, use:

--series-forget <name> <id>

To delete whole series, use:

--series-forget <name>

--disable-advancement

If episode advancement is causing problems downloading latest episode due large gap in the series history, you can use this option to disable advancement enforcement temporarily.

--stop-waiting

Stops timeframe for given name, thus downloading any episode that is currently pending in the timeframe.