You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
216 lines
6.7 KiB
216 lines
6.7 KiB
# Collection Defaults
|
|
|
|
There are many Default Collection Files built into Kometa itself which offer an easy-to-use and customizable set of
|
|
Collections that the user can achieve without having to worry about creating the files that makes the collections
|
|
possible.
|
|
|
|
This is the simplest way to create Collections using Kometa.
|
|
|
|
{%
|
|
include-markdown "./collection_list.md"
|
|
|
|
%}
|
|
|
|
## Configurations
|
|
|
|
To run a default Kometa Collection file you can simply add it to your `collection_files` using `default` like so:
|
|
|
|
```yaml
|
|
libraries:
|
|
Movies:
|
|
collection_files:
|
|
- default: actor
|
|
- default: genre
|
|
```
|
|
|
|
## Separators
|
|
|
|
Most Metadata files use separators to denote different sections of collection like actor collections vs studio
|
|
collections.
|
|
|
|
**Chart Separator and Award Separator each have their own file, while the other Separators are part of their respective
|
|
files.**
|
|
|
|
<details>
|
|
<summary>Click to expand to see an example of Separators.</summary>
|
|
|
|
|
|
|
|
</details>
|
|
|
|
### Library On/Off
|
|
|
|
Chart Separators are turned On by default (except `seasonal`), to turn the Separators On/Off on a per Library basis.
|
|
|
|
```yaml
|
|
libraries:
|
|
LIBRARYNAME:
|
|
template_variables:
|
|
use_separator: false
|
|
collection_files:
|
|
- default: actor
|
|
- default: genre
|
|
```
|
|
|
|
## Collection Section Order
|
|
|
|
All Default Collection Files have a `collection_section` attribute. These attributes determine the order of the various
|
|
sections and can be set by [customizing your config](#customizing-configs).
|
|
|
|
For example: `collection_section: 01` translates to `sort_title: "!<<collection_section>><<pre>><<order_<<key>>>><<sort>>"`
|
|
and so for `genre` if you have a `Fantasy` collection, plex is going to show `!06_Fantasy`
|
|
|
|
This is the default Kometa collection ordering:
|
|
|
|
| Collection | Collection Section |
|
|
|:---------------------|:-------------------|
|
|
| `seasonal` | `000` |
|
|
| `basic` | `010` |
|
|
| `anilist` | `020` |
|
|
| `imdb` | `020` |
|
|
| `letterboxd` | `020` |
|
|
| `myanimelist` | `020` |
|
|
| `other_chart` | `020` |
|
|
| `tautulli` | `020` |
|
|
| `tmdb` | `020` |
|
|
| `trakt` | `020` |
|
|
| `streaming` | `030` |
|
|
| `universe` | `040` |
|
|
| `network` | `050` |
|
|
| `genre` | `060` |
|
|
| `studio` | `070` |
|
|
| `country` | `080` |
|
|
| `region` | `081` |
|
|
| `continent` | `082` |
|
|
| `based` | `085` |
|
|
| `audio_language` | `090` |
|
|
| `subtitle_language` | `095` |
|
|
| `decade` | `100` |
|
|
| `year` | `105` |
|
|
| `content_rating_us` | `110` |
|
|
| `content_rating_uk` | `110` |
|
|
| `content_rating_de` | `110` |
|
|
| `content_rating_mal` | `110` |
|
|
| `content_rating_cs` | `110` |
|
|
| `resolution` | `120` |
|
|
| `aspect` | `125` |
|
|
| `bafta` | `130` |
|
|
| `berlinale` | `130` |
|
|
| `cannes` | `130` |
|
|
| `cesar` | `130` |
|
|
| `choice` | `130` |
|
|
| `emmy` | `130` |
|
|
| `golden` | `130` |
|
|
| `oscars` | `130` |
|
|
| `spirit` | `130` |
|
|
| `nfr` | `130` |
|
|
| `pca` | `130` |
|
|
| `razzie` | `130` |
|
|
| `sundance` | `130` |
|
|
| `tiff` | `130` |
|
|
| `venice` | `130` |
|
|
| `actor` | `140` |
|
|
| `director` | `150` |
|
|
| `producer` | `160` |
|
|
| `writer` | `170` |
|
|
|
|
## Customizing Configs
|
|
|
|
Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables`
|
|
will be given to every template call in the file which allows them to affect how that file runs.
|
|
|
|
This example disables two keys, which will prevent those collections from being created. It also sets the visibility of
|
|
one of the keys so that it is visible on the library tab, the server owner's homescreen and shared user's homescreens
|
|
(assuming they server owner and/or the shared users have the library pinned to their homescreen)
|
|
|
|
```yaml
|
|
libraries:
|
|
TV Shows:
|
|
collection_files:
|
|
- default: imdb
|
|
template_variables:
|
|
use_popular: false
|
|
use_lowest: false
|
|
visible_library_top: true
|
|
visible_home_top: true
|
|
visible_shared_top: true
|
|
```
|
|
|
|
Each file has a page on the wiki showing the available `template_variables` for each file. For example the default
|
|
`default: genre` has a page [here](both/genre.md).
|
|
|
|
**In addition to the defined `template_variables` almost all default Metadata files have access to the
|
|
[Shared Variables](collection_variables.md).**
|
|
|
|
### Examples
|
|
|
|
For example if you want yearly oscar collections that go back 10 years instead of 5 all of which gets sent to radarr
|
|
use the `data` and `radarr_add_missing` template variables.
|
|
|
|
```yaml
|
|
libraries:
|
|
Movies:
|
|
collection_files:
|
|
- default: oscars
|
|
template_variables:
|
|
radarr_add_missing: true
|
|
data:
|
|
starting: latest-10
|
|
ending: latest
|
|
```
|
|
|
|
Or maybe you want to change the number of actor collections made using default: actor.
|
|
|
|
```yaml
|
|
libraries:
|
|
Movies:
|
|
overlay_files:
|
|
- default: actor
|
|
template_variables:
|
|
collection_mode: hide
|
|
data:
|
|
depth: 5
|
|
limit: 50
|
|
```
|
|
|
|
Or maybe you want to change the collection sort order of the genre collections using default: genre.
|
|
|
|
```yaml
|
|
libraries:
|
|
Movies:
|
|
collection_files:
|
|
- default: genre
|
|
template_variables:
|
|
collection_section: 11
|
|
```
|
|
|
|
Or maybe you want to disable separators globally per library.
|
|
|
|
```yaml
|
|
libraries:
|
|
LIBRARYNAME:
|
|
template_variables:
|
|
use_separator: false
|
|
collection_files:
|
|
- ...
|
|
```
|
|
|
|
Alternatively it can be turned off individually per git file:
|
|
|
|
```yaml
|
|
libraries:
|
|
LIBRARYNAME:
|
|
collection_files:
|
|
- default: <file1> # separator is disabled
|
|
template_variables:
|
|
use_separator: false
|
|
- default: <file2> # separator is enabled by default
|
|
- default: <file3> # separator is disabled
|
|
template_variables:
|
|
use_separator: false
|
|
```
|
|
|
|
{%
|
|
include-markdown "./example.md"
|
|
%}
|