@ -5,7 +5,8 @@ No configuration is required for these builders.
| Name | Attribute | Description | Works with Movies | Works with Shows |
| :--- | :--- | :--- | :---: | :---: |
| [AniList Top Rated Anime](#anilist-top-rated-anime) | `anilist_top_rated` | Gets every anime in AniList's [Top Rated Anime](https://anilist.co/search/anime?sort=SCORE_DESC) list | :heavy_check_mark: | :heavy_check_mark: |
| [AniList Popular Anime](#anilist-popular-anime) | `anilist_popular` | Gets every anime in AniList's [Popular Anime](https://anilist.co/search/anime?sort=POPULARITY_DESC) list | :heavy_check_mark: | :heavy_check_mark: |
| [AniList Popular Anime](#anilist-popular-anime) | `anilist_popular` | Gets every anime in AniList's [Popular Anime](https://anilist.co/search/anime/popular) list | :heavy_check_mark: | :heavy_check_mark: |
| [AniList Trending Anime](#anilist-trending-anime) | `anilist_trending` | Gets every anime in AniList's [Trending Anime](https://anilist.co/search/anime/trending) list | :heavy_check_mark: | :heavy_check_mark: |
| [AniList Relations](#anilist-relations) | `anilist_relations` | Gets the anime specified by the AniList ID and every relation in its relation tree except Character and Other relations | :heavy_check_mark: | :heavy_check_mark: |
| [AniList Studio](#anilist-studio) | `anilist_studio` | Gets all anime specified by the AniList Studio ID | :heavy_check_mark: | :heavy_check_mark: |
| [AniList ID](#anilist-id) | `anilist_id` | Gets the anime specified by the AniList ID | :heavy_check_mark: | :heavy_check_mark: |
@ -16,7 +17,7 @@ Gets every anime in AniList's [Top Rated Anime](https://anilist.co/search/anime?
The expected input is a single integer value of how many movies/shows to query.
The `sync_mode: sync` option is also recommended since the Trakt Watched lists are continuously updated.
The `sync_mode: sync` option is also recommended since the list is continuously updated.
```yaml
collections:
@ -26,11 +27,11 @@ collections:
```
## AniList Popular Anime
Gets every anime in AniList's [Popular Anime](https://anilist.co/search/anime?sort=POPULARITY_DESC) list.
Gets every anime in AniList's [Popular Anime](https://anilist.co/search/anime/popular) list.
The expected input is a single integer value of how many movies/shows to query.
The `sync_mode: sync` option is also recommended since the Trakt Watched lists are continuously updated.
The `sync_mode: sync` option is also recommended since the list is continuously updated.
```yaml
collections:
@ -39,6 +40,20 @@ collections:
sync_mode: sync
```
## AniList Trending Anime
Gets every anime in AniList's [Trending Anime](https://anilist.co/search/anime/trending) list.
The expected input is a single integer value of how many movies/shows to query.
The `sync_mode: sync` option is also recommended since the list is continuously updated.
```yaml
collections:
Trending Anime:
anilist_trending: 10
sync_mode: sync
```
## AniList Relations
Gets the anime specified by the AniList ID and every relation in its relation tree except Character and Other relations.
@ -77,20 +92,25 @@ Gets 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).
| Attribute | Description | Options | Default |
## 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)<br>`popular` (Sort by Popularity) | `score` |
| `sort_by` | How to sort the Anime | `score` (Sort by Average Score)<br>`popular` (Sort by Popularity)<br>`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)<br>`spring` (For spring season March, April, May)<br>`summer` (For summer season June, July, August)<br>`fall` (For fall season September, October, November)<br>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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | `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 Searches
Tag searches can be used with either no modifier or with `.not`.
## Tag Attributes
Tag attributes can be used with either no modifier or with `.not`.
String search can take multiple values as a **list or a comma-separated string**.
String attributes can take multiple values as a **list or a comma-separated string**.
### Tag Modifiers
@ -101,7 +121,7 @@ String search can take multiple values as a **list or a comma-separated string**
### Tag Attributes
| Tag Search | Description | Options |
| 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` |
@ -109,10 +129,10 @@ String search can take multiple values as a **list or a comma-separated string**
| `tag` | Uses the anime's tag to match | Any Tag in the Genre Dropdown box on the [AniList Search Page](https://anilist.co/search/anime) |
| `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](https://anilist.co/search/anime) |
## Date Searches
Date searches can be used with either `.before`, or `.after`.
## Date Attributes
Date attributes can be used with either `.before`, or `.after`.
No date search can take multiple values.
No date attribute can take multiple values.
### Date Modifiers
@ -123,15 +143,15 @@ No date search can take multiple values.
### Date Attributes
| Date Search | Description |
| Date Attributes | Description |
| :--- | :--- |
| `start` | Uses the anime start date attribute to match |
| `end` | Uses the anime end date attribute to match |
## Number Searches
Number searches must use `.gt`, `.gte`, `.lt`, or `.lte` as a modifier.
Number attributes must use `.gt`, `.gte`, `.lt`, or `.lte` as a modifier.
No number search can take multiple values.
No number attribute can take multiple values.
### Number Modifiers
@ -144,7 +164,7 @@ No number search can take multiple values.
### Number Attributes
| Number Search | Description | Restrictions |
| 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` |
@ -61,10 +61,13 @@ All the following attributes serve various functions as how the collection funct
| Name | Attribute | Description | Allowed Values |
| :--- | :--- | :--- | :--- |
| Collection Name | `collection_name` | Used to specify the name off the collection in Plex as different then the mapping name. | Any String |
| Schedule | `schedule` | Used to schedule this collection | [`schedule` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Schedule-Detail) |
| Template | `template` | Used to specify a template and template variables to use for this collection | [`template` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Template-Attributes) |
| Run Again | `run_again` | Used to try and add all the items missing from the collection to the collection again after the daily run <br>**Default Mode:** `false`| **boolean:**`true` or `false` |
| Sync Mode | `sync_mode` | Used to change how collection builders sync with this collection<br>**Default Mode:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | `append`: Only Add Items to the Collection<br>`sync`: Add & Remove Items from the Collection |
| Collection Minimum | `collection_minimum` | Minimum items that must be found to add to a collection.<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | number greater then 0 |
| Delete Below Minimum | `delete_below_minimum` | Delete existing collection if below the minimum.<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:**`true` or `false` |
| Validate Builders | `validate_builders` | When set to false the collection will not fail if one builder fails<br>**Default Mode:** `true` | **boolean:**`true` or `false` |
| Build Collection | `build_collection` | When set to false the collection won't be created but items can still be added to Radarr/Sonarr<br>**Default Mode:** `true` | **boolean:**`true` or `false` |
| Missing Only Released | `missing_only_released` | Collection Level `missing_only_released` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:**`true` or `false` |
@ -9,7 +9,7 @@ You can use `plex_all: true` to start your filter from your entire library.
**Filters can be very slow. Try to build or narrow your collection using [Plex Search](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Plex-Builders#plex-search) if possible.**
## String Filters
String filters can be used with either no modifier or with `.not`, `.begins`, `.ends`, or `.regex`.
String filters can be used with either no modifier or with `.not`, `.is`, `.isnot`, `.begins`, `.ends`, or `.regex`.
String filters can take multiple values **only as a list**.
@ -19,6 +19,8 @@ String filters can take multiple values **only as a list**.
| :--- | :--- |
| No Modifier | Matches every item where the attribute contains the given string |
| `.not` | Matches every item where the attribute does not contain the given string |
| `.is` | Matches every item where the attribute exactly matches the given string |
| `.isnot` | Matches every item where the attribute does not exactly match the given string |
| `.begins` | Matches every item where the attribute begins with the given string |
| `.ends` | Matches every item where the attribute ends with the given string |
| `.regex` | Matches every item where the attribute matches the regex given |
@ -58,7 +58,7 @@ Any Advance Filter made using the Plex UI should be able to be recreated using `
like Plex's [Advance Filters](https://support.plex.tv/articles/201273953-collections/) you have to start each search with either `any` or `all` as a base. You can only have one base attribute and all search attributes must be under the base.
Inside the base attribute you can use any search below or nest more `any` or `and`. You can have as many nested `any` or `and` next to each other as you want. If using multiple `any` or `and` you will have to do so in the form of a list.
Inside the base attribute you can use any search below or nest more `any` or `all`. You can have as many nested `any` or `all` next to each other as you want. If using multiple `any` or `all` you will have to do so in the form of a list.
There are a couple other attributes you can have at the top level only along with the base attribute are:
@ -95,7 +95,7 @@ There are a couple other attributes you can have at the top level only along wit
There are three fields per search option when using 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).
## String Searches
String searches can be used with either no modifier or with `.not`, `.begins`, or `.ends`.
String searches can be used with either no modifier or with `.not`, `.is`, `.isnot`, `.begins`, or `.ends`.
String search can take multiple values **only as a list**.
@ -105,6 +105,8 @@ String search can take multiple values **only as a list**.
| :--- | :--- | :---: |
| No Modifier | Matches every item where the attribute contains the given string | `contains` |
| `.not` | Matches every item where the attribute does not contain the given string | `does not contain` |
| `.is` | Matches every item where the attribute exactly matches the given string | `is` |
| `.isnot` | Matches every item where the attribute does not exactly match the given string | `is not` |
| `.begins` | Matches every item where the attribute begins with the given string | `begins with` |
| `.ends` | Matches every item where the attribute ends with the given string | `ends with` |
@ -193,7 +195,7 @@ No number search can take multiple values.
| Image Assets For All* | `assets_for_all` | Search in assets for images for every item in your library | false | :heavy_check_mark: | :heavy_check_mark: | :x: |
| Create Asset Folders | `create_asset_folders` | When using `assets_for_all` if this is set to true PMM will create the Movie/Shows Folder for assets to be placed in | false | :heavy_check_mark: | :heavy_check_mark: | :x: |
| Sync Mode | `sync_mode` | `append`: Only Add Items to the Collection<br>`sync`: Add & Remove Items from the Collection | append | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Collection Minimum | `collection_minimum` | Minimum items that must be found to add to a collection. | 1 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Delete Below Minimum | `delete_below_minimum` | Delete existing collection if below the minimum.<br>**boolean:** true or false | false | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| [Run Again Delay](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Collection-Details#setting-attributes) | `run_again_delay` | Number of minutes to run `run_again` collections after daily run is finished<br>**number:** 0 or greater | 0 | :heavy_check_mark: | :x: | :x: |
| Missing Only Released | `missing_only_released` | Library Level toggle to filter missing items from a collection that have yet to be released.<br>**boolean:** true or false | false | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Show Unmanaged Collections | `show_unmanaged` | Show collections not managed by Plex Meta Manager at the end of each run<br>**boolean:** true or false | true | :heavy_check_mark: | :heavy_check_mark: | :x: |
@ -19,7 +19,7 @@ Any Advance Filter made using the Plex UI should be able to be recreated using `
like Plex's [Advance Filters](https://support.plex.tv/articles/201273953-collections/) you have to start each filter with either `any` or `all` as a base. You can only have one base attribute and all filter attributes must be under the base.
Inside the base attribute you can use any filter below or nest more `any` or `and`. You can have as many nested `any` or `and` next to each other as you want. If using multiple `any` or `and` you will have to do so in the form of a list.
Inside the base attribute you can use any filter below or nest more `any` or `all`. You can have as many nested `any` or `all` next to each other as you want. If using multiple `any` or `all` you will have to do so in the form of a list.
There are a couple other attributes you can have at the top level only along with the base attribute are:
@ -56,7 +56,7 @@ There are a couple other attributes you can have at the top level only along wit
There are three fields per filter option when using Plex's Advance Filters in the Web UI. The first is the **Attribute** (what attribute you wish to filter), the second is the **Modifier** (which modifier to use), and the third is the **Term** (actual term to filter).
## String Filters
String filters can be used with either no modifier or with `.not`, `.begins`, or `.ends`.
String filters can be used with either no modifier or with `.not`, `.is`, `.isnot`, `.begins`, or `.ends`.
String filter can take multiple values **only as a list**.
@ -66,6 +66,8 @@ String filter can take multiple values **only as a list**.
| :--- | :--- | :---: |
| No Modifier | Matches every item where the attribute contains the given string | `contains` |
| `.not` | Matches every item where the attribute does not contain the given string | `does not contain` |
| `.is` | Matches every item where the attribute exactly matches the given string | `is` |
| `.isnot` | Matches every item where the attribute does not exactly match the given string | `is not` |
| `.begins` | Matches every item where the attribute begins with the given string | `begins with` |
| `.ends` | Matches every item where the attribute ends with the given string | `ends with` |
@ -154,7 +156,7 @@ No number filter can take multiple values.
meisnate12
3 years ago