Skip to content

Latest commit

 

History

History
218 lines (170 loc) · 14 KB

AniList-Builders.md

File metadata and controls

218 lines (170 loc) · 14 KB
Raw

You can find anime using the features of AniList.co (AniList).

No configuration is required for these builders.

Name Attribute Description Works with Movies Works with Shows Works with Playlists and Custom Sort
AniList Top Rated Anime anilist_top_rated Finds every anime in AniList's Top Rated Anime list ✔️ ✔️ ✔️
AniList Popular Anime anilist_popular Finds every anime in AniList's Popular Anime list ✔️ ✔️ ✔️
AniList Trending Anime anilist_trending Finds every anime in AniList's Trending Anime list ✔️ ✔️ ✔️
AniList Relations anilist_relations Finds the anime specified by the AniList ID and every relation in its relation tree except Character and Other relations ✔️ ✔️ ❌
AniList Studio anilist_studio Finds all anime specified by the AniList Studio ID ✔️ ✔️ ❌
AniList ID anilist_id Finds the anime specified by the AniList ID ✔️ ✔️ ❌
AniList Search anilist_search Finds the anime specified by the AniList search parameters provided ✔️ ✔️ ✔️

AniList Top Rated Anime

Finds every anime in AniList's Top Rated Anime list.

The expected input is a single integer value of how many movies/shows to query.

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Top Rated Anime:
    anilist_top_rated: 30
    collection_order: custom
    sync_mode: sync

AniList Popular Anime

Finds every anime in AniList's Popular Anime list.

The expected input is a single integer value of how many movies/shows to query.

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Popular Anime:
    anilist_popular: 10
    collection_order: custom
    sync_mode: sync

AniList Trending Anime

Finds every anime in AniList's Trending Anime list.

The expected input is a single integer value of how many movies/shows to query.

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

collections:
  Trending Anime:
    anilist_trending: 10
    collection_order: custom
    sync_mode: sync

AniList Relations

Finds the anime specified by the AniList ID and every relation in its relation tree except Character and Other relations.

The expected input is an AniList ID. Multiple values are supported as either a list or a comma-separated string.

collections:
  One Piece:
    anilist_relations: 21

AniList Studio

Finds all anime specified by the AniList Studio ID.

The expected input is an AniList ID. Multiple values are supported as either a list or a comma-separated string.

collections:
  Studio Ghibli:
    anilist_studio: 21

AniList ID

Finds the anime specified by the AniList ID.

The expected input is an AniList ID. Multiple values are supported as either a list or a comma-separated string.

collections:
  Cowboy Bebop:
    anilist_id: 23, 219

AniList Search

Finds the anime specified by the AniList Search the options are detailed below.

There are three fields per search option when using AniList's Search just like Plex's Advance Filters in the Web UI. The first is the Attribute (what attribute you wish to search), the second is the Modifier (which modifier to use), and the third is the Term (actual term to search).

The sync_mode: sync and collection_order: custom Details are recommended since the lists are continuously updated and in a specific order.

Special Attributes

Special attributes do not support any modifiers.

Special Attribute Description Options Default
sort_by How to sort the Anime score (Sort by Average Score)
popular (Sort by Popularity)
trending (Sort by Trending)		 score
limit Number of Anime to query int (use 0 or don't use it at all for all anime) 0
search Text to search Any Text N/A
season Season to search for winter (For winter season December, January, February)
spring (For spring season March, April, May)
summer (For summer season June, July, August)
fall (For fall season September, October, November)
Leave blank for the Current Season
year Season year to search for int 1917 - next year or leave blank for the current year
min_tag_percent Minimum tag percentage for the Anime int 0-100 N/A
adult Search for or not for Adult Anime true or false N/A
country Search for anime from a specific country ISO 3166-1 alpha-2 country code N/A
source Uses the anime's source to match original, manga, light_novel, visual_novel, video_game, other, novel, doujinshi, anime N/A

Tag Attributes

Tag attributes can be used with either no modifier or with .not.

String attributes can take multiple values as a list or a comma-separated string.

Tag Modifiers

Tag Modifier Description
No Modifier Matches every item where the attribute matches the given string
.not Matches every item where the attribute does not match the given string

Tag Attributes

Tag Attribute Description Options
format Uses the anime's format to match tv, short, movie, special, ova, ona, music
status Uses the anime's status to match finished, airing, not_yet_aired, cancelled, hiatus
genre Uses the anime's genre to match Any Genre in the Genre Dropdown box on the AniList Search Page
tag Uses the anime's tag to match Any Tag in the Genre Dropdown box on the AniList Search Page
tag_category Uses the anime's tag category to match Any Tag Category in the Advance Genres & Tag Filters Menu on the AniList Search Page

Date Attributes

Date attributes can be used with either .before, or .after.

No date attribute can take multiple values.

Date Modifiers

Date Modifier Description Format
.before Matches every item where the date attribute
is before the given date		 Format: MM/DD/YYYY
e.g. 01/01/2000
.after Matches every item where the date attribute
is after the given date		 Format: MM/DD/YYYY
e.g. 01/01/2000

Date Attributes

Date Attributes Description
start Uses the anime start date attribute to match
end Uses the anime end date attribute to match

Number Searches

Number attributes must use .gt, .gte, .lt, or .lte as a modifier.

No number attribute can take multiple values.

Number Modifiers

Number Modifier Description Format
.gt Matches every item where the number attribute
is greater then the given number		 Format: number
e.g. 30, 1995, or 7.5
.gte Matches every item where the number attribute
is greater then or equal to the given number		 Format: number
e.g. 30, 1995, or 7.5
.lt Matches every item where the number attribute
is less then the given number		 Format: number
e.g. 30, 1995, or 7.5
.lte Matches every item where the number attribute
is less then or equal to the given number		 Format: number
e.g. 30, 1995, or 7.5

Number Attributes

Number Attribute Description Restrictions
duration Uses the duration attribute to match using minutes minimum: 1
episodes Uses the number of episodes attribute to match minimum: 1
score Uses the score attribute to match minimum: 1
popularity Uses the popularity attribute to match minimum: 1

AniList Search Examples

collections:
  Current Anime Season:
    anilist_search:
      season:
      year:
      sort_by: popular
    collection_order: custom
    sync_mode: sync
collections:
  Fall 2020 Anime:
    anilist_search:
      season: fall
      year: 2020
    collection_order: custom
    sync_mode: sync
collections:
  Pirates Anime:
    anilist_search:
      tag: Pirates
      sort_by: popular
    collection_order: custom
    sync_mode: sync
collections:
  Top Sports Anime:
    anilist_genre:
      genre: Sports
      limit: 20
      sort_by: popular
    collection_order: custom
    sync_mode: sync