mirror
/
Radarr
mirror of https://github.com/Radarr/Radarr
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Custom Formats (markdown)

RhinoRhys 2020-05-09 08:30:19 +01:00
parent 41d545107d
commit 1bfe8f2338
1 changed files with 23 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
Custom-Formats.md

@ -1,24 +1,27 @@
# Table of Contents
## v2 or v3
This article is written for the v2 iteration of Custom Formats. As Custom formats have been reworked significantly in V3 (Aphrodite), a separate wiki page [here](https://github.com/Radarr/Radarr/wiki/Custom-Formats-Aphrodite/) has been created for information relevant to the V3 version, however, the Matching section below is still valid.
# Table of Contents
### [1. Custom Formats](#custom-formats)
### [2. Format Tags](#format-tags)
### [3. Matching](#matching)
### [4. Templates](#templates)
### [5. How To Apply](#how-to-apply)
# Custom Formats
Custom Formats are a way to completely automate anything. They work similar to Qualities: Releases and Files are parsed like always, however, now Radarr also checks if one or more of your Custom Formats might also match against the Release or File name. Quality remains as the primary deciding factor when grabbing a release and Custom Formats work secondary to this. At an equal Quality, the preferred release will have the most highest ranking Custom Format matches from the Formats allowed in the profile settings. Upgrading stops when at least one Custom Format match is above the profile cutoff.
Custom Formats allow you to extract additional information about releases and automate the decision process to not only grab releases with better attributes but also avoid grabbing or outright reject releases that are not up to standard. While the Quality scale still outranks Custom Formats, at an equal Quality, releases that have the most highest-ranking Custom Format matches will be preferred over those with fewer or lower-ranking matches. In addition to the Quality cutoff, Custom Formats have their own cutoff that applies in the automatic upgrade process. Custom formats are ranked in a list m and upgrading stops when at least one Custom Format match is above the custom format cutoff.
A custom format has so called "Format Tags". These tags describe how Radarr tries to match a release or file. For more information on how exactly Format Tags match, see [Format Tags](#format-tags) and [Matching](#matching).
A custom format is a set of one or more "Format Tags" that Radarr tries to match against the information parsed from a release or file. For more information on how exactly Format Tags match, see [Format Tags](#format-tags) and [Matching](#matching).
# Format Tags
# Format Tags
A Format Tag consists of three parts: The Tag Prefix, the Tag Modifier (optional) and the Tag Value.
Format: PREFIX_MODIFIER_VALUE or PREFIX_VALUE
The Prefix determines what kind of Format Tag this is and against what it matches.
The Prefix determines the type of Format Tag and what it matches against.
The Modifier changes how the matching occurs.
@ -45,7 +48,7 @@ The Value is used for the matching.
| Regex | RX | **CHANGED FROM R TO RX** Is only useful for Edition and Custom Format Tags. Makes it, that Radarr parses the value of the Format Tag as a Regex and uses the Regex for matching. |
| Negate | N | Negates the Format Tag, i.e. when it normally matches it won't and when it normally wouldn't match it does. |
| Required | RQ | **CHANGED FROM RE TO RQ** Makes the Format Tag strongly required. More on that later. |
| Word Matching | W | **NOT YET IMPLEMENTED** Makes the Format Tag only match full words, e.g. C_W_3D would match Movie.3D.1080p, but not Movie3d.1080p. (Only really useful for edition or custom tags. Would be the same as making a \\bword\\b regex.) |
## Format Tags Examples
@ -65,16 +68,21 @@ The Value is used for the matching.
# Matching
How does Radarr decide if a custom format matches a release or not?
Radarr uses the following steps to find the best matching quality or custom format:
1. Go through each custom format and find out which Format Tags match and which don't
2. Discard all custom formats, where an absolutely required Format Tag (_RQ_) does not match
3. Discard all custom formats, where at least one Format Tag of a type is present and none of the tags of this type match. Examples:
* S_Bluray (NO MATCH), R_1080 (MATCH) Will be discarded, since a source tag is present, but none of the source tags match
* S_Bluray (NO MATCH), S_WEBDL (MATCH), R_1080 (MATCH) Will not be discarded, since at least one of the source tags matches
Custom Formats with only one Format Tag are simple; if that Tag matches, the Custom Format matches.
Note that Radarr will try to match releases with all custom formats you created, whether they are checked or unchecked in profiles. Then, if the custom format is checked in profile, matching release will be accepted, if unchecked it will be rejected.
Custom Formats that include more than one Tag are slightly more complicated. Tags of different types are separated into different groups and multiple tags of the same type are placed into the same group. At least one Tag of each type must match for the Custom Format to match.
For example, if you were matching a custom format with the following tags against a 1080p WEB-DL release, despite the Resolution tag matching in both cases:
* S_Bluray (NO MATCH), R_1080 (MATCH) Will be discarded since a Source type tag is present and does not match.
* S_Bluray (NO MATCH), S_WEBDL (MATCH), R_1080 (MATCH) Will be accepted since one of the Source tags matches thus satisfying the whole Source type group.
When two or more tags of the same type are used, the Required modifier (RQ) can be added to make the group matchings more strict. A custom format that contains a Required tag will be discarded if the tag does not match, regardless of if another tag in that same type group matches. Groups with multiple Required tags must satisfy all of them to not be discarded. This can be particularly useful when using multiple Custom type tags looking for different criteria to ensure that all of the tags must match.
Every custom format you create will be scanned and matched against in all of your profiles. If a custom format is checked in the profile settings, matching releases will be considered for download, however, if you uncheck a custom format, any matching releases will be actively rejected in the same way that unchecked Qualities are actively rejected. There is no way to only apply custom formats to certain profiles.
See an example [here](https://github.com/Radarr/Radarr/wiki/How-to-make-sure-Radarr-doesn't-snatch-full-Blu-Rays) with a _bluray_ custom format.
The "None" format will be applied to any releases that do not match with any of your other custom formats. This can be useful for placing higher in the list when used with custom formats that match with attributes you find undesirable, such as hardcoded subs, or when unchecked to reject those odd releases that have slipped through your well-crafted custom format hierarchy.
# Templates
Radarr provides a wide range of predefined templates. They are explained below and sometimes have tips on customizing them.
@ -99,7 +107,7 @@ Radarr provides a wide range of predefined templates. They are explained below a
### Multi Language
**Description:** This custom format can be used as a template to make Radarr upgrade / prefer releases with multiple languages. By default it matches releases that contain either English, French or Both as languages.
**Description:** This custom format can be used as a template to highlight releases with multiple languages. By default it matches releases that contain either English, French or Both as languages.
**Usage:** This format can be easily customized by adding or removing desired languages.