GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → StareInTheAir → mpv-trakt-sync-daemon

StareInTheAir / mpv-trakt-sync-daemon

Licence: other
Python daemon that scrobbles watch progress from https://mpv.io to https://trakt.tv

Programming Languages

python
139335 projects - #7 most used programming language
VBScript
123 projects
Batchfile
5799 projects

Labels

scrobblesynchronizationtraktmpvdaemon

Projects that are alternatives of or similar to mpv-trakt-sync-daemon

Monstache
a go daemon that syncs MongoDB to Elasticsearch in realtime
Stars: ✭ 736 (+1695.12%)
Mutual labels:  synchronization, daemon
Rats
Movie Ratings Synchronization with Python
Stars: ✭ 156 (+280.49%)
Mutual labels:  synchronization, trakt
rescrobbled
MPRIS music scrobbler daemon
Stars: ✭ 152 (+270.73%)
Mutual labels:  scrobble, daemon
mpv-scripts
A collection of scripts for mpv player
Stars: ✭ 138 (+236.59%)
Mutual labels:  mpv
tpm2-abrmd
TPM2 Access Broker & Resource Management Daemon implementing the TCG spec.
Stars: ✭ 97 (+136.59%)
Mutual labels:  daemon
karaokemugen-app
Karaoke player and manager (Backup repository. Main is https://gitlab.com/karaokemugen/karaokemugen-app )
Stars: ✭ 30 (-26.83%)
Mutual labels:  mpv
UserFileSystemSamples
IT Hit User File System Engine samples in .NET/C#. Samples implement Virtual File System for Windows and Mac with synchronization support, on-demand loading, offline files, and Windows File Manager integration.
Stars: ✭ 60 (+46.34%)
Mutual labels:  synchronization
watchdogd
Advanced system & process supervisor for Linux
Stars: ✭ 146 (+256.1%)
Mutual labels:  daemon
Anime4K
Makes it easy to encode a Anime using Anime4K with predefined encoding profiles!
Stars: ✭ 61 (+48.78%)
Mutual labels:  mpv
hasses
Hyper's Asynchronous Server Sent event (SSE) notification Server
Stars: ✭ 18 (-56.1%)
Mutual labels:  daemon
gr-eventstream
gr-eventstream is a set of GNU Radio blocks for creating precisely timed events and either inserting them into, or extracting them from normal data-streams precisely. It allows for the definition of high speed time-synchronous c++ burst event handlers, as well as bridging to standard GNU Radio Async PDU messages with precise timing easily.
Stars: ✭ 38 (-7.32%)
Mutual labels:  synchronization
user-session-synchronizer
Wordpress plugin that allows to keep the user logged in from one installation to another by synchronizing user data and cookie session based on a verified email
Stars: ✭ 21 (-48.78%)
Mutual labels:  synchronization
jsynchronous
Jsynchronous.js - Data synchronization for games and real-time web apps.
Stars: ✭ 111 (+170.73%)
Mutual labels:  synchronization
ios
EteSync - Secure, end-to-end encrypted, and privacy respecting sync for your contacts, calendars and tasks.
Stars: ✭ 40 (-2.44%)
Mutual labels:  synchronization
dokuwiki-plugin-sync
Sync DokuWiki namespaces with a remote wiki on request
Stars: ✭ 16 (-60.98%)
Mutual labels:  synchronization
HJSynchronizeDemo
No description or website provided.
Stars: ✭ 14 (-65.85%)
Mutual labels:  synchronization
final-pm
Finally a good node.js process manager.
Stars: ✭ 21 (-48.78%)
Mutual labels:  daemon
ShellRemoteBot
Shell remote control from telegram (SSH/terminal emulator)
Stars: ✭ 28 (-31.71%)
Mutual labels:  daemon
shinit
Basic Init Daemon in POSIX sh
Stars: ✭ 17 (-58.54%)
Mutual labels:  daemon
v-switch
Virtual Encrypted Switch across the network, using UDP + AES + TAP
Stars: ✭ 27 (-34.15%)
Mutual labels:  daemon
View All Similar Projects ➔

mpv trakt sync daemon

This project is able to monitor what files you are currently watching within mpv, figure out exact meta information about the tv show or movie (using guessit) and send this information to trakt. This daemon is supposed to always be running in the background and, when mpv is started, starts the sync process. It uses the mpv's JSON IPC to extract data from the running mpv instance.

mpv setup

You need to set the --input-ipc-server (see docs) in every mpv instance you want to be tracked. This is done most easily inside the mpv.conf file by adding the line

input-ipc-server=/tmp/mpv-socket

Or on Windows with:

input-ipc-server=\\.\pipe\mpv

The daemon will look for the input-ipc-server option in the config file.

Config parameters

All adjustable options are exposed via the config.json file.

Parameter Explanation
monitored_directories List of strings | Default: []
Fill in which directories or URLs you want the daemon scan for shows or movies. If empty, all files played in mpv are scanned. You can prevent the daemon 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. On Windows, you need to use \\ instead of \.
excluded_directories List of strings | Default: ["https://www.youtube.com/"]
Fill in which directories or URLs should be ignored by the daemon when scanning for shows or movies. If empty, no files played in mpv are ignored. This option overrides monitored_directories, meaning if one directory is monitored and ignored, it will be ignored. On Windows, you need to use \\ instead of \.
seconds_between_mpv_running_checks Integer or float | Default: 30.0
The time in seconds the daemon sleeps between checking if mpv is running. The bigger the number the less load on your machine, but also the longer the daemon potentially takes to find a new running mpv instance.
seconds_between_mpv_event_and_trakt_sync Integer or float | Default: 10.0
Used as a cooldown timer to prevent too many requests to the trakt API, when changing the playback position rapidly. x seconds need to pass between your last playback change action and synchronization call to trakt. Needs to be less than seconds_between_regular_get_property_commands otherwise sync only happens when mpv was closed.
seconds_between_regular_get_property_commands Integer or float | Default: 30.0
Number of seconds between regular requests to mpv to keep track of playback state. See 'Limitations' section.
factor_must_watch_before_scrobble Integer or float | Default: 0.1
How much of a video file do you need to watch before it counts as a valid 'view' as a factor between 0.0 and 1.0. Implemented to prevent 'Have I seen this episode?'-fast-fowards to create a duplicate history item in trakt. Set to 0.0 to disable the feature.
percent_minimal_playback_position_before_scrobble Integer or float | Default: 90.0
At what playback position percentage does a view session count as finished? This in combination with the factor_must_watch_before_scrobble parameter controls, when a view session is considered as finished.

Setup

I recommend to setup a Python virtual environment instead of installing the dependencies globally.

Windows

First-time use

  1. Download and install Python 3.7.x from their website. Make sure to check the 'Add to PATH' option in the install wizard.
  2. Download this repository as a zip and extract it to a static install location (maybe %APPDATA%\mpv-trakt-sync-daemon?)
  3. Open command prompt (Win+R > cmd > Enter)
  4. pip install virtualenv (virtualenv is installed globally)
  5. cd %APPDATA%\mpv-trakt-sync-daemon (Changes directory to your install location)
  6. virtualenv venv (Virtual environment created in venv folder)
  7. venv\Scripts\activate.bat (Virtual environment activated)
  8. pip install -r requirements-win.txt (Dependencies installed in virtualenv)
  9. python sync_daemon.py (Start daemon manually)
  10. Follow the printed instructions to grant this daemon permission to your trakt account.
  11. Start watching files in mpv and monitor correct operation (Output is also written to sync_daemon.log)

Install as an autostart background service

I recommend using win-launch.bat over win-hidden-launch.vbs because of less complications with virus scanners. The only downside of win-launch.bat over win-hidden-launch.vbs is a very brief flash of a command prompt.

  1. Win+R > shell:startup > Enter (Opens autostart directory for current user)
  2. Win+R > %APPDATA%\mpv-trakt-sync-daemon > Enter (Opens install location)
  3. Hold the Alt key down and drag win-launch.bat from the install location to the autostart folder to create a shortcut
  4. The daemon now starts automatically on login

Unix

First-time use

  1. Install python3, pip and git from your package manager of choice
  2. pip install virtualenv
  3. cd into install location
  4. git clone https://github.com/StareInTheAir/mpv-trakt-sync-daemon.git
  5. cd mpv-trakt-sync-daemon
  6. virtualenv venv
  7. source venv/bin/activate
  8. pip install -r requirements.txt
  9. ./sync_daemon.py
  10. Follow the printed instructions to grant this daemon permission to your trakt account.
  11. Start watching files in mpv and monitor correct operation (Output is also written to sync_daemon.log)

Install as an autostart background service

If your OS has systemd:

  1. Put the correct path to the cloned repository into mpv-trakt-sync.service
  2. cp mpv-trakt-sync.service ~/.config/systemd/user/
  3. systemctl --user daemon-reload
  4. systemctl --user enable mpv-trakt-sync
  5. systemctl --user start mpv-trakt-sync
  6. systemd will now launch the daemon on boot

macOS

First-time use

  1. Setup brew
  2. brew install python3
  3. pip install virtualenv
  4. cd into install location
  5. git clone https://github.com/StareInTheAir/mpv-trakt-sync-daemon.git
  6. cd mpv-trakt-sync-daemon
  7. virtualenv venv
  8. source venv/bin/activate
  9. pip install -r requirements.txt
  10. ./sync_daemon.py

Install as an autostart background service

Contributed by Sameer Jain. Thank you.

  1. Put the correct path to the cloned repository into mpv-trakt-sync.plist
  2. cp mpv-trakt-sync.plist ~/Library/LaunchAgents/
  3. launchctl load ~/Library/LaunchAgents/mpv-trakt-sync.plist
  4. launchctl list | grep com.github.stareintheair.mpv-trakt-sync-daemon (shows output if mpv-trakt-sync-daemon is running)

Limitations

  • Only one mpv instance can be tracked (because only one mpv process can write to the socket / named pipe)
  • Once mpv is closing, requests can no longer be sent to it. To keep track of your playback position requests need to be sent in regular intervals, so that when mpv quits the last known state can be used for determining your playback state.

Why not as as a mpv Lua plugin?

  • When mpv quits, I imagine, sending out a blocking http request to the trakt API isn't the best. When you want mpv to quit, it should quit instantly. A separate daemon is better suited to accomplish this task.
  • guessit is really good at parsing release names and it's also written in Python
  • I don't know Lua :)

useful resources

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].