Skip to content

Configuration

Jump to bottom
iamkroot edited this page Nov 12, 2022 · 8 revisions

Overview

  • The config is stored in YAML format at OS dependent locations:

    • Linux: ~/.config/trakt-scrobbler/config.yaml
    • MacOS: ~/Library/Application Support/trakt-scrobbler/config.yaml
    • Windows: C:\Users\<username>\AppData\Roaming\trakt-scrobbler\config.yaml

  • Most parameters have default values, stored in config_default.yaml.

  • The file is hierarchical, with multiple sections such as general, players, etc.

  • Everything you see on the left hand side of a : is a key. This means players is a key, vlc is a key, and so is poll_interval.

  • You can use the config command to override the values easily.

  • To access a config parameter, use the dotted-notation - use a . to go down a hierarchy level.
    Example: players.vlc.poll_interval selects what you think it selects :P
    (The _ is not special, it's just a way for programmers to represent spaces in names)

Reference

general

enable_notifs

  • Enables various notifications for stuff like scrobbles and errors (Default: true)
$ trakts config set general.enable_notifs false

  • You can also individually toggle the notifications for specific categories:

    • exception: For notifying you of errors in the program, recommended to keep enabled.
    • misc: Miscellaneous stuff
    • scrobble: Various scrobble notifications. Can be set to true/false to enable/disable all sub-categories.
      • start
      • pause
      • resume
      • stop
    • trakt: For some trakt related notifications (like "no search results")

  • Example: To enable notifications of only start and stop sub-categories:

$ trakts config set general.enable_notifs.scrobble.pause false

$ trakts config set general.enable_notifs.scrobble.resume false

notif_actions

  • Configures the actions to interact with notifications where available.

  • Example: Provides a "Open on trakt.tv" button after each scrobble.

enabled

  • Enables notification actions (Default: true)
$ trakts config set general.notif_actions.enabled false

  • You can toggle individual categories in the same way as enable_notifs

  • Example: To only show the scrobble actions when stopping the playback:

$ trakts config set general.notif_actions.enabled.scrobble false  # first, disable all actions

$ trakts config set general.notif_actions.enabled.scrobble.stop true  # then, enable actions only for stop

primary_interface

  • how to interact with the first (most prominent) action (Default: button)

    • button: Show a button in the notification popup. Supported everywhere but looks ugly.
    • click: Entire notification is clickable, will hide the button. Can lead to a de-cluttered UI.

  • if there are multiple actions they will still show up as buttons

allowed_scrobbles

  • Specifies the kinds of scrobbles that are sent to trakt (Default: {episode: all, movie: all})
$ trakts config set general.allowed_scrobbles.movie none

$ trakts config set general.allowed_scrobbles.episode stop-only

This will disable all scrobbles for movies, and will only send "stop" scrobbles for episodes.

  • Allowed values: all (=send "start", "stop" and "pause"), none (=send nothing), stop-only (=send only "stop")

proxies

(Default: {})

  • Defines the proxies to be used for external connections.
$ trakts config set general.proxies.https "socks5://my-proxy.example.com:1234"

This adds a SOCKSv5 proxy for the HTTPS protocol, and is identical to setting proxies = {'https': 'socks5://my-proxy.example.com:1234'} in the Python requests library, or in YML form:

proxies:
    https: socks5://my-proxy.example.com:1234
  • See this for format.

fileinfo

  • Note that these configs are not applicable to the Plex monitor, since we do not depend on file paths for extracting media information in that case.

whitelist

  • List of directories you want to be scanned for shows or movies.
  • If empty, all files played in the player are scanned. This is the default.
  • You can prevent the program from scanning all played files if your shows and movies are located in fixed directories.
  • If possible you should use this option to minimize traffic on the Trakt API.
  • You can also specify patterns for remote urls. See Remote URL patterns
  • See whitelist command for a shortcut to manage this setting.

exclude_patterns

  • List of regex patterns
  • Files matching any of these patterns will never be scrobbled, even if they are whitelisted.
  • Can be used to ignore some common sub-directories, such as Featurettes or Extras 
$ trakts config set --add fileinfo.exclude_patterns ".*/Featurettes/.*"

This will cause the app to ignore any files that come under a "Featurettes" subdirectory.

include_regexes

(Default: {movie = [], episode = []})

  • If you find that the default module for identifying media info (guessit) is misidentifying some titles, you can specify the regex for that file path.
$ trakts config set --add fileinfo.include_regexes.episode ".*/(?P<title>.+?)(\s\[[0-9]{3,4}p\])?/(?P<episode>\d+) - (?:.*)"

This adds a new regex string (everything between the ") to the list of episode regexes, which can be used to extract info from Anime episodes of the form Name of anime [720p]/12 - episode name.mkv

  • To learn more about regexes, use regexone.com and to test your patterns, use regex101.com in Python mode.
  • The regex should have posix-like path (folders separated by /), and shouldn't use Windows' \ to separate directories.
  • The minimum required information is the title of the file, and episode number in the case of TV Shows.
  • If season is not provided, it will default to 1. This is mainly useful for anime since they don't follow the SxxExx format and fail to be recognized by the default parser.

players

monitored

Specify players which are to be monitored for scrobbling. Valid values should be taken from taken from the table in section Enabling monitors. (Default: [], no player is monitored)

$ trakts config set --add players.monitored vlc

This will add vlc to the list of monitored players.

skip_interval

Min percent jump to consider for scrobbling to trakt. Useful when you skip ahead a few seconds, and don't want to spam the trakt API. (Default: 5)

Other player specific parameters

For most installations, you won't have to fiddle with these as the config is set to auto-detect, where the app can automatically read the settings of the players and extract the necessary values.

backlog

clear_interval

How often the app should try to sync previously failed scrobbles with trakt. (Default: 1800 i.e., 30 minutes)

expiry

The maximum time an item can remain in the backlog. (Default: 2592000 i.e., 30 days)

Clone this wiki locally