Configuration

Overview

• The config is stored in YAML format.

• 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. (See Commands Reference)

• 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: (Default: true) Enable notifications after successful scrobbles.
  • proxies: (Default: {})
    • Defines the proxies to be used for external connections.
    • See this for format.
    • Example command: 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

• fileinfo:
  • whitelist: (List of folder path strings | Default: [] aka Allow all)
    • List of directories you want to be scanned for shows or movies.
    • If empty, all files played in the player are scanned.
    • 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.
  • 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.
    • The regex should have posix-like path, and not 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 found, it defaults to 1.
    • Example command: 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
    • 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: (List of player names | Default: []) Specify players which are to be monitored for scrobbling.
  • skip_interval: (Default: 5) 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.
  • Other player specific parameters: For most installations, you won't have to fiddle with these as the app can automatically read the settings of the players and extract the necessary values.
• backlog:
  • clear_interval: (Default: 1800 i.e., 30 minutes) How often the app should try to sync previously failed scrobbles with trakt.
  • expiry: (Default: 2592000 i.e., 30 days) The maximum time an item can remain in the backlog.