Skip to content

Home

Jump to bottom
kavinthangavel edited this page Apr 24, 2025 · 19 revisions

MPS for SIMKL

GitHub License PyPI Version Python Versions Platform

SIMKL MPS Logo
Your media, automatically tracked whenever you watch it

What is MPS for SIMKL?

MPS for SIMKL (Media Player Scrobbler for SIMKL) is an automatic scrobbler for SIMKL that tracks your media playback across various media players and updates your SIMKL account. The application runs silently in the background, requiring minimal setup and maintenance while ensuring your watch history stays up-to-date.

✨ Features

  • Automatic Tracking: Detects when you're watching media and scrobbles it to your SIMKL account
  • Smart Media Detection: Intelligently identifies movies and shows from filenames
  • Multiple Media Players: Supports VLC, MPV, MPC-HC, PotPlayer, and more
  • System Tray Interface: Convenient controls and status information
  • Cross-Platform: Full support for Windows, macOS, and Linux
  • Offline Support: Records your watched media when offline and syncs automatically when connection is restored
  • Position Tracking: Monitors actual playback position for supported players
  • Auto-Update System: Stay current with the latest features and improvements (Windows installer)

⚡ Quick Start

Windows:

Download the installer from the Releases Page

Other platforms or manual installation:

# 1. Install via pip
pip install simkl-mps

# 2. Start the application
simkl-mps start

# 3. Authenticate when prompted and enjoy automatic tracking!

📚 Documentation

For detailed information, check out the following sections:

🔍 How It Works

graph TD
    A[Media Player] -->|Active Window| B[MPS for SIMKL]
    B -->|Extract Information| C[Parse Media Title]
    C -->|Search| D[SIMKL API]
    D -->|Metadata| E[Track Progress]
    E -->|>80% Complete| F[Mark as Watched]
    F -->|Update| G[SIMKL Profile]
    
    style A fill:#d5f5e3,stroke:#333,stroke-width:2px
    style G fill:#d5f5e3,stroke:#333,stroke-width:2px
Loading
  1. Detection: The application monitors active windows to detect media players
  2. Identification: Media titles are extracted and matched against the SIMKL database
  3. Tracking: Playback position is monitored through window focus or player APIs
  4. Completion: When you've watched enough (default: 80%), it's marked as watched
  5. Synchronization: Your SIMKL profile is updated automatically

📄 License

MPS for SIMKL is licensed under the GNU GPL v3 License. See the LICENSE file for details.

Clone this wiki locally