Skip to main content

Scrobbler for trakt.tv that supports VLC, Plex, MPC-HC, and MPV

Project description

Trakt Scrobbler

A trakt.tv scrobbler for your computer.

What is Trakt?

Automatically scrobble TV show episodes and movies you are watching to Trakt.tv! It keeps a history of everything you've watched!

What is trakt-scrobbler?

Trakt.tv has a lot of plugins to automatically scrobble the movies and episodes you watch from your media center. But there is a dearth of up-to-date apps for syncing your progress on Desktop environments. This is where trakt-scrobbler comes in! It is a Python application that runs in the background and monitors your media players for any new activity. When it detects some file being played, it determines the media info (such as name of the movie/show, episode number, etc.) and sends this to trakt servers, so that it can be marked as "Currently Watching" on your profile. No manual intervention required!

Features

  • Full featured command line interface to control the service. Just run trakts.
  • Automatic media metadata extraction using guessit.
  • For cases when it misidentifies the files, you can specify a regex to manually extract the necessary details.
  • Scrobbling is independent of the player(s) where the media is played. Support for new players can thus be easily added.
  • Currently supports:
    • VLC (via web interface)
    • Plex (doesn't require Plex Pass)
    • MPV (via IPC server)
    • MPC-BE/MPC-HC (via web interface).
  • Folder whitelisting: Only media files from subdirectories of these folders are synced with trakt.

For more information, see the How it works section.

Getting started

Players

  • VLC: Enable the Lua Web Interface from advanced options. Don't forget to specify the password in Lua options.

    VLC Web Interface

  • Plex: No server side set up is required, as the app uses the existing API. Do note that since this is a polling based approach, it will be inferior to Webhooks. So if you are a premium user of Plex, it is recommended to use that directly. This app is mainly useful for those users who don't need most of the features of Plex Pass.

  • MPV: Enable the JSON IPC, either via the mpv.conf file, or by passing it as a command line option.

  • MPC-BE/MPC-HC: Enable the web interface from Options.

Installation

  1. Ensure you have Python 3.7 or higher installed, and in your system PATH. (Check by running python --version)
  2. Ensure pip is installed. (Check: pip --version)
  3. Open a terminal/powershell.
  4. Install pipx: MacOS:
    brew install pipx
    pipx ensurepath
    
    Linux and windows (replace python3 with python if the commands fail):
    python3 -m pip install --user pipx
    python3 -m pipx ensurepath
    
  5. Run pipx install trakt-scrobbler. You will now have the trakts command available.
  6. Run trakts init. You will be prompted to authorize the program to access the Trakt.tv API. Follow the steps on screen to finish the process.

For Linux: To enable notification support on Linux, libnotify needs to be installed (Reboot after installation).

  • Arch/Manjaro: pacman -S libnotify
  • Ubuntu: apt install libnotify-bin

FAQs

It doesn't work. What do I do?

First, look through the log file to see what went wrong. If you are unable to fix the problem, feel free to create an Issue.

trakts usage:

The various commands available are:

  • auth: Runs the authetication flow for trakt.tv

  • autostart: Controls the autostart behaviour of the scrobbler

  • config: Edits the scrobbler config settings

    • list: This command will list the parameters in the config, along with their current values. Eg: trakts config list

      players.monitored = ['mpv', 'vlc']
      players.skip_interval = 5
      general.enable_notifs = True
      fileinfo.whitelist = ['/path/to/movies', '/path/to/anime', '/path/to/TV']
      

      Additionally, it also accepts a --all option, which can be used to list ALL the config parameters, including those not overriden by the user.

    • set: Set the value for a config parameter.

      • Separate multiple values with spaces. Eg: trakts config set players.monitored mpv vlc mpc-be

        User config updated with 'players.monitored = ['mpv', 'vlc', 'mpc-be']'
        
      • For values containing space(s), surround them with double-quotes. Eg: trakts config set fileinfo.whitelist D:\Media\Movies "C:\Users\My Name\Shows"

        User config updated with 'fileinfo.whitelist = ['D:MediaMovies', 'C:\\Users\\My Name\\Shows']'
        
      • Use --add to avoid overwriting the previous list values (whitelist, monitored, etc.): trakts config set players.monitored mpv vlc trakts config set --add players.monitored plex mpc-hc will have final value:

        User config updated with 'players.monitored = ['mpv', 'vlc', 'plex', 'mpc-hc']'
        
  • init: Runs the initial setup of the scrobbler.

  • run: Run the scrobbler in the foreground. Mainly needed in case you have disabled the autostart service, and want to run the app manually.

  • start: Starts the trakt-scrobbler service. If already running, does nothing.

    • Use --restart to force restart the service.
  • status: Shows the status trakt-scrobbler service.

  • stop: Stops the trakt-scrobbler service.

  • whitelist: Shortcut command to add folder(s) to whitelist in config.

    • For folders containing spaces, use double quotes: trakts whitelist D:\Media\Movies "C:\Users\My Name\Shows"
    • Run trakts whitelist --show to list the current folders in whitelist.

How to update?

  1. Stop the app using trakts stop
  2. Run pipx upgrade trakt-scrobbler

Where is the log file/other data stored?

  • Linux: ~/.local/share/trakt-scrobbler/
  • Mac: Same as config file (see above)
  • Windows: Same as config file (see above)

The latest log is stored in a file named trakt_scrobbler.log; older logs can be found in the files ...log.1, ...log.2, and so on. Everything is in human readable form, so that you can figure out what data is used by the app. While submitting a bug report, be sure to include the log file contents.

How it works

This is an application written in the Python programming language, designed for hassle-free integration of your media players with Trakt. Once set up, you can forget that it exists.

  • The app is designed to start with your PC, and remain running in the backgroud.
  • It has a "monitor" for each media player you specify. This monitor keeps checking if the media player is running or not. If not, you get the "Could not connect..." message in the log file.
  • When the player is running, the monitor extracts the currently playing media information from the player.
  • This media file path is parsed using guessit (or regexes, if specified) to recognize the metadata such as "Title", "Season", etc.
  • This info, along with the playing state (playing, stopped or paused) and progress are then sent to trakt.tv using their API to update their side and mark the media as "Currently Watching", "Finished", etc and you get a notification of the same.
  • Once the player is closed, the monitor goes back to "dormant" state, where it waits for the player to start again.

Other details

  • The checking for media info from player happens at a set interval (poll_interval in config, 10 secs by default), which is the maximum delay between you starting/stopping/pausing the player, and the monitor recognizing that activity.
  • Generally, this app provides "live" updates to trakt regarding your playing status. However, in cases where the internet is down, when you finish playback, the app remembers the media that you have finished watching (progress > 90%) and will try to sync that information with trakt the next time internet becomes available.

Configuration

The config is stored in YAML format. Most parameters have default values, stored in config_default.yaml. You can use the config command to override the alues.

  • 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.
  • fileinfo.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.
    • Mainly useful for Anime since they don't follow the season convention.
  • players.monitored: (List of player names) Specify players which are to be monitored for scrobbling.
  • 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.

TODO

  • [x] Switch to poetry for dependency management
  • [x] Make a unified installer script for all OSes
  • [x] Proper configuration management module with autodetection for players
  • [x] A CLI for controlling the app (start, stop, config, etc.)
  • [ ] Use a proper Windows Service instead of an autostart script

Contributing

Feel free to create a new issue in case you find a bug/want to have a feature added. Proper PRs are welcome.

Authors

Acknowledgements

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for trakt-scrobbler, version 1.0.0b0
Filename, size File type Python version Upload date Hashes
Filename, size trakt_scrobbler-1.0.0b0-py3-none-any.whl (36.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size trakt-scrobbler-1.0.0b0.tar.gz (34.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page