Configuring GitHub is optional but can allow you to avoid rate limits when requesting data from GitHub.
Requests made with a GitHub token have a higher rate limit than anonymous requests.
A github mapping is in the root of the config file, sampled below.
config.yml GitHub sample
github:token:thisismytoken
Attribute
Description
Allowed Values (default in bold)
Required
token
GitHub personal access token.
Any valid token or leave blank
The GitHub Personal Access Token (PAT) can be generated here.
Kometa does not have any remarkable requirements here; it requires read access to public repos only. Kometa does not require write access or access to anything other than public repos. You may want to use this key to access your own or others' private repos, and if that's the case you will have to set the permissions on this key as required to enable what you want to do with it.
If you wish, you can create a fine-grained PAT granting finer-grained permissions as required by your intended use.
The expiration, note, name, and description are all up to you. Kometa has no requirements here and there is no "right answer" aside from what Github accepts in those fields.
These services do not store season or episode-level ratings, using these options will allow show ratings to be
applied at the season or episode level.
YAML Lists Explained
YAML supports different ways to define lists. Below are some common methods:
1. List Within a Mapping
fruits:
- apple
- banana
- cherry
2. Inline Style
fruits: [ apple, banana, cherry ]
Each style can be used depending on your needs. The block style is typically more readable for longer lists,
while the inline style is compact and useful for short lists.
YAML Dictionaries Explained
Dictionaries are used to associate key/value pairs that are unordered. Dictionaries can be nested by increasing
the indentation,
or new dictionaries can be created at the same level by resolving the previous one.
cache: true cache_expiration: 60
The "keys" are cache and cache_expiration and the "values" are true and
60 respectively.
You can use multiple score filters but the number will have to match every filter. All unrated items are considered
to have a 0 rating.
These filters only work if the URL is to the List View of the Letterboxd list (i.e. it should have
/detail/ in the URL) or to an account's Reviews (i.e. it should have
/USERNAME/films/reviews/ in the URL).
This filter only works if the URL is to the List View of the Letterboxd list (i.e. it should have
/detail/ in the URL).
When title is not provided and the mapping name was not specified as an ID, the default behaviour is to
use the mapping name as title for matching.
When mapping_id is not provided and the mapping name was specified as an ID, the default behaviour is
to use the mapping name as mapping_id for matching.
When the server does not have a Plex Pass then the Edition Field is not accessible. In this scenario, Kometa will
check the movie's filepath for {edition-...} to determine what the edition is.
Requires Plex Pass.
Must be using the New Plex Movie Agent or the New Plex TV Agent.
Each default has a key that when calling to effect a specific collection/overlay you must replace
<<key>> with when calling.
You can use current_year to have Kometa use the current year's value. This can be combined with a
-# at the end to subtract that number of years. i.e. current_year-2
Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count
modifiers.
You can use current_year to have Kometa use the current year's value. This can be combined with a
-# at the end to subtract that number of years. i.e. current_year-2
Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count
modifiers.
You can use current_year to have Kometa use the current year's value. This can be combined with a
-# at the end to subtract that number of years. i.e. current_year-2
Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count
modifiers.
Also is a Tag Filter and can use all of those modifiers.
Requires Template Variables to function
Designed to use the TRaSH Guides filename naming scheme
Editions overlay is designed to use the Editions field within Plex (which requires Plex Pass to use) or the TRaSH Guides filename naming scheme
Designed to use the TRaSH Guides filename naming scheme
While these overlays can technically be applied at this level, they were not designed for it. For example, a show's
season cannot have a resolution since it is not a video file, and an episode cannot have a Common Sense rating since
only Movies and Shows are rated by Common Sense.
