@ -60,7 +60,7 @@ work. Any value not specified will use its default value if it has one if not it
| `append_include` | **Description:** Appends to the [default include list](#include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
| `remove_include` | **Description:** Removes from the [default include list](#include)<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
| `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.<br>**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)<br>**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) |
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-key_name_override).<br>**Values:** Dictionary with `key: new_key_name` entries |
| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#key-name-override).<br>**Values:** Dictionary with `key: new_key_name` entries |
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Audio`<br>**Values:** Any string with `<<key_name>>` in it. |
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in the <<key_name>> Language.`<br>**Values:** Any string. |
@ -113,7 +113,13 @@ If you want to customize these values, use the methods described above.
@ -69,7 +69,7 @@ work. Any value not specified will use its default value if it has one if not it
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Default:** `alpha`<br>**Values:**<tableclass="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `url_poster` | **Description:** Changes the poster url of the collection.<br>**Values:** URL directly to the Image |
| `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections |
| `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#exclude-prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#default-exclude_prefix)<br>**Values:** List of Prefixes | |
| `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#exclude-prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#exclude-prefix)<br>**Values:** List of Prefixes | |
???+ example "Example Template Variable Amendments"
@ -101,7 +101,13 @@ If you want to customize these values, use the methods described above.
@ -58,7 +58,7 @@ work. Any value not specified will use its default value if it has one if not it
| `collection_mode` | **Description:** Controls the collection mode of all collections in this file.<br>**Values:**<tableclass="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.<br>**Default:** `2`<br>**Values:** Any number |
| `movie_<<key>>`<sup>1</sup> | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default movie](#movie) for that collection if used.<br>**Values:** List of TMDb Movie IDs |
| `name_mapping_<<key>>`<sup>1</sup> | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#name_mapping) for that collection if used.<br>**Values:** Any String |
| `name_mapping_<<key>>`<sup>1</sup> | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#name-mapping) for that collection if used.<br>**Values:** Any String |
| `sort_title` | **Description:** Sets the sort title for all collections. Use `<<collection_name>>` to use the collection name. **Example:**`"!02_<<collection_name>>"`<br>**Values:** Any String with `<<collection_name>>` |
| `sort_title_<<key>>`<sup>1</sup> | **Description:** Sets the sort title of the specified key's collection.<br>**Default:** `sort_title`<br>**Values:** Any String |
| `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these movies sent to Radarr.<br>**Values:** `false` to not build the collection |
@ -118,7 +118,13 @@ If you want to customize these values, use the methods described above.
@ -62,7 +62,7 @@ work. Any value not specified will use its default value if it has one if not it
| `sync_to_users_<<key>>`<sup>1</sup> | **Description:** Sets the users to sync the specified key's playlist to.<br>**Default:** `sync_to_user` Value<br>**Values:** Comma-separated string or list of user names. |
| `exclude_user` | **Description:** Sets the users to exclude from sync for all playlists.<br>**Default:** `playlist_sync_to_users` Global Setting Value<br>**Values:** Comma-separated string or list of user names. |
| `exclude_user_<<key>>`<sup>1</sup> | **Description:** Sets the users to exclude from sync the specified key's playlist.<br>**Default:** `sync_to_users` Value<br>**Values:** Comma-separated string or list of user names. |
| `trakt_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the Trakt List to the specified key's playlist. Overrides the [default trakt_list](#default-trakt_list) for that playlist if used.<br>**Values:** List of Trakt List URLs | | | |
| `trakt_list_<<key>>`<sup>1</sup> | **Description:** Adds the Movies in the Trakt List to the specified key's playlist. Overrides the [default trakt_list] for that playlist if used.<br>**Values:** List of Trakt List URLs | | | |
| `delete_playlist` | **Description:** Will delete all playlists for the users defined by sync_to_users.<br>**Values:** `true` or `false` |
| `delete_playlist_<<key>>`<sup>1</sup> | **Description:** Will delete the specified key's playlists for the users defined by sync_to_users.<br>**Values:** `true` or `false` |
| `ignore_ids` | **Description:** Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all playlists.<br>**Values:** List or comma-separated string of TMDb/TVDb IDs |
**[Plex (Smart)](../smart)** builders create Smart Collections based on the metadata inside your Plex Server. Results are dynamic and will update as your library updates without the need to re-run Kometa.
**[Plex (Smart)](smart.md)** builders create Smart Collections based on the metadata inside your Plex Server. Results are dynamic and will update as your library updates without the need to re-run Kometa.
[:octicons-alert-24:](""){ .card-link title="Cannot be used for Overlays unless utilizing Smart Labels" }
??? quicklink "Popular Builders"
- [:simple-plex: Smart Label](../smart/#smart-label) - Create a Smart Collection based on a specific label. The label can be generated by Kometa based on criteria.
- [:simple-plex: Smart Filter](../smart/#smart-filter) - Create a Smart Collection based on the filter parameters provided.
- [:simple-plex: Smart Label](smart.md#smart-label) - Create a Smart Collection based on a specific label. The label can be generated by Kometa based on criteria.
- [:simple-plex: Smart Filter](smart.md#smart-filter) - Create a Smart Collection based on the filter parameters provided.
**[Plex (Dumb)](../smart)** builders grab items based on the metadata inside your Plex Server. Results are static and require Kometa to re-run to update.
**[Plex (Dumb)](smart.md)** builders grab items based on the metadata inside your Plex Server. Results are static and require Kometa to re-run to update.
- [:simple-myanimelist: MyAnimeList Popular](../myanimelist/#myanimelist-most-popular) - Gets every anime in MyAnimeList's Most Popular Anime list
- [:simple-myanimelist: MyAnimeList Top All](../myanimelist/#myanimelist-top-all) - Gets every anime in MyAnimeList's Top All Anime list
- [:simple-myanimelist: MyAnimeList Top Airing](../myanimelist/#myanimelist-top-airing) - Gets every anime in MyAnimeList's Top Airing Anime list
- [:simple-myanimelist: MyAnimeList Suggested](../myanimelist/#myanimelist-suggested) - Gets every suggested anime in by MyAnimeList for the authorized user
- [:simple-myanimelist: MyAnimeList Popular](myanimelist.md#myanimelist-most-popular) - Gets every anime in MyAnimeList's Most Popular Anime list
- [:simple-myanimelist: MyAnimeList Top All](myanimelist.md#myanimelist-top-all) - Gets every anime in MyAnimeList's Top All Anime list
- [:simple-myanimelist: MyAnimeList Top Airing](myanimelist.md#myanimelist-top-airing) - Gets every anime in MyAnimeList's Top Airing Anime list
- [:simple-myanimelist: MyAnimeList Suggested](myanimelist.md#myanimelist-suggested) - Gets every suggested anime in by MyAnimeList for the authorized user
| [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple collections |
| [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple collections |
| [`collections`](#collection-operations--attributes) | contains definitions of collections you wish to add to one or more libraries |
| [`external_templates`](templates.md) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple collections |
| [`collections`](#collection-operations-attributes) | contains definitions of collections you wish to add to one or more libraries |
| [`dynamic_collections`](#dynamic-collections) | contains definitions of [dynamic collections](dynamic.md) you wish to create |
* One of `metadata`, `collections` or `dynamic_collections` must be present for the File to run, else you will receive
| [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple Overlays |
| [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays |
| [`external_templates`](templates.md) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays |
| [`overlays`](#overlay-attributes) | contains definitions of Overlays you wish to add to one or more libraries |
* Example Files can be found in the [Kometa Community Configs Repository](https://github.com/Kometa-Team/Community-Configs)
@ -116,7 +116,7 @@ Overlay Files can utilize the following top-level attributes
| [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple overlays |
| [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays |
| [`external_templates`](templates.md) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple overlays |
| [`queues`](#overlay-queues) | contains the positional attributes of queues |
| [`overlays`](#overlay-attributes) | contains definitions of overlays you wish to add |
| [`templates`](templates.md) | contains definitions of templates that can be leveraged by multiple playlists |
| [`external_templates`](templates.md#external-templates) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple playlists |
| [`external_templates`](templates.md) | contains [file blocks](../config/files.md) that point to external templates that can be leveraged by multiple playlists |
| [`playlists`](#playlist-attributes) | contains definitions of playlists you wish to add to the server |
* `playlists` is required in order to run the Playlist File.
@ -28,7 +28,7 @@ Let's start with an unmodified set of collections which do **not** specify a cus
plex_all: true
```
Now let's use the `sort_title` attribute to reorder these collections slightly
@ -48,7 +48,7 @@ Now let's use the `sort_title` attribute to reorder these collections slightly
sort_title: Collection 2
```
The above could also be achieved using any form of ASCII sort order. This example will produce the same outcome, but uses a (perhaps) illogical set of ASCII characters to define the sort title.
@ -89,7 +89,7 @@ Users aren't expected to understand what this does, but users can use the `colle
1. Because the `!` character is a higher priority ASCII character, that will place ahead of the `000` for the seasonal collections.
You can also re-order collections within each Defaults file using the `order_<<key>>` template variable. <<key>> refers to the identifier that Kometa uses for each collection, which you can find on the relative default's wiki page.
@ -114,7 +114,7 @@ You can also re-order collections within each Defaults file using the `order_<<k
1. Because the `!` character is a higher priority ASCII character, that will place ahead of the `000` for the seasonal collections.
2. file has 5 collections, each with a defined key. I have reordered each of the collections to appear in the order that I specified.
@ -46,7 +46,7 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path
This will run Kometa in the background persistently until it is stopped by the user. While the docker container will be persistently running, Kometa will not begin the run until the scheduled time.
Further customizations of the docker run command can be used to specify set times to run Kometa, further information on this and other Run Commands can be found [here](../environmental.md#time-to-run)
Further customizations of the docker run command can be used to specify set times to run Kometa, further information on this and other Run Commands can be found [here](../environmental.md#times)
=== "Windows Task Scheduler"
@ -68,7 +68,7 @@ IMPORTANT: Every time you see `/path/to` below, it's a placeholder for the path
This is the recommended approach as it allows the user additional control over how and when Kometa processes.
If you don't specify a time, the script will run at 5AM each day. You can change this with the [time-to-run](../environmental.md#time-to-run) runtime flag.
If you don't specify a time, the script will run at 5AM each day. You can change this with the [time-to-run](../environmental.md#times) runtime flag.
@ -26,7 +26,7 @@ Wondering how to troubleshoot Kometa and how to read through the meta.log?
In all cases, the first step is to open the [`meta.log`](#locating-log-files) with your text editor and perform these steps:
1. Check that you are running the latest [`version`](#checking-Kometa-version) of your branch. Your current version can be found in the `meta.log` file either below the Kometa ASCII art, or at the end of the run. If you are not on the latest version of your branch, you will see `Newest Version: X.X.X` below this. Ensure you [`upgrade`](install/local.md#i-want-to-update-to-the-latest-version-of-kometa) to the latest version of Kometa.
1. Check that you are running the latest [`version`](#checking-kometa-version) of your branch. Your current version can be found in the `meta.log` file either below the Kometa ASCII art, or at the end of the run. If you are not on the latest version of your branch, you will see `Newest Version: X.X.X` below this. Ensure you [`upgrade`](install/local.md#i-want-to-update-to-the-latest-version-of-kometa) to the latest version of Kometa.
2. When scanning your meta.log file, search for `[CRITICAL]` items first as these will definitely need to be fixed
3. Scan your meta.log file for `[ERROR]` and make a note of the content of the full line to start your search below on how to resolve
As playlists are not tied to one specific library and can combine media from multiple libraries, they require their own special [Playlist Files](../files/playlists.md) to work.
Within the [Config File](overview.md), the `playlist_files` attribute specifies the [path type](../files/files.md#paths) and path of the [Playlist Files](../files/playlists.md) that the user wants Kometa to act on.
Within the [Config File](../config/overview.md), the `playlist_files` attribute specifies the [path type](../config/files.md#file-blocks) and path of the [Playlist Files](../files/playlists.md) that the user wants Kometa to act on.
**The libraries used in the playlist attribute `libraries` must be defined under the `libraries` attribute of the [Config File](overview.md).**
**The libraries used in the playlist attribute `libraries` must be defined under the `libraries` attribute of the [Config File](../config/overview.md).**
@ -51,7 +51,7 @@ Each showcased photo has been confirmed to be fully functional with Kometa v1.19
Custom fonts have been used for the ratings which can be sourced in [bullmoose20's repository](https://github.com/Kometa-Team/Community-Configs/tree/master/bullmoose20) within `fonts.zip`
A [Library Operation](../config/operations.md#mass--rating-update) is used to place the IMDb rating into the user rating slot, as can be seen in the code example.
A [Library Operation](../config/operations.md#mass-star-rating-update) is used to place the IMDb rating into the user rating slot, as can be seen in the code example.
**Click the image to enlarge it**
@ -103,7 +103,7 @@ Each showcased photo has been confirmed to be fully functional with Kometa v1.19
This example uses two Kometa Default Overlay files: [Ratings](../defaults/overlays/ratings.md) and [Runtimes](../defaults/overlays/runtimes.md).
Ratings are set to show the TMDb, Trakt and IMDb ratings, which have been set using [Library Operations](../config/operations.md#mass--rating-update)
Ratings are set to show the TMDb, Trakt and IMDb ratings, which have been set using [Library Operations](../config/operations.md#mass-star-rating-update)
The runtimes overlay is modified to show no text, but to instead produce the black bar which the ratigns sit on top of.
Chaz Larson
3 months ago
committed by
GitHub