Skip to content

Kometa Wiki

Domestic

BoxOfficeMojo Domestic¶

Uses the Domestic Box Office to collect items.

Builder Attribute: mojo_domestic

Builder Value: Dictionary of Attributes

Builder Attributes¶

Attribute	Description
`range`	Determines the type of time range of the Box Office. Allowed Values: `daily`, `weekend`, `weekly`, `monthly`, `quarterly`, `yearly`, `season`, or `holiday`
`year`	Determines the year of the Box Office. This attribute is ignored for the `daily` range. Default Value: `current` Allowed Values: Number between 1977 and the current year, `current`, or relative current (`current-#`)
`range_data`	Determines the actual time range of the Box Office. The input changes depending on the value of `range`. Required: Yes, except for `yearly` range
`limit`	The maximum number of results to return. Default Value: Returns all results Allowed Values: Number greater than 0

Allowed Values for `range_data`¶

Range	Allowed Values
`daily`	Date in the format `MM-DD-YYYY`, `current`, or relative (`current-#`) where `#` is days before current
`weekend`	Week number (1–53), `current`, or relative (`current-#`) where `#` is days before current
`weekly`	Week number (1–53), `current`, or relative (`current-#`) where `#` is days before current
`monthly`	`january`, `february`, ..., `december`, `current`, or relative (`current-#`) where `#` is days before current
`quarterly`	`q1`, `q2`, `q3`, `q4`, `current`, or relative (`current-#`) where `#` is days before current
`season`	`winter`, `spring`, `summer`, `fall`, `holiday`, or `current`
`holiday`	`new_years_day`, `new_year_weekend`, `mlk_day`, `mlk_day_weekend`, `presidents_day`, `presidents_day_weekend`, `easter`, `easter_weekend`, `memorial_day`, `memorial_day_weekend`, `independence_day`, `independence_day_weekend`, `labor_day`, `labor_day_weekend`, `indigenous_day`, `indigenous_day_weekend`, `halloween`, `thanksgiving`, `thanksgiving_3`, `thanksgiving_4`, `thanksgiving_5`, `post_thanksgiving_weekend`, `christmas_day`, `christmas_weekend`, `new_years_eve`

Example Mojo Domestic Builder(s)¶

collections:
  Current Domestic Box Office:
    mojo_domestic:
      range: yearly
      year: current

  Last Year's Domestic Box Office:
    mojo_domestic:
      range: yearly
      year: current-1

  Last Month's Top 10 Domestic Box Office:
    mojo_domestic:
      range: monthly
      range_data: current
      year: current-1
      limit: 10

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.

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.

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

Filters using the special episodes/tracks filter with the default percent.

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.

Filters using the special episodes/tracks filter with the default percent.

Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count modifiers.

Filters using the special episodes/tracks filter with the default percent.

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

Filters using the special episodes/tracks filter with the default percent.

Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count modifiers.

Filters using the special episodes/tracks filter with the default percent.

Also filters out missing movies/shows from being added to Radarr/Sonarr. These values also cannot use the count modifiers.

The field will be locked if a previous mass_poster_update or mass_background_update was run, or if an Overlay has been applied.

Kometa checks for the Overlay label on the item in Plex to determine if an Overlay is applied.