Plex-Meta-Manager/docs/defaults/chart/anilist.md

66 lines
5 KiB
Markdown
Raw Normal View History

# Anilist Chart Default Metadata File
2022-10-07 20:56:11 +00:00
The `anilist` Metadata File is used to create collections based on Anilist charts.
2022-10-07 20:56:11 +00:00
This file works with Movie and TV Libraries.
The below YAML in your config.yml will create the collections:
2022-10-07 20:56:11 +00:00
```yaml
libraries:
Movies:
metadata_path:
2022-10-06 17:34:41 +00:00
- pmm: anilist
2022-10-07 20:56:11 +00:00
TV Shows:
metadata_path:
- pmm: anilist
```
2022-10-07 20:56:11 +00:00
## Collections
2022-10-07 20:56:11 +00:00
| Collection | Key | Description |
|:--------------------|:----------:|:-----------------------------------------------------|
| `AniList Popular` | `popular` | Collection of the most Popular Anime on AniList. |
| `AniList Top Rated` | `top` | Collection of the Top Rated Anime on AniList. |
| `AniList Trending` | `trending` | Collection of the Trending Anime on AniList. |
| `AniList Season` | `season` | Collection of the Current Season's Anime on AniList. |
2022-10-07 20:56:11 +00:00
### Examples
2022-10-07 20:56:11 +00:00
![](../images/anilist.png)
2022-10-07 20:56:11 +00:00
## Template Variables
2022-10-07 20:56:11 +00:00
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
2022-10-07 20:56:11 +00:00
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.
2022-10-07 20:56:11 +00:00
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
2022-10-07 20:56:11 +00:00
| Variable | Description & Values |
|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `limit` | **Description:** Changes the number of items in a collection for all collections in a Defaults file.<br>**Values:** Number greater then 0 |
| `limit_<<key>>` | **Description:** Changes the number of items in a collection of the specified key's Collection.<br>**Values:** Number greater then 0 |
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Values:**<table class="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](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `collection_order_<<key>>` | **Description:** Changes the Collection Order of the specified key's Collection.<br>**Values:**<table class="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](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
2022-10-07 20:56:11 +00:00
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:
Movies:
metadata_path:
- pmm: anilist
template_variables:
2022-10-07 20:56:11 +00:00
use_popular: false
order_top: 01
summary_top: "Top 10 Rated movies on AniList"
limit_top: 10
visible_library_popular: true
visible_home_popular: true
visible_shared_popular: true
2022-10-07 20:56:11 +00:00
sonarr_add_missing: true
collection_section: 09
collection_mode: show_items
```