diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index adc5c83b6..ea7d99737 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -8,11 +8,11 @@ jobs: name: Build docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.2.0 + - uses: actions/checkout@v3.3.0 - uses: actions/setup-python@v4.4.0 with: python-version: 3.x - - uses: actions/cache@v3.2.2 + - uses: actions/cache@v3.2.3 with: key: ${{ github.ref }} path: .cache @@ -25,13 +25,13 @@ jobs: name: Deploy docs runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.2.0 + - uses: actions/checkout@v3.3.0 with: fetch-depth: '0' - uses: actions/setup-python@v4.4.0 with: python-version: 3.x - - uses: actions/cache@v3.2.2 + - uses: actions/cache@v3.2.3 with: key: ${{ github.ref }} path: .cache diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index e56418b30..ca3995d1b 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -7,7 +7,7 @@ jobs: editorconfig-checker: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.2.0 + - uses: actions/checkout@v3.3.0 - name: editorconfig-checker run: | docker run --rm \ @@ -17,7 +17,7 @@ jobs: markdownlint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.2.0 + - uses: actions/checkout@v3.3.0 - name: markdownlint run: | find "${GITHUB_WORKSPACE}" -name '*.md' -exec \ @@ -30,7 +30,7 @@ jobs: yamllint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.2.0 + - uses: actions/checkout@v3.3.0 - name: yamllint run: | find "${GITHUB_WORKSPACE}" -name '*.yaml' -o -name '*.yml' -exec \ diff --git a/.github/workflows/metadata-validation.yml b/.github/workflows/metadata-validation.yml index 8c33892f7..e336d434e 100644 --- a/.github/workflows/metadata-validation.yml +++ b/.github/workflows/metadata-validation.yml @@ -17,7 +17,7 @@ jobs: runs-on: ubuntu-latest name: Validate metadata.json steps: - - uses: actions/checkout@v3.2.0 + - uses: actions/checkout@v3.3.0 - uses: actions/setup-python@v4.4.0 with: python-version: "3.x" diff --git a/docs/Radarr/Radarr-recommended-naming-scheme.md b/docs/Radarr/Radarr-recommended-naming-scheme.md index 662e0e415..c7cb9838c 100644 --- a/docs/Radarr/Radarr-recommended-naming-scheme.md +++ b/docs/Radarr/Radarr-recommended-naming-scheme.md @@ -65,7 +65,7 @@ For Jellyfin/Emby: ## Original Title vs Original Filename -Another option is to use `{Original Title}` rather than the recommeneded naming scheme outlined aboove. `{Original Title}` will use the title of the release which will contain all of the information included in the release itself. The benefit of this naming scheme is to prevent download loops which can occur on import when there is a discrepancy in the release title compared to the contents of the file itself (for example, if the release title says DTS-ES but the contents are actually DTS). The downside is less flexibility with how the files are named. +Another option is to use `{Original Title}` rather than the recommeneded naming scheme outlined above. `{Original Title}` will use the title of the release which will contain all of the information included in the release itself. The benefit of this naming scheme is to prevent download loops which can occur on import when there is a discrepancy in the release title compared to the contents of the file itself (for example, if the release title says DTS-ES but the contents are actually DTS). The downside is less flexibility with how the files are named. If using this alternate naming scheme I suggest using `{Original Title}` over `{Original Filename}` diff --git a/docs/Radarr/Tips/How-to-setup-language-custom-formats.md b/docs/Radarr/Tips/How-to-setup-language-custom-formats.md new file mode 100644 index 000000000..6cbb8a46c --- /dev/null +++ b/docs/Radarr/Tips/How-to-setup-language-custom-formats.md @@ -0,0 +1,190 @@ +# How to setup Language Custom Formats + +Here we will explain how to setup your own preferred language Custom Format, with a few examples. + +!!! warning "Using language Custom Formats is not compatible with setting a preferred language in a quality profile in Radarr. You must use one or the other.
If you want to make use of the Custom Formats set the preferred language to `Any`." + +## Language Examples + +Import the JSON in to your Custom Formats. + +How ? + +Follow the [How to import Custom Formats](/Radarr/Radarr-import-custom-formats/){:target="_blank" rel="noopener noreferrer"}. + +--- + +### Language: Original Only + +Language: Not Original + +This is one of the most common one used besides the English only one. + +With this Custom Format you will get only the Movie/TV Show with the original language. + +For this we're going to make use of so called reverse scoring. + +Add the following json to your Radarr/Sonarr with a score of `-10000`. + +??? example "JSON - [CLICK TO EXPAND]" + + ```json + [[% filter indent(width=4) %]][[% include 'json/guide-only/language-not-original.json' %]][[% endfilter %]] + ``` + +--- + +### Language: English Only + +Language: Not English + +With this Custom Format you will only get the Movie/TV Show in the English language. + +!!! info "For languages other than English, replace the English condition with language of your choice." + +For this we're going to make use of so called reverse scoring. + +Add the following json to your Radarr/Sonarr with a score of `-10000`. + +??? example "JSON - [CLICK TO EXPAND]" + + ```json + [[% filter indent(width=4) %]][[% include 'json/guide-only/language-not-english.json' %]][[% endfilter %]] + ``` + +--- + +### Language: Multiple Only + +Language: Not Dutch + +In some case you need multiple languages in your Custom Format for different reasons, + +in this example I will use Dutch and Flemish being a lot of Movies/TV Shows are collaborate made between the 2 countries/studio's. + +With this Custom Format you will only get the Movie/TV Show with Dutch and/or Flemish Audio. + +!!! info "For languages other than Dutch/Flemish, replace the Dutch/Flemish condition with language of your choice." + +For this we're going to make use of so called reverse scoring. + +Add the following json to your Radarr/Sonarr with a score of `-10000`. + +??? example "JSON - [CLICK TO EXPAND]" + + ```json + [[% filter indent(width=4) %]][[% include 'json/guide-only/language-not-dutch.json' %]][[% endfilter %]] + ``` + +--- + +### Language: Prefer X but i'll take Y + +Language: Not Original or German +Language: Prefer German + +Let's say you want German, but if German is not available then fall back to Original language but don't accept any other translated languages. + +!!! info "For languages other than German, replace the German condition with language of your choice." + +Add the following json to your Radarr/Sonarr with a score of `-10000`. + +??? example "JSON - [CLICK TO EXPAND]" + + ```json + [[% filter indent(width=4) %]][[% include 'json/guide-only/language-not-original-or-german.json' %]][[% endfilter %]] + ``` + +Add the following json to your Radarr/Sonarr with a score of `10`. + +??? example "JSON - [CLICK TO EXPAND]" + + ```json + [[% filter indent(width=4) %]][[% include 'json/guide-only/language-prefer-german.json' %]][[% endfilter %]] + ``` + +--- + +### Language: Prefer Language X + +Language: Prefer German + +Let's say you just want to prefer German and don't care if you get another random language(s). + +!!! info "For languages other than German, replace the German condition with language of your choice." + +Add the following json to your Radarr/Sonarr with a score of `10`. + +??? example "JSON - [CLICK TO EXPAND]" + + ```json + [[% filter indent(width=4) %]][[% include 'json/guide-only/language-prefer-german.json' %]][[% endfilter %]] + ``` + +--- + +### Language: Prefer Multi Language + +Language: Prefer Dutch + +In some case you may want prefer multiple languages in your Custom Format. + +With this Custom Format you will only get the Movie/TV Show with either Preferred Language. + +In this example I will use Dutch and Flemish since a lot of Movies/TV Shows since there is a lot of collaboration between the two countries/studio's. + +!!! info "For languages other than Dutch/Flemish, replace the Dutch/Flemish condition with language of your choice." + +Add the following json to your Radarr/Sonarr with a score of `10`. + +??? example "JSON - [CLICK TO EXPAND]" + + ```json + [[% filter indent(width=4) %]][[% include 'json/guide-only/language-prefer-dutch.json' %]][[% endfilter %]] + ``` + +--- + +## FAQ & INFO + +### What's reverse scoring + +??? FAQ "What's reverse scoring? - [CLICK TO EXPAND]" + + With reverse scoring you add a Custom Format with a score of `-10000` and your preferred condition you negate. + + So in the case of the following Custom Format `Language: Original Only`, it will actually match all Not Original releases and give it a score of `-10000`. + +### Prefer language X over language Y + +??? FAQ "Prefer language X over language Y - [CLICK TO EXPAND]" + + If you want to prefer Prefer language X over language Y, + + you add for example: `Language: Prefer Language X` with a score of `10`, and add `Language: Prefer Language Y` with score of `9`. + + Which scores you should use depends on how important the language is compared to other Custom Formats you're using. + +### What's Original Language + +??? FAQ "What's Original Language? - [CLICK TO EXPAND]" + + Original Language is the language in which a Movie/TV Show was originally made. + +### Where does Radarr get the Original Language from + +??? FAQ "Where does Radarr get the Original Language from? - [CLICK TO EXPAND]" + + Radarr makes use of [The Movie Database (TMDB)](https://www.themoviedb.org/){:target="_blank" rel="noopener noreferrer"}. + + ![!The Movie Database (TMDB) Original Language](images/original-language-tmdb.png) + +### Where does Sonarr get the Original Language from + +??? FAQ "Where does Sonarr get the Original Language from? - [CLICK TO EXPAND]" + + Sonarr makes use of [TheTVDB](https://thetvdb.com/){:target="_blank" rel="noopener noreferrer"}. + + ![!TheTVDB Original Language](images/original-language-tvdb.png) + +--8<-- "includes/support.md" diff --git a/docs/Radarr/Tips/images/original-language-tmdb.png b/docs/Radarr/Tips/images/original-language-tmdb.png new file mode 100644 index 000000000..7ddece6f7 Binary files /dev/null and b/docs/Radarr/Tips/images/original-language-tmdb.png differ diff --git a/docs/Radarr/Tips/images/original-language-tvdb.png b/docs/Radarr/Tips/images/original-language-tvdb.png new file mode 100644 index 000000000..ee3cdcd26 Binary files /dev/null and b/docs/Radarr/Tips/images/original-language-tvdb.png differ diff --git a/docs/Sonarr/Sonarr-Quality-Settings-File-Size.md b/docs/Sonarr/Sonarr-Quality-Settings-File-Size.md index 6e8ef990e..35c542a22 100644 --- a/docs/Sonarr/Sonarr-Quality-Settings-File-Size.md +++ b/docs/Sonarr/Sonarr-Quality-Settings-File-Size.md @@ -80,4 +80,11 @@ I only do WEB-DL myself for TV shows because in my opinion WEB-DL is the sweet s | {{ sonarr['quality-size']['anime']['qualities'][17]['quality'] }} | {{ sonarr['quality-size']['anime']['qualities'][17]['min'] }} | {{ sonarr['quality-size']['anime']['qualities'][17]['max'] }} | | {{ sonarr['quality-size']['anime']['qualities'][18]['quality'] }} | {{ sonarr['quality-size']['anime']['qualities'][18]['min'] }} | {{ sonarr['quality-size']['anime']['qualities'][18]['max'] }} | +!!! note + The reason why you don't see the `Preferred` score in the table above is because we want max quality anyway. So set it as high as possible. + + The highest preferred quality you can manually enter is 1 less than the Maximum quality. If you use the slider, the preferred quality can be up to 5 lesser than the Maximum quality. + + Make sure you have enabled 'Show Advanced' in Sonarr, if you don't see a provision to enter the scores, under the Quality settings. + --8<-- "includes/support.md" diff --git a/docs/Sonarr/Sonarr-recommended-naming-scheme.md b/docs/Sonarr/Sonarr-recommended-naming-scheme.md index da743ac6a..7974270f1 100644 --- a/docs/Sonarr/Sonarr-recommended-naming-scheme.md +++ b/docs/Sonarr/Sonarr-recommended-naming-scheme.md @@ -146,7 +146,7 @@ RESULTS: ## Original Title vs Original Filename -Another option is to use `{Original Title}` rather than the recommeneded naming scheme outlined aboove. `{Original Title}` will use the title of the release which will contain all of the information included in the release itself. The benefit of this naming scheme is to prevent download loops which can occur on import when there is a discrepancy in the release title compared to the contents of the file itself (for example, if the release title says DTS-ES but the contents are actually DTS). The downside is less flexibility with how the files are named. +Another option is to use `{Original Title}` rather than the recommeneded naming scheme outlined above. `{Original Title}` will use the title of the release which will contain all of the information included in the release itself. The benefit of this naming scheme is to prevent download loops which can occur on import when there is a discrepancy in the release title compared to the contents of the file itself (for example, if the release title says DTS-ES but the contents are actually DTS). The downside is less flexibility with how the files are named. If using this alternate naming scheme I suggest using `{Original Title}` over `{Original Filename}` diff --git a/docs/Sonarr/Tips/How-to-setup-language-custom-formats.md b/docs/Sonarr/Tips/How-to-setup-language-custom-formats.md new file mode 100644 index 000000000..bd9cdb28b --- /dev/null +++ b/docs/Sonarr/Tips/How-to-setup-language-custom-formats.md @@ -0,0 +1,4 @@ +{! + include-markdown '../../Radarr/Tips/How-to-setup-language-custom-formats.md' + rewrite_relative_urls=true +!} diff --git a/docs/json/guide-only/language-not-dutch.json b/docs/json/guide-only/language-not-dutch.json new file mode 100644 index 000000000..9011be8f9 --- /dev/null +++ b/docs/json/guide-only/language-not-dutch.json @@ -0,0 +1,27 @@ +{ + "trash_id": "guide-only", + "trash_score": "-10000", + "trash_description": "Language: Multiple Only", + "name": "Language: Not Dutch", + "includeCustomFormatWhenRenaming": false, + "specifications": [ + { + "name": "Not Dutch Language", + "implementation": "LanguageSpecification", + "negate": true, + "required": true, + "fields": { + "value": 7 + } + }, + { + "name": "Not Flemish Language", + "implementation": "LanguageSpecification", + "negate": true, + "required": true, + "fields": { + "value": 19 + } + } + ] +} diff --git a/docs/json/guide-only/language-not-english.json b/docs/json/guide-only/language-not-english.json new file mode 100644 index 000000000..0ad091dbc --- /dev/null +++ b/docs/json/guide-only/language-not-english.json @@ -0,0 +1,18 @@ +{ + "trash_id": "guide-only", + "trash_score": "-10000", + "trash_description": "Language: English Only", + "name": "Language: Not English", + "includeCustomFormatWhenRenaming": false, + "specifications": [ + { + "name": "Not English Language", + "implementation": "LanguageSpecification", + "negate": true, + "required": false, + "fields": { + "value": 1 + } + } + ] +} diff --git a/docs/json/guide-only/language-not-original-or-german.json b/docs/json/guide-only/language-not-original-or-german.json new file mode 100644 index 000000000..5af82821b --- /dev/null +++ b/docs/json/guide-only/language-not-original-or-german.json @@ -0,0 +1,27 @@ +{ + "trash_id": "guide-only", + "trash_score": "-10000", + "trash_description": "Language: Prefer X but i'll take Y", + "name": "Language: Not Original or German", + "includeCustomFormatWhenRenaming": false, + "specifications": [ + { + "name": "Not Original", + "implementation": "LanguageSpecification", + "negate": true, + "required": true, + "fields": { + "value": -2 + } + }, + { + "name": "Not German", + "implementation": "LanguageSpecification", + "negate": true, + "required": true, + "fields": { + "value": 4 + } + } + ] +} diff --git a/docs/json/guide-only/language-not-original.json b/docs/json/guide-only/language-not-original.json new file mode 100644 index 000000000..cf8cfe3f6 --- /dev/null +++ b/docs/json/guide-only/language-not-original.json @@ -0,0 +1,18 @@ +{ + "trash_id": "guide-only", + "trash_score": "-10000", + "trash_description": "Language: Original Only", + "name": "Language: Not Original", + "includeCustomFormatWhenRenaming": false, + "specifications": [ + { + "name": "Not Original Language", + "implementation": "LanguageSpecification", + "negate": true, + "required": false, + "fields": { + "value": -2 + } + } + ] +} diff --git a/docs/json/guide-only/language-prefer-dutch.json b/docs/json/guide-only/language-prefer-dutch.json new file mode 100644 index 000000000..e0411a98c --- /dev/null +++ b/docs/json/guide-only/language-prefer-dutch.json @@ -0,0 +1,27 @@ +{ + "trash_id": "guide-only", + "trash_score": "10", + "trash_description": "Prefer Multiple", + "name": "Language: Prefer Dutch", + "includeCustomFormatWhenRenaming": false, + "specifications": [ + { + "name": "Dutch Language", + "implementation": "LanguageSpecification", + "negate": false, + "required": false, + "fields": { + "value": 7 + } + }, + { + "name": "Flemish Language", + "implementation": "LanguageSpecification", + "negate": false, + "required": false, + "fields": { + "value": 19 + } + } + ] +} diff --git a/docs/json/guide-only/language-prefer-german.json b/docs/json/guide-only/language-prefer-german.json new file mode 100644 index 000000000..a74353c2b --- /dev/null +++ b/docs/json/guide-only/language-prefer-german.json @@ -0,0 +1,18 @@ +{ + "trash_id": "guide-only", + "trash_score": "10", + "trash_description": "Prefer Language X", + "name": "Language: Prefer German", + "includeCustomFormatWhenRenaming": false, + "specifications": [ + { + "name": "German Language", + "implementation": "LanguageSpecification", + "negate": false, + "required": false, + "fields": { + "value": 4 + } + } + ] +} diff --git a/docs/json/radarr/cf/br-disk.json b/docs/json/radarr/cf/br-disk.json index 965f3472c..ff62e4ecf 100644 --- a/docs/json/radarr/cf/br-disk.json +++ b/docs/json/radarr/cf/br-disk.json @@ -10,7 +10,7 @@ "negate": false, "required": true, "fields": { - "value": "^(?!.*\\b((?