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

7 KiB

Anilist Charts Collections

The anilist Default Collection File is used to create collections based on Anilist charts.

Requirements & Recommendations

Supported Library Types: Movie, Show

Collections Section 020

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.

Config

The below YAML in your config.yml will create the collections:

libraries:
  Movies:
    collection_files:
      - pmm: anilist
  TV Shows:
    collection_files:
      - pmm: anilist

Template Variable Default Values

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.

Variable Description & Values
limit Description: Changes the number of items in a collection for all collections in a Defaults file.
Default: 100
Values: Number greater than 0
limit_<<key>>1 Description: Changes the number of items in a collection of the specified key's collection.
Default: limit
Values: Number greater than 0
sync_mode Description: Changes the Sync Mode for all collections in a Defaults file.
Default: sync
Values:
syncAdd and Remove Items based on Builders
appendOnly Add Items based on Builders
sync_mode_<<key>>1 Description: Changes the Sync Mode of the specified key's collection.
Default: sync_mode
Values:
syncAdd and Remove Items based on Builders
appendOnly Add Items based on Builders
collection_order Description: Changes the Collection Order for all collections in a Defaults file.
Default: custom
Values:
releaseOrder Collection by Release Dates
alphaOrder Collection Alphabetically
customOrder Collection Via the Builder Order
Any plex_search Sort OptionOrder Collection by any plex_search Sort Option
collection_order_<<key>>1 Description: Changes the Collection Order of the specified key's collection.
Default: collection_order
Values:
releaseOrder Collection by Release Dates
alphaOrder Collection Alphabetically
customOrder Collection Via the Builder Order
Any plex_search Sort OptionOrder Collection by any plex_search Sort Option
  1. Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

{% include-markdown "../collection_variables.md" %}

Example Template Variable Amendments

The below is an example config.yml extract with some Template Variables added in to change how the file works.

???+ tip

Anywhere you see this icon:

> :fontawesome-solid-circle-plus:

That's a tooltip, you can press them to get more information.
libraries:
  Movies:
    collection_files:
      - pmm: anilist
        template_variables:
          use_season: false #(1)!
          order_top: 01 #(2)!
          summary_top: "Top 10 Rated movies on AniList" #(3)!
          limit_top: 10 #(4)!
          visible_library_popular: true #(5)!
          visible_home_popular: true #(6)!
          visible_shared_popular: true #(7)!
  1. Do not create the "AniList Season" collection
  2. Change the order of "AniList Top Rated" to appear before other collections created by this file
  3. Amend the summary of the "AniList Top Rated" collection
  4. Only allow a maximum of 10 items to appear in the "AniList Top Rated" collection
  5. Pin the "AniList Popular" collection to the Recommended tab of the library
  6. Pin the "AniList Popular" collection to the home screen of the server owner
  7. Pin the "AniList Popular" collection to the home screen of other users of the server