Kometa Documentation

Tautulli Builders allow you to leverage Tautulli's watch analytics to find items in your Plex libraries. These builders can identify the most watched or most popular Movies and Shows.

Supported Builders:

Kometa is a tool for managing media libraries (such as Plex) by providing granular control over metadata, collections, and overlays.

Key capabilities include:

• Metadata Customization: Customize artwork, titles, and summaries.
• Automated Collections: Use services like TMDb, Trakt, and IMDb to build collections based on trending content, streaming services, networks, studios, genres, actors, or decades.
• Overlays: Create visual overlays for your media.
• Automation: Integrate with Sonarr and Radarr to automate library growth.
• External Management: Since metadata is managed via configuration files outside the media server database, customizations are easy to back up, move between servers, or reapply after a database loss.

Kometa uses letterboxdpy to power Letterboxd support. This allows you to find items based on data from Letterboxd.com. While builder inputs remain consistent with other Kometa builders, the underlying data is now driven by the fields exposed by letterboxdpy rather than Kometa's custom scraping logic.

Note: All Letterboxd builders listed below work with Movies and Playlists/Custom Sort, but they do not work with Shows.

The modules/ directory contains the core logic and integration components for Kometa. It includes modules for interacting with various media metadata providers (e.g., TMDb, IMDb, AniList), notification services (e.g., Apprise, Gotify, Ntfy), and media server integrations (e.g., Plex, Radarr, Sonarr).

Key functional areas include:

• Metadata Providers: TMDb, IMDb, AniDB, AniList, TVDb, Trakt, Letterboxd, etc.
• Media Server & Management: Plex, Radarr, Sonarr, Tautulli.
• Notifications: Apprise, Gotify, Notifiarr, Ntfy, Webhooks.
• Core Utilities: Config management, file handling (Metadata, Overlay, Playlist), and validation.

Kometa provides Radarr Builders that allow you to manage and organize items in your Plex library using metadata and features from Radarr.

Prerequisite: You must complete the Configuring Radarr setup in your configuration file before using any Radarr builders.

Kometa can use Sonarr features to identify items in your Plex library. This is achieved through Sonarr Builders.

Prerequisite: You must have Sonarr configured in your Kometa configuration before using these builders.

Kometa's configuration validation includes a schema validation mode that checks your configuration files against official JSON schemas.

Key behaviors:

• Type Errors: If a value does not match the expected type (e.g., providing a list where a boolean is expected), it is treated as a hard Error.
• Additional Properties (Gaps): If you use a key that is not defined in the schema (e.g., a typo or an unsupported option), it is not treated as an error. Instead, it is collected into a Schema Gap Report. This allows you to identify unused or unsupported keys without failing the validation process.
• Missing Schemas: If the schema directory is missing, the validator will issue a warning but will not fail the validation.

Kometa uses a hierarchical structure called File Blocks to organize libraries. A library configuration consists of parent attributes (like collection_files or playlist_files) containing one or more blocks. Each block is defined by a - and must specify a Location Type and a Path (or identifier).

libraries:
  Movies:
    collection_files:   # Parent Attribute
      - default: tmdb       # Block 1
      - default: imdb       # Block 2

Dynamic Collections allow Kometa to automatically generate collections based on library criteria rather than manual list definitions. Examples include:

• Collections for top TMDb people (e.g., Bruce Willis).
• Collections for each decade (e.g., Best of 1990s).
• Collections for moods/styles in Music libraries.
• Collections based on Trakt User Lists.

Refer to the Dynamic Collections documentation for a full list of available options.