diff --git a/VERSION b/VERSION index 245dec3a..580cbd83 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.17.3-develop85 +1.17.3-develop86 diff --git a/defaults/chart/flixpatrol.yml b/defaults/chart/flixpatrol.yml index c1e92190..b06c143b 100644 --- a/defaults/chart/flixpatrol.yml +++ b/defaults/chart/flixpatrol.yml @@ -2,6 +2,7 @@ external_templates: pmm: templates template_variables: collection_section: "01" + pre: "_#" translations: pmm: translations @@ -31,6 +32,7 @@ dynamic_collections: hulu: Hulu paramount: Paramount Plus prime: Prime Video + title_format: <> Top <> template: - flixpatrol - translation diff --git a/defaults/overlays/images/audio_codec/compact/flacc.png b/defaults/overlays/images/audio_codec/compact/flac.png similarity index 100% rename from defaults/overlays/images/audio_codec/compact/flacc.png rename to defaults/overlays/images/audio_codec/compact/flac.png diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index 6a38294d..e5b600db 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -1,6 +1,6 @@ # BAFTA Default Metadata File -The `- pmm: bafta` Metadata File is used to create collections based on the British Academy Film Awards. +The `bafta` Metadata File is used to create collections based on the British Academy Film Awards. This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) @@ -16,25 +16,18 @@ libraries: - pmm: bafta ``` - ## Template Variables -Template Variables can be used to manipulate the file from the default settings which are provided. -Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. +Template Variables can be used to manipulate the file from the default settings which are provided. -Below are the available variables which can be used to customize the file. +Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored. +All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. -| Variable | Usage | Default Value | Values | -|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` | -| collection_section | Controls the sort order of these collections against other default collections | `10` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | -| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` or `custom` | -| radarr_add_missing | Adds missing from the collection to Radarr | `false` | `true` or `false` | -| radarr_folder | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to missing items | -| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items | +| Variable | Description & Values | +|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | +| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| The below shows an example config.yml with all the template_variables set away from their defaults: @@ -48,8 +41,5 @@ libraries: collection_mode: show_items collection_order: alpha radarr_add_missing: true - radarr_folder: /mnt/local/Media/Movies - radarr_tag: <> - item_radarr_tag: <> ``` diff --git a/docs/defaults/files.md b/docs/defaults/files.md index 0905844b..9e31a43f 100644 --- a/docs/defaults/files.md +++ b/docs/defaults/files.md @@ -2,13 +2,12 @@ The below table outlines the available Defaults files which can be called via `metadata_path` (for Collections), `overlay_path` (for Overlays) and `playlist_files` (for Playlists). - ## Collections + These files can generally be used on both Movie and Show library-types, or are part of a category of collection (such as Award Shows.) These collections are applied by calling the below paths into the `metadata_path:` section of your config.yml - ### Chart Collections | Source | config.yml entry | Example Collections Created | Works with Movies | Works with Shows | @@ -60,6 +59,7 @@ These collections are applied by calling the below paths into the `metadata_path | Writer | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | ✅ | ❌ | ## Overlays + These files apply overlays and can generally be used on both Movie and Show library-types, and often works at the season and episode-level too. It should be noted that when an overlay has ❗ for a season or episode, it normally means that whilst the overlay can technically be applied at the level, it wasn't designed for this purpose. For example, a show's season cannot have a resolution since it is not a video file, and an episode cannot have a commonsense age-rating since only Movies and Shows are rated by CommonSense. @@ -89,6 +89,7 @@ These overlays are applied by calling the below paths into the `overlay_path:` [ | Video Format | `video_format` | "REMUX", "HDTV" | ✅ | ❗ | ❗ | ✅ | ## Playlists + These files apply playlists to the "Playlists" section of Plex and are applied by calling the below paths into the `playlist_files:` section of your config.yml ### Playlist Files diff --git a/docs/defaults/readme.md b/docs/defaults/readme.md index 8acf0a4f..c21e63dc 100644 --- a/docs/defaults/readme.md +++ b/docs/defaults/readme.md @@ -219,7 +219,7 @@ For example: `collection_section: 01` translates to `sort_title: "!<>`* | **Description:** Turns off individual Collections in a Default's file.
**Values:** `false` to turn off the collection | -| `collection_section` | **Description:** Controls the sort order of the collection sections against other default collection sections.
**Values:** Any number | -| `order_<>`* | **Description:** Controls the sort order of the collections in each collection section.
**Values:** Any number | -| `collection_mode` | **Description:** Controls the collection mode of these collections.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| -| `visible_library_<>`* | **Description:** Controls collection visible on Library (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| -| `visible_home_<>`* | **Description:** Controls collection visible on Home (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| -| `visible_shared_<>`* | **Description:** Controls collection visible on Shared Users' Home (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| -| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for these collections
**Values:** `true` or `false` | -| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for these collections
**Values:** Folder Path | -| `radarr_tag` | **Description:** Override Radarr `tag` attribute for these collections
**Values:** List or comma-separated string of tags | -| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for these collections
**Values:** List or comma-separated string of tags | -| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for these collections
**Values:** `true` or `false` | -| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for these collections
**Values:** Folder Path | -| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for these collections
**Values:** List or comma-separated string of tags | -| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for these collections
**Values:** List or comma-separated string of tags | +| Variable | Description & Values | +|:--------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `use_<>`1 | **Description:** Turns off individual Collections in a Default's file.
**Values:** `false` to turn off the collection | +| `collection_section` | **Description:** Controls the sort order of the collection sections against other default collection sections.
**Values:** Any number | +| `order_<>`1 | **Description:** Controls the sort order of the collections in each collection section.
**Values:** Any number | +| `collection_mode` | **Description:** Controls the collection mode of these collections.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| +| `visible_library_<>`1 | **Description:** Controls collection visible on Library (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `visible_home_<>`1 | **Description:** Controls collection visible on Home (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `visible_shared_<>`1 | **Description:** Controls collection visible on Shared Users' Home (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for these collections
**Values:** `true` or `false` | +| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for these collections
**Values:** Folder Path | +| `radarr_tag` | **Description:** Override Radarr `tag` attribute for these collections
**Values:** List or comma-separated string of tags | +| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for these collections
**Values:** List or comma-separated string of tags | +| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for these collections
**Values:** `true` or `false` | +| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for these collections
**Values:** Folder Path | +| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for these collections
**Values:** List or comma-separated string of tags | +| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for these collections
**Values:** List or comma-separated string of tags | + +1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. \ No newline at end of file diff --git a/docs/metadata/details/arr.md b/docs/metadata/details/arr.md index ff76196e..81e4a4b4 100644 --- a/docs/metadata/details/arr.md +++ b/docs/metadata/details/arr.md @@ -6,18 +6,18 @@ All the following attributes can override the global/library [Radarr](../../conf | Attribute | Description & Values | |:--------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute
**Values:** `true` or `false` | -| `radarr_add_existing` | **Description:** Override Radarr `add_existing` attribute
**Values:** `true` or `false` | -| `radarr_upgrade_existing` | **Description:** Override Radarr `upgrade_existing` attribute
**Values:** `true` or `false` | -| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute
**Values:** Folder Path | -| `radarr_monitor` | **Description:** Override Radarr `monitor` attribute
**Values:** `true` or `false` | -| `radarr_availability` | **Description:** Override Radarr `availability` attribute
**Values:** `announced`, `cinemas`, `released`, `db` | -| `radarr_quality` | **Description:** Override Radarr `quality_profile` attribute
**Values:** Radarr Quality Profile | -| `radarr_tag` | **Description:** Override Radarr `tag` attribute
**Values:** List or comma-separated string of tags | -| `radarr_search` | **Description:** Override Radarr `search` attribute
**Values:** `true` or `false` | -| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr
**Values:** List or comma-separated string of tags | -| `item_radarr_tag.remove` | **Description:** Used to remove existing tags in Radarr for every movie found by the builders that's in Radarr
**Values:** List or comma-separated string of tags | -| `item_radarr_tag.sync` | **Description:** Matches the tags in Radarr for every movie found by the builders that's in Radarr with the provided tags
**Values:** List or comma-separated string of tags | +| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute
**Values:** `true` or `false` | +| `radarr_add_existing` | **Description:** Override Radarr `add_existing` attribute
**Values:** `true` or `false` | +| `radarr_upgrade_existing` | **Description:** Override Radarr `upgrade_existing` attribute
**Values:** `true` or `false` | +| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute
**Values:** Folder Path | +| `radarr_monitor` | **Description:** Override Radarr `monitor` attribute
**Values:** `true` or `false` | +| `radarr_availability` | **Description:** Override Radarr `availability` attribute
**Values:** `announced`, `cinemas`, `released`, `db` | +| `radarr_quality` | **Description:** Override Radarr `quality_profile` attribute
**Values:** Radarr Quality Profile | +| `radarr_tag` | **Description:** Override Radarr `tag` attribute
**Values:** List or comma-separated string of tags | +| `radarr_search` | **Description:** Override Radarr `search` attribute
**Values:** `true` or `false` | +| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr
**Values:** List or comma-separated string of tags | +| `item_radarr_tag.remove` | **Description:** Used to remove existing tags in Radarr for every movie found by the builders that's in Radarr
**Values:** List or comma-separated string of tags | +| `item_radarr_tag.sync` | **Description:** Matches the tags in Radarr for every movie found by the builders that's in Radarr with the provided tags
**Values:** List or comma-separated string of tags | ## Sonarr Details @@ -25,21 +25,21 @@ All the following attributes can override the global/library [Sonarr](../../conf | Attribute | Description & Values | |:--------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute
**Values:** `true` or `false` | -| `sonarr_add_existing` | **Description:** Override Sonarr `add_existing` attribute
**Values:** `true` or `false` | -| `sonarr_upgrade_existing` | **Description:** Override Sonarr `upgrade_existing` attribute
**Values:** `true` or `false` | -| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute
**Values:** Folder Path | -| `sonarr_monitor` | **Description:** Override Sonarr `monitor` attribute
**Values:** `all`, `future`, `missing`, `existing`, `pilot`, `first`, `latest`, `none` | -| `sonarr_quality` | **Description:** Override Sonarr `quality_profile` attribute
**Values:** Sonarr Quality Profile | -| `sonarr_language` | **Description:** Override Sonarr `language_profile` attribute
**Values:** Sonarr Language Profile | -| `sonarr_series` | **Description:** Override Sonarr `series_type` attribute
**Values:** `standard`, `daily`, `anime` | -| `sonarr_season` | **Description:** Override Sonarr `season_folder` attribute
**Values:** `true` or `false` | -| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute
**Values:** List or comma-separated string of tags | -| `sonarr_search` | **Description:** Override Sonarr `search` attribute
**Values:** `true` or `false` | -| `sonarr_cutoff_search` | **Description:** Override Sonarr `cutoff_search` attribute
**Values:** `true` or `false` | -| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr
**Values:** List or comma-separated string of tags | -| `item_sonarr_tag.remove` | **Description:** Used to remove existing tags in Sonarr for every series found by the builders that's in Sonarr
**Values:** List or comma-separated string of tags | -| `item_sonarr_tag.sync` | **Description:** Matches the tags in Sonarr for every series found by the builders that's in Sonarr with the provided tags
**Values:** List or comma-separated string of tags | +| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute
**Values:** `true` or `false` | +| `sonarr_add_existing` | **Description:** Override Sonarr `add_existing` attribute
**Values:** `true` or `false` | +| `sonarr_upgrade_existing` | **Description:** Override Sonarr `upgrade_existing` attribute
**Values:** `true` or `false` | +| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute
**Values:** Folder Path | +| `sonarr_monitor` | **Description:** Override Sonarr `monitor` attribute
**Values:** `all`, `future`, `missing`, `existing`, `pilot`, `first`, `latest`, `none` | +| `sonarr_quality` | **Description:** Override Sonarr `quality_profile` attribute
**Values:** Sonarr Quality Profile | +| `sonarr_language` | **Description:** Override Sonarr `language_profile` attribute
**Values:** Sonarr Language Profile | +| `sonarr_series` | **Description:** Override Sonarr `series_type` attribute
**Values:** `standard`, `daily`, `anime` | +| `sonarr_season` | **Description:** Override Sonarr `season_folder` attribute
**Values:** `true` or `false` | +| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute
**Values:** List or comma-separated string of tags | +| `sonarr_search` | **Description:** Override Sonarr `search` attribute
**Values:** `true` or `false` | +| `sonarr_cutoff_search` | **Description:** Override Sonarr `cutoff_search` attribute
**Values:** `true` or `false` | +| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr
**Values:** List or comma-separated string of tags | +| `item_sonarr_tag.remove` | **Description:** Used to remove existing tags in Sonarr for every series found by the builders that's in Sonarr
**Values:** List or comma-separated string of tags | +| `item_sonarr_tag.sync` | **Description:** Matches the tags in Sonarr for every series found by the builders that's in Sonarr with the provided tags
**Values:** List or comma-separated string of tags | ## Adding to Arr You can add items to Radarr/Sonarr in two different ways. diff --git a/docs/metadata/details/metadata.md b/docs/metadata/details/metadata.md index 1ab36ab1..87bc3f2f 100644 --- a/docs/metadata/details/metadata.md +++ b/docs/metadata/details/metadata.md @@ -14,7 +14,7 @@ Only `tmdb_person` works with Playlists. | `label` | **Description:** Appends new labels.
**Values:** Comma-separated string of labels to append | | `label.remove` | **Description:** Removes existing labels from the collection.
**Values:** Comma-separated string of labels to remove | | `label.sync` | **Description:** Matches the labels of the collection to the labels provided (Leave blank to remove all labels)
**Values:** Comma-separated string of labels to sync | -| `collection_mode` | **Description:** Changes the Collection Mode
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| +| `collection_mode` | **Description:** Changes the Collection Mode
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| | `collection_order` | **Description:** Changes the Collection Order
**Normal Collections Only**
When using `custom` you can only have a single builder in the collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `collection_filtering` | **Description:** Changes the Collection Filtering
**Smart Collections Only**
**Values:**
`admin`Always the server admin user
`user`User currently viewing the content
| | `builder_level` | **Description:** Make season, episode, album or track collections/overlays from `plex_all`, `plex_search`, `trakt_list`, or `imdb_list` Builders and Filters
**Values:**
`season`Collection contains seasons
`episode`Collection contains episodes
`album`Collection contains albums
`track`Collection contains tracks
| diff --git a/docs/metadata/metadata/music.md b/docs/metadata/metadata/music.md index 89748870..023622ad 100644 --- a/docs/metadata/metadata/music.md +++ b/docs/metadata/metadata/music.md @@ -73,7 +73,7 @@ The available attributes for editing artists, albums, and tracks are as follows | `sort_title` | Text to change Sort Title | ✅ | ✅ | ✅ | | `user_rating` | Number to change User Rating | ✅ | ✅ | ✅ | | `critic_rating` | Number to change Critic Rating | ❌ | ✅ | ❌ | -| `originally_available` | Date to change Originally Available
**Format:** YYYY-MM-DD | ❌ | ✅ | ❌ | +| `originally_available` | Date to change Originally Available
**Format:** YYYY-MM-DD | ❌ | ✅ | ❌ | | `record_label` | Text to change Record Label | ❌ | ✅ | ❌ | | `summary` | Text to change Summary | ✅ | ✅ | ✅ | | `track` | Text to change Track | ❌ | ❌ | ✅ | diff --git a/modules/meta.py b/modules/meta.py index 28b8f712..867c8d73 100644 --- a/modules/meta.py +++ b/modules/meta.py @@ -776,6 +776,10 @@ class MetadataFile(DataFile): sync = util.parse("Config", "sync", dynamic, parent=map_name, methods=methods, default=False, datatype="bool") if "sync" in methods else False if "<>" in title_format: title_format = title_format.replace("<>", library.type) + if "<>" in title_format: + title_format = title_format.replace("<>", library.type.capitalize()) + if "limit" in self.temp_vars and "<>" in title_format: + title_format = title_format.replace("<>", self.temp_vars["limit"]) template_variables = util.parse("Config", "template_variables", dynamic, parent=map_name, methods=methods, datatype="dictdict") if "template_variables" in methods else {} if "template" in methods: template_names = util.parse("Config", "template", dynamic, parent=map_name, methods=methods, datatype="strlist")