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.
97 lines
8.9 KiB
97 lines
8.9 KiB
# MyAnimeList Charts Collections
|
|
|
|
The `myanimelist` Default Collection File is used to create collections based on MyAnimeList Charts.
|
|
|
|
|
|
|
|
## Requirements & Recommendations
|
|
|
|
Supported Library Types: Movie, Show
|
|
|
|
## <a id="collection_section"></a>Collections Section 020
|
|
|
|
| Collection | Key | Description |
|
|
|:-------------------------|:------------|:--------------------------------------------------------|
|
|
| `MyAnimeList Popular` | `popular` | Collection of the most Popular Anime on MyAnimeList. |
|
|
| `MyAnimeList Favorited` | `favorited` | Collection of most Favorited Anime on MyAnimeList. |
|
|
| `MyAnimeList Top Rated` | `top` | Collection of the Top Rated Anime on MyAnimeList. |
|
|
| `MyAnimeList Top Airing` | `airing` | Collection of the Top Rated Airing on MyAnimeList. |
|
|
| `MyAnimeList Season` | `season` | Collection of the Current Seasons Anime on MyAnimeList. |
|
|
|
|
## Config
|
|
|
|
The below YAML in your config.yml will create the collections:
|
|
|
|
```yaml
|
|
libraries:
|
|
Movies:
|
|
collection_files:
|
|
- default: myanimelist
|
|
TV Shows:
|
|
collection_files:
|
|
- default: myanimelist
|
|
```
|
|
|
|
## Template Variables
|
|
|
|
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.
|
|
|
|
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
|
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
|
|
|
??? abstract "Variable Lists (click to expand)"
|
|
|
|
* **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file.
|
|
|
|
* **Shared Template Variables** are additional variables shared across the Kometa Defaults.
|
|
|
|
=== "File-Specific Template Variables"
|
|
|
|
| Variable | Description & Values |
|
|
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number greater than 0 |
|
|
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.<br>**Default:** `limit`<br>**Values:** Number greater than 0 |
|
|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
|
| `starting_only` | **Description:** Changes the season collection to only use anime listed under the new section on [MAL Seasons](https://myanimelist.net/anime/season/)<br>**Default:** `False`<br>**Values:** `True` or `False` |
|
|
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the [key's](#collection_section) collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
|
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
|
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the [key's](#collection_section) collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
|
| `style` | **Description:** Changes the color scheme of the collection posters.<br>**Default:** `color`<br>**Values:** `color` or `white` |
|
|
|
|
1. Each default collection has a `key` [see here]() that you must replace
|
|
`<<key>>` with when using this template variable. These keys are found in the table at the top of this page.
|
|
|
|
=== "Shared Template Variables"
|
|
|
|
{%
|
|
include-markdown "../collection_variables.md"
|
|
%}
|
|
|
|
???+ example "Example Template Variable Amendments"
|
|
|
|
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
|
|
|
Click the :fontawesome-solid-circle-plus: icon to learn more
|
|
|
|
```yaml
|
|
libraries:
|
|
Movies:
|
|
collection_files:
|
|
- default: myanimelist
|
|
template_variables:
|
|
use_season: false #(1)!
|
|
order_popular: 01 #(2)!
|
|
limit_popular: 20 #(3)!
|
|
visible_library_popular: true #(4)!
|
|
visible_home_popular: true #(5)!
|
|
visible_shared_popular: true #(6)!
|
|
```
|
|
|
|
1. Do not create the "MyAnimeList Season" collection
|
|
2. Change the order of "MyAnimeList Popular" to appear before all other collections created by this file
|
|
3. Limit the "MyAnimeList Popular" collection to 20 items.
|
|
4. Pin the "MyAnimeList Popular" collection to the Recommended tab of the library
|
|
5. Pin the "MyAnimeList Popular" collection to the home screen of the server owner
|
|
6. Pin the "MyAnimeList Popular" collection to the home screen of other users of the server
|