Mirrors/Radarr
1
0
Fork 0
mirror of https://github.com/Radarr/Radarr.git synced 2024-10-02 06:07:19 +02:00
Code Issues Releases Wiki Activity

Updated Custom Formats (markdown)

Leonardo Galli 2018-05-13 22:31:52 +02:00
parent e504063c7b
commit cb51896039
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Custom-Formats.md

@ -1,7 +1,7 @@
# Table of Contents
### [1. Custom Formats](#custom-formats)
### [2. Quality Tags](#quality-tags)
### [2. Format Tags](#format-tags)
### [3. Matching](#matching)
### [4. Examples](#examples)
@ -14,21 +14,21 @@ Custom formats are a way for you to create your own "Qualities". They work very
A custom format has 2 parts:
* **Parent:** The parent is used as a safeguard. It describes which quality is most similar to a custom format. If you want to create a custom format for directors cut for example, you would probably make a custom Remux-1080p format and set the parent to be Remux-1080p. The parent must be an existing quality!
* **Quality Tags:** These tags describe how Radarr tries to match a release or file. When parsing a release or filename, Radarr will go through all existing qualities and custom formats. It will then assign whichever quality or format has the most matching quality tags. For more information on how exactly quality tags match, see [Quality Tags](#quality-tags) and [Matching](#matching).
* **Format Tags:** These tags describe how Radarr tries to match a release or file. When parsing a release or filename, Radarr will go through all existing qualities and custom formats. It will then assign whichever quality or format has the most matching Format Tags. For more information on how exactly Format Tags match, see [Format Tags](#quality-tags) and [Matching](#matching).
# Quality Tags
# Format Tags
A Quality Tag consists of three parts: The Tag Prefix, the Tag Modifier (optional) and the Tag Value.
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 Quality Tag this is and against what it matches.
The Prefix determines what kind of Format Tag this is and against what it matches.
The Modifier changes how the matching occurs.
The Value is used for the matching.
## Quality Tag Types
## Format Tag Types
| Name | Tag Prefix | Possible Values / Examples | Notes |
|-------|-----------|------|---|
@ -40,17 +40,17 @@ The Value is used for the matching.
| Edition | E_ | E_Director, E_theatrical, E_EXTENDED, ... | This tag is matched against any Editions Radarr may parse. You can put any value after E_ and Radarr will try to match that against what it parsed (case-insensitive). |
| Custom | C_ | C_Surround, C_YIFI, C_-Framestor, C_h264, ... | This tag is matched against the whole release name (case-insensitve). You can put any value after C_. |
## Quality Tag Modifiers
## Format Tag Modifiers
| Name | Abbreviation | Notes |
|---|---|---|
| Regex | R | Is only useful for Edition and Custom Quality Tags. Makes it, that Radarr parses the value of the Quality Tag as a Regex and uses the Regex for matching. |
| Negate | N | Negates the Quality Tag, i.e. when it normally matches it won't and when it normally wouldn't match it does. |
| Required | RE | Makes the Quality Tag strongly required. More on that later. |
| Word Matching | W | Makes the Quality 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.) |
| Regex | R | 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 | RE | Makes the Format Tag strongly required. More on that later. |
| Word Matching | W | 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.) |
## Quality Tags Examples
## Format Tags Examples
| Example of Tag | Example Release Name | Matching | Does it Match? |
|---|---|---|---|
@ -67,10 +67,10 @@ The Value is used for the matching.
# Matching
How does Radarr decide which quality or custom format to use?
First of all, all existing qualities also have quality tags, though they cannot be edited for safety reasons. Now Radarr uses the following steps to find the best matching quality or custom format:
1. Go through each quality & custom format and find out which quality tags match and which don't
2. Discard all qualities & custom formats, where an absolutely required quality tag (_RE_) does not match
3. Discard all qualities & custom formats, where at least one quality tag of a type is present and none of the tags of this type match. Examples:
First of all, all existing qualities also have Format Tags, though they cannot be edited for safety reasons. Now Radarr uses the following steps to find the best matching quality or custom format:
1. Go through each quality & custom format and find out which Format Tags match and which don't
2. Discard all qualities & custom formats, where an absolutely required Format Tag (_RE_) does not match
3. Discard all qualities & 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
4. Find quality or custom format with the most matching tags