Merge pull request #148 from raydak-labs/docs/templates

raydak-labs · Jan 10, 2025 · 4f42a52 · 4f42a52
2 parents b460963 + a269e43
commit 4f42a52
Show file tree

Hide file tree

Showing 7 changed files with 158 additions and 172 deletions.
diff --git a/README.md b/README.md
@@ -72,6 +72,8 @@ See [here](./custom/cfs/)
    2. Overwrite the hosts in case you are not using the local setup with docker compose
 5. Run the app with `pnpm start` or with the vscode task
 
+Tip: Beside from those steps you can also always test and work with the `full example` and utilizing the docker container with mounted `src` directory.
+
 ## Examples
 
 Some examples for configuration are provided [Examples](./examples/)
diff --git a/docs/docs/examples.md b/docs/docs/examples.md
@@ -80,26 +80,50 @@ radarr:
     include:
       - template: radarr-quality-definition-movie
       - template: radarr-custom-formats-hd-bluray-web-german
+      - template: radarr-quality-profile-hd-bluray-web-german
 
     quality_profiles:
       - name: HD Bluray + WEB (GER)
-        reset_unmatched_scores:
-          enabled: false
-        upgrade:
-          allowed: true
-          until_quality: Merged QPs
-          until_score: 25000
-        min_format_score: 0
-        quality_sort: top
-        qualities:
-          - name: Merged QPs
-            qualities:
-              - Bluray-1080p
-              - WEBRip-1080p
-              - WEBDL-1080p
-              - Bluray-720p
-              - WEBDL-720p
-              - WEBRip-720p
+        # min_format_score: 10000 # Uncomment this line to skip English Releases
+
+    custom_formats:
+      ### Optional
+      - trash_ids:
+        #  - b6832f586342ef70d9c128d40c07b872 # Bad Dual Groups
+        #  - 90cedc1fea7ea5d11298bebd3d1d3223 # EVO (no WEBDL)
+        #  - ae9b7c9ebde1f3bd336a8cbd1ec4c5e5 # No-RlsGroup
+        #  - 7357cf5161efbf8c4d5d0c30b4815ee2 # Obfuscated
+        #  - 5c44f52a8714fdd79bb4d98e2673be1f # Retags
+        #  - f537cf427b64c38c8e36298f657e4828 # Scene
+        assign_scores_to:
+          - name: HD Bluray + WEB (GER)
+
+      ### Movie Versions
+      - trash_ids:
+        # Uncomment any of the following lines to prefer these movie versions
+        #  - 570bc9ebecd92723d2d21500f4be314c # Remaster
+        #  - eca37840c13c6ef2dd0262b141a5482f # 4K Remaster
+        #  - e0c07d59beb37348e975a930d5e50319 # Criterion Collection
+        #  - 9d27d9d2181838f76dee150882bdc58c # Masters of Cinema
+        #  - db9b4c4b53d312a3ca5f1378f6440fc9 # Vinegar Syndrome
+        #  - 957d0f44b592285f26449575e8b1167e # Special Edition
+        #  - eecf3a857724171f968a66cb5719e152 # IMAX
+        #  - 9f6cbff8cfe4ebbc1bde14c7b7bec0de # IMAX Enhanced
+        assign_scores_to:
+          - name: HD Bluray + WEB (GER)
+
+      ### Others
+      - trash_ids:
+        # - 839bea857ed2c0a8e084f3cbdbd65ecb # Uncomment this line to allow HDR/DV x265 HD releases
+        assign_scores_to:
+          - name: HD Bluray + WEB (GER)
+
+      - trash_ids:
+        #  - dc98083864ea246d05a42df0d05f81cc # Uncomment this line to allow any x265 HD releases
+        #  - e6886871085226c3da1830830146846c # Uncomment this line to allow Generated Dynamic HDR
+        assign_scores_to:
+          - name: HD Bluray + WEB (GER)
+            score: 0
 ```
 
 2. For this example, we try to implement `HD Bluray + WEB`.

diff --git a/docs/docs/profiles/_radarr/qp_german_hd_web.yml b/docs/docs/profiles/_radarr/qp_german_hd_web.yml
@@ -1,12 +1,11 @@
 ###################################################################################################
 # Recyclarr Configuration Template: HD Bluray + WEB (GER)                                         #
-# Updated: 2024-12-28                                                                             #
+# Updated: 2025-01-10                                                                             #
 # Documentation: https://recyclarr.dev                                                            #
 # Note: If you are using multiple profiles in a single instance, please read the following        #
 # documentation about file merging:                                                               #
 # https://recyclarr.dev/wiki/yaml/config-examples/#merge-single-instance                          #
 ###################################################################################################
-
 # Instance Definition: https://recyclarr.dev/wiki/yaml/config-reference/basic/
 
 radarr:
@@ -17,32 +16,11 @@ radarr:
     include:
       - template: radarr-quality-definition-movie
       - template: radarr-custom-formats-hd-bluray-web-german
+      - template: radarr-quality-profile-hd-bluray-web-german
 
     quality_profiles:
       - name: HD Bluray + WEB (GER)
-        reset_unmatched_scores:
-          enabled: false
-        upgrade:
-          allowed: true
-          until_quality: Merged QPs
-          until_score: 25000
-        # Uncomment one of the next 2 lines dependent on if you want English Releases
-        min_format_score: 0 # Get English Releases and Upgrade to German when available
-        #        min_format_score: 10000 # Skip English Releases
-        quality_sort: top
-        qualities:
-          - name: Merged QPs
-            # Comment any qualities you are not interested in
-            qualities:
-              #              - Bluray-2160p
-              #              - WEBDL-2160p
-              #              - WEBRip-2160p
-              - Bluray-1080p
-              - WEBRip-1080p
-              - WEBDL-1080p
-              - Bluray-720p
-              - WEBDL-720p
-              - WEBRip-720p
+    #        min_format_score: 10000 # Uncomment this line to skip English Releases
 
     custom_formats:
       ### Optional
@@ -56,31 +34,29 @@ radarr:
         assign_scores_to:
           - name: HD Bluray + WEB (GER)
 
-      ### Resolution Boosters
-      # Uncomment any ID corresponding to resolutions you are not interested in
+      ### Movie Versions
+      - trash_ids:
+        # Uncomment any of the following lines to prefer these movie versions
+        #          - 570bc9ebecd92723d2d21500f4be314c # Remaster
+        #          - eca37840c13c6ef2dd0262b141a5482f # 4K Remaster
+        #          - e0c07d59beb37348e975a930d5e50319 # Criterion Collection
+        #          - 9d27d9d2181838f76dee150882bdc58c # Masters of Cinema
+        #          - db9b4c4b53d312a3ca5f1378f6440fc9 # Vinegar Syndrome
+        #          - 957d0f44b592285f26449575e8b1167e # Special Edition
+        #          - eecf3a857724171f968a66cb5719e152 # IMAX
+        #          - 9f6cbff8cfe4ebbc1bde14c7b7bec0de # IMAX Enhanced
+        assign_scores_to:
+          - name: HD Bluray + WEB (GER)
+
+      ### Others
       - trash_ids:
-          - 3bc8df3a71baaac60a31ef696ea72d36 # German 1080p Booster
-          - cc7b1e64e2513a6a271090cdfafaeb55 # German 2160p Booster
-          - b2be17d608fc88818940cd1833b0b24c # 720p
-          - 820b09bb9acbfde9c35c71e0e565dad8 # 1080p
-          - fb392fb0d61a010ae38e49ceaa24a1ef # 2160p
+        #          - 839bea857ed2c0a8e084f3cbdbd65ecb # Uncomment this line to allow HDR/DV x265 HD releases
         assign_scores_to:
           - name: HD Bluray + WEB (GER)
-### Generated Dynamic HDR
-# Uncomment the next 5 lines if you dont care about Generated Dynamic HDR and/or want to grab VECTOR
-#      - trash_ids:
-#          - e6886871085226c3da1830830146846c # Generated Dynamic HDR
-#        assign_scores_to:
-#          - name: HD Bluray + WEB (GER)
-#            score: 0
 
-### x265 Releases
-#      - trash_ids:
-# Uncomment the next six lines to allow x265 HD releases with HDR/DV
-# Uncomment the next four lines to allow any x265 HD releases
-#          - dc98083864ea246d05a42df0d05f81cc # x265 (HD)
-#        assign_scores_to:
-#          - name: HD Bluray + WEB (GER)
-#            score: 0
-#      - trash_ids:
-#          - 839bea857ed2c0a8e084f3cbdbd65ecb # x265 (no HDR/DV)
+      - trash_ids:
+        #          - dc98083864ea246d05a42df0d05f81cc # Uncomment this line to allow any x265 HD releases
+        #          - e6886871085226c3da1830830146846c # Uncomment this line to allow Generated Dynamic HDR
+        assign_scores_to:
+          - name: HD Bluray + WEB (GER)
+            score: 0
diff --git a/docs/docs/profiles/_radarr/qp_german_remux_web.yml b/docs/docs/profiles/_radarr/qp_german_remux_web.yml
@@ -1,12 +1,11 @@
 ###################################################################################################
 # Recyclarr Configuration Template: HD Bluray + WEB (GER)                                         #
-# Updated: 2024-12-28                                                                             #
+# Updated: 2025-01-10                                                                             #
 # Documentation: https://recyclarr.dev                                                            #
 # Note: If you are using multiple profiles in a single instance, please read the following        #
 # documentation about file merging:                                                               #
 # https://recyclarr.dev/wiki/yaml/config-examples/#merge-single-instance                          #
 ###################################################################################################
-
 # Instance Definition: https://recyclarr.dev/wiki/yaml/config-reference/basic/
 
 radarr:
@@ -17,33 +16,11 @@ radarr:
     include:
       - template: radarr-quality-definition-movie
       - template: radarr-custom-formats-uhd-remux-web-german
+      - template: radarr-quality-profile-uhd-remux-web-german
 
     quality_profiles:
       - name: Remux + WEB 2160p (GER)
-        reset_unmatched_scores:
-          enabled: false
-        upgrade:
-          allowed: true
-          until_quality: Merged QPs
-          until_score: 25000
-        # Uncomment one of the next 2 lines dependent on if you want English Releases
-        min_format_score: 0 # Get English Releases and Upgrade to German when available
-        #        min_format_score: 10000 # Skip English Releases
-        quality_sort: top
-        qualities:
-          - name: Merged QPs
-            # Comment any qualities you are not interested in
-            qualities:
-              - Remux-2160p
-              #              - Bluray-2160p
-              - WEBDL-2160p
-              - WEBRip-2160p
-    #              - Bluray-1080p
-    #              - WEBRip-1080p
-    #              - WEBDL-1080p
-    #              - Bluray-720p
-    #              - WEBDL-720p
-    #              - WEBRip-720p
+    #        min_format_score: 10000 # Uncomment this line to skip English Releases
 
     custom_formats:
       ### Audio
@@ -69,6 +46,7 @@ radarr:
       ### Movie Versions
       - trash_ids:
         # Uncomment any of the following lines to prefer these movie versions
+        #          - 0f12c086e289cf966fa5948eac571f44 # Hybrid
         #          - 570bc9ebecd92723d2d21500f4be314c # Remaster
         #          - eca37840c13c6ef2dd0262b141a5482f # 4K Remaster
         #          - e0c07d59beb37348e975a930d5e50319 # Criterion Collection
@@ -79,6 +57,7 @@ radarr:
         #          - 9f6cbff8cfe4ebbc1bde14c7b7bec0de # IMAX Enhanced
         assign_scores_to:
           - name: Remux + WEB 2160p (GER)
+
       ### Optional
       - trash_ids:
         #          - b6832f586342ef70d9c128d40c07b872 # Bad Dual Groups
@@ -90,36 +69,6 @@ radarr:
         assign_scores_to:
           - name: Remux + WEB 2160p (GER)
 
-      ### Resolution Boosters
-      # Comment any ID corresponding to resolutions you are not interested in
-      - trash_ids:
-          - 3bc8df3a71baaac60a31ef696ea72d36 # German 1080p Booster
-          - cc7b1e64e2513a6a271090cdfafaeb55 # German 2160p Booster
-          - b2be17d608fc88818940cd1833b0b24c # 720p
-          - 820b09bb9acbfde9c35c71e0e565dad8 # 1080p
-          - fb392fb0d61a010ae38e49ceaa24a1ef # 2160p
-        assign_scores_to:
-          - name: Remux + WEB 2160p (GER)
-
-      ### Generated Dynamic HDR
-      # Uncomment the next 5 lines if you dont care about Generated Dynamic HDR and/or want to grab VECTOR
-      #      - trash_ids:
-      #          - e6886871085226c3da1830830146846c # Generated Dynamic HDR
-      #        assign_scores_to:
-      #          - name: Remux + WEB 2160p (GER)
-      #            score: 0
-
-      ### x265 Releases
-      #      - trash_ids:
-      # Uncomment the next six lines to allow x265 HD releases with HDR/DV
-      # Uncomment the next four lines to allow any x265 HD releases
-      #          - dc98083864ea246d05a42df0d05f81cc # x265 (HD)
-      #        assign_scores_to:
-      #          - name: Remux + WEB 2160p (GER)
-      #            score: 0
-      #      - trash_ids:
-      #          - 839bea857ed2c0a8e084f3cbdbd65ecb # x265 (no HDR/DV)
-
       ### HDR / DV
       - trash_ids:
         # Comment out the next line if you and all of your users' setups are fully DV compatible
@@ -140,3 +89,16 @@ radarr:
         #          - 25c12f78430a3a23413652cbd1d48d77 # SDR (no WEBDL)
         assign_scores_to:
           - name: Remux + WEB 2160p (GER)
+
+      ### Others
+      - trash_ids:
+        #          - 839bea857ed2c0a8e084f3cbdbd65ecb # Uncomment this line to allow HDR/DV x265 HD releases
+        assign_scores_to:
+          - name: Remux + WEB 2160p (GER)
+
+      - trash_ids:
+        #          - dc98083864ea246d05a42df0d05f81cc # Uncomment this line to allow any x265 HD releases
+        #          - e6886871085226c3da1830830146846c # Uncomment this line to allow Generated Dynamic HDR
+        assign_scores_to:
+          - name: Remux + WEB 2160p (GER)
+            score: 0