Skip to main content

Automatic Media Scrobbler for Simkl

Project description

🎬 Media Player Scrobbler for Simkl

Platform Ask DeepWiki

SIMKL MPS Logo
Automatic media tracking for all your media players

✨ Features

  • 🎮 Supports Every Famous Media Player (VLC, PotPlayer, MPV, MPC-HC and more)
  • 🌐 Cross-Platform – Windows, macOS, Linux
  • 🖥️ Native Executable – System tray, auto-update, and background service (Windows)
  • 📈 Accurate Position Tracking – For supported players (configure via Media Players Guide)
  • 🔌 Offline Support – Queues updates when offline
  • 🧠 Smart Media Detection – Intelligent filename parsing
  • 🍿 Media-Focused – Optimized for every type of media (Movies,TV Shows and Anime)

⚡ Quick Start

  • Windows: Use the Windows Guide (EXE installer, tray app, no commands needed).
  • Linux: Use the Linux Guide (pipx recommended, tray app, setup command needed).
  • macOS: Use the Mac Guide (pip install, tray app, setup command needed, untested).

After installation, authenticate with SIMKL and configure your media players using the Media Players Guide (this step is critical for accurate tracking).

📚 Documentation

🔍 How It Works

graph LR
    A[Media Player] -->|Player Title| B[Simkl Scrobbler]
    B -->|Parse Title| C[Media Identification]
    C -->|Track Progress| D[Simkl API]
    D -->|Mark as Watched| E[Simkl Profile]
    
    style A fill:#d5f5e3,stroke:#333,stroke-width:2px
    style E fill:#d5f5e3,stroke:#333,stroke-width:2px

🚦 Performance Notes

Online:

  • Player Detection: ~4.2 sec
  • Media Info Scrobble: ~3.7 sec
  • Notification: ~1.5 sec
  • Completion Detection Delay: ~5.2 sec
  • Completion Sync: ~13.3 sec
  • Completion Notification: ~1.5 sec

Offline:

  • Media Scrobble: ~1.2 sec
  • Notification: ~0.5 sec
  • Completion Save: ~3 sec
  • Completion Notification: ~0.5 sec

📝 License

See the LICENSE file for details.

🤝 Contributing

Contributions are welcome! Please submit a Pull Request.

☕ Support & Donate

If you find this project useful, consider supporting development: Donate via CoinDrop

🙏 Acknowledgments

🛠️ Related Tools

These tools can help organize and rename media files automatically, which can improve the accuracy and ease of scrobbling.

  • FileBot - Media File Renaming
  • TVRename - TV File Data Automation (Optional)
  • Shoko - Anime File Data Automation (Optional)

Project details


Download files

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

Source Distribution

simkl_mps-2.2.1.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simkl_mps-2.2.1-py3-none-any.whl (2.3 MB view details)

Uploaded Python 3

File details

Details for the file simkl_mps-2.2.1.tar.gz.

File metadata

  • Download URL: simkl_mps-2.2.1.tar.gz
  • Upload date:
  • Size: 2.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.11.13 Linux/6.11.0-1018-azure

File hashes

Hashes for simkl_mps-2.2.1.tar.gz
Algorithm Hash digest
SHA256 844c3a28e791586972d594f5c2a6b37777aed42466e593df107b9f2a2ed8b5bb
MD5 8586cf88b2a59d3b101869ce50716e47
BLAKE2b-256 9638c579052e4d50eda75e334da229c530ea049baed12952f1d0085c21d0a5dc

See more details on using hashes here.

File details

Details for the file simkl_mps-2.2.1-py3-none-any.whl.

File metadata

  • Download URL: simkl_mps-2.2.1-py3-none-any.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.11.13 Linux/6.11.0-1018-azure

File hashes

Hashes for simkl_mps-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c10e2918e935fdfcf96db0c0e7a9413e6a1b71a9914b6e85ecf22ed9c6754f2f
MD5 73417edd598b24274f613956d2bd1778
BLAKE2b-256 0dabc475a27d9b9b0af344f096d1b707bdac9812134daf1002f476d40c31c388

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page