Skip to content
This repository has been archived by the owner on May 18, 2024. It is now read-only.

Version Guides

itsToggle edited this page Feb 8, 2023 · 9 revisions

Basics

Text based values are interpreted as regex definitions, are case-insensitive and use official regex syntax. check out regexr.com to try out your regex definitions, or visit our discord server to see how other people use versions.

Regex Basics:

small list of typical special characters

.     - matches any character
*     - matches zero or more of the preceding character
+     - matches one or more of the preceding character
?     - matches zero or one of the preceding character 
|     - matches either the preceding or the following characters
()    - creates a group 
[0-9] - matches any number
\     - escapes a special character so it's interpreted as text

Here are some examples to help you understand the different special characters:

(2160)(.*)(HDR)       - matches "2160", followed by "anything", followed by "HDR"
(EXTENDED|REMASTERED) - matches either "EXTENDED" or "REMASTERED"
(H?D?.?CAM)           - matches "HD-CAM", "HDCAM", "HD.CAM", "CAM", ...
(S[0-9]+E[0-9]+)      - matches "S", followed by "one or more numbers", followed by "E", followed by "one or more numbers"

Regex Advanced:

Here are some more advanced examples of regex definitions:

(?=.*BLURAY)(?=.*HDR).*   - matches BLURAY and HDR, no matter the order in which they appear e.g. "HDR.BLURAY" and "BLURAY.HDR"
([hx].?265|hevc)(?!.*mkv) - matches "x265","x-265","h265","hevc",... but not if it's followed by "mkv"

Rules:

"Rules" define the quality requirements of your versions. The rules can be either formulated as a requirement or as a preference. The first rule has the highest priority, the last one the lowest.

resolution:

Lets you sort releases by their resolution

Details:

operators:

The possible operators that can be used with this rule

["==", ">=", "<=", "highest", "lowest"]

value:

The unit and format for this rule

unit: None
format: float number (420, 69.69, -1337)

bitrate:

Lets you sort releases by their estimated bitrate. Bitrate is estimated by dividing the total release size by the playtime according to Plex Discover (Plex integration required)

Details:

operators:

The possible operators that can be used with this rule

["==", ">=", "<=", "highest", "lowest"]

value:

The unit and format for this rule

unit: Mbit/s
format: float number (420, 69.69, -1337)

size:

Lets you sort releases by their total size

Details:

operators:

The possible operators that can be used with this rule

["==", ">=", "<=", "highest", "lowest"]

value:

The unit and format for this rule

unit: GB
format: float number (420, 69.69, -1337)

seeders:

Lets you sort releases by their number of seeders. Number of seeders is gathered from the scraper source.

Details:

operators:

The possible operators that can be used with this rule

["==", ">=", "<=", "highest", "lowest"]

value:

The unit and format for this rule

unit: None
format: float number (420, 69.69, -1337)

title:

Lets you sort releases by performing regex searches on the release title

Details:

operators:

The possible operators that can be used with this rule

["==", "include", "exclude"]

value:

The unit and format for this rule

unit: None
format: regex definition (see Basics chapter)

source:

Lets you sort releases by performing regex searches on their scraper source (e.g. rarbg, jackett: torrentgalaxy, jackett: rutorrent, etc)

Details:

operators:

The possible operators that can be used with this rule

["==", "include", "exclude"]

value:

The unit and format for this rule

unit: None
format: regex definition (see Basics chapter)

cache status:

Lets you sort releases by their cache status on your debrid services

Details:

operators:

The possible operators that can be used with this rule

["cached", "uncached"]

file names:

Lets you sort releases by performing regex searches on the individual release files (realdebrid integration required)

Details:

operators:

The possible operators that can be used with this rule

["include", "exclude"]

value:

The unit and format for this rule

unit: None
format: regex definition (see Basics chapter)

file sizes:

Lets you sort releases by the size of the individual release files (realdebrid integration required)

Details:

operators:

The possible operators that can be used with this rule

["all files >=", "all files <=", "video files >=", "video files <="]

value:

The unit and format for this rule

unit: GB
format: float number (420, 69.69, -1337)

Triggers:

"Triggers" define when plex_debrid should look for a version. You can add triggers that limit a version to a specific media type, or to specific movies/shows. You can define how many times plex_debrid should attempt to download a version and how many attempts should be made with other versions, before a version is attempted to be downloaded. Other triggers can limit a version to a specific genre or can limit a version to a specific user that requested the movie/show.

retries:

Lets you define a minimum and maximum number of retries for your version. Defining a minimum number of retries lets you search for versions sequentially in 30 minute intervals. The retry counter for a given media item only goes up, if one or more versions has unsuccessfully searched for this media item.

Details:

operators:

The possible operators that can be used with this rule

["==",">=", "<="]

value:

The unit and format for this rule

unit: None
format: larger than 0 float number (420, 69.69)

airtime_offset:

Lets you define an offset to the original airtime of an episode/movie for this version. With this you can start scraping earlier or later than the offical air time gathered from Plex Discover or Trakt

Details:

operators:

The possible operators that can be used with this rule

["=="]

value:

The unit and format for this rule

unit: hours
format: float number (420, 69.69, -1337), positive value delays scraping, negative value advances scraping.

year:

Lets you define that this version should only apply to media items from a specific year.

Details:

operators:

The possible operators that can be used with this rule

["==",">=", "<="]

value:

The unit and format for this rule

unit: None
format: float number (420, 69.69, -1337)

media type:

Lets you define that this version should only apply to media items from a specific media type (movies or shows).

Details:

operators:

The possible operators that can be used with this rule

["all", "movies", "shows"]

title:

Lets you define that this version should only apply to media items whos title matches a defined regex. This lets you exclude specifc shows/movies from a version.

Details:

operators:

The possible operators that can be used with this rule

["==", "include", "exclude"]

value:

The unit and format for this rule

unit: None
format: regex definition (see Basics chapter)

user:

Lets you define that this version should only apply to media items which have been requested/watchlisted by specified users. This lets you define versions that only apply to the admin user / invited friends.

Details:

operators:

The possible operators that can be used with this rule

["==", "include", "exclude"]

value:

The unit and format for this rule

unit: None
format: regex definition (see Basics chapter)

genre:

Lets you define that this version should only apply to media items of a specific genre.

Details:

operators:

The possible operators that can be used with this rule

["==", "include", "exclude"]

value:

The unit and format for this rule

unit: None
format: regex definition (see Basics chapter)

scraper sources:

Lets you define which of your active scraper sources should be used for this version. You can define multiple scraper source triggers to scrape your source selections sequentially.

Details:

operators:

The possible operators that can be used with this rule

["==", "include", "exclude"]

value:

The unit and format for this rule

unit: None
format: regex definition (see Basics chapter)

example:

Example: You only want to scrape Jackett and 1337x, if rarbg didn't return any release:

B) scraper source  requirement  :  include  rarbg
C) scraper source  requirement  :  include  (jackett|1337x)

scraping adjustment:

Lets you define multiple adjustments to the way plex_debrid scrapes your media. The current options are "add text before title" and "add text after title". This lets you scrape for multiple, specific uploaders in the defined order for example.

Details:

operators:

The possible operators that can be used with this rule

["add text before title", "add text after title"]

value:

The unit and format for this rule

unit: None
format: None

example:

Example: You want to scrape using the uploader [SubsPlease] first, and if that doesnt return any releases you want to scrape the uploader [Shit]:

B) scraping adjustment  requirement  :  add text before title  [SubsPlease]
C) scraping adjustment  requirement  :  add text before title  [Shit]