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:40:13 +02:00
parent cb51896039
commit b2b835416f
1 changed files with 13 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
Custom-Formats.md

@ -7,14 +7,9 @@
# Custom Formats
Custom formats are a way for you to create your own "Qualities". They work very similar to existing qualities:
* Releases and Files are parsed like always. However, now Radarr also checks, if one of your custom formats is a better match and uses that instead of an existing quality.
* You can change the name of your custom format
* You can set the minimum and maximum size of your custom format
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 a release or file.
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!
* **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).
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).
# Format Tags
@ -65,19 +60,19 @@ The Value is used for the matching.
| L_French | Prometheus.2012.Bluray.MULTI.FRENCH.ENGLISH.1080p | [L_English, L_French] contains L_French | YES |
# Matching
How does Radarr decide which quality or custom format to use?
How does Radarr decide if a custom format matches a release or not?
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:
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 (_RE_) 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
4. Find quality or custom format with the most matching tags
* **Note:** If there are more than one found, Radarr chooses the one, where the size of the quality or format matches the one of the release or file best.
* Example: WEBDL-1080p (0GB<20GB) and Custom WEBDL-1080p (5GB<10GB). Both have the same tags. If the release has a size of 15 GB, Radarr will choose the WEBDL-1080p quality. If the release has a size of 7GB Radarr will choose the Custom WEBDL-1080p format. If the release has a size of 30GB Radarr will choose the WEBDL-1080p quality.
* This allows you to prefer smaller or larger releases and even upgrade to them. See full examples below.
# Examples
Below you can find a list of examples, ranging from simple custom formats to multiple custom formats with recommendations for your profile, allowing practically any workflow to be fully automated.
# Templates
Radarr provides a wide range of predefined templates. They are explained below and sometimes have tips on customizing them.
### x264
**Description:** This custom format matches any releases that are encoded with the x264 (sometimes called h264) codec.