Skip to content

Home

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

🎬 MPS for SIMKL

GitHub License PyPI Version Python Versions Platform

SIMKL MPS Logo
Automatic movie tracking for all your media players

What is MPS for SIMKL?

MPS for SIMKL (Media Player Scrobbler) is a cross-platform app that automatically tracks your movie watching in popular media players and syncs your progress to your SIMKL account. It runs in the background or system tray, requires minimal setup, and supports Windows, macOS, and Linux.

⚡ Quick Start

  • Windows: Download the installer and follow the setup wizard.

  • macOS/Linux: [Testing in Progress]

    pip install simkl-mps
simkl-mps start

  • Authenticate with SIMKL when prompted.

See the Installation Guide for full details.

📚 Documentation

🔍 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: Monitors active windows to detect media players
  2. Identification: Extracts and matches media titles against SIMKL
  3. Tracking: Monitors playback position
  4. Completion: Marks as watched when threshold is reached
  5. Sync: Updates your SIMKL profile automatically

🚦 Performance Notes

  • Movie identification: 15–30 seconds (typical)
  • Mark as watched (online): 2–8 seconds (best connection)
  • Offline scrobble: 4–10 seconds to process title, 1–3 seconds to add to backlog after threshold

📝 License

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

Clone this wiki locally