simkl-mps 2.0.4

Automatic Media Scrobbler for Simkl

🎬 Media Player Scrobbler for Simkl

Automatic movie tracking for all your media players

✨ Features

• 🎮 Universal Media Player Support (VLC, MPV, MPC-HC and more)
• 🌐 Cross-Platform – Windows, macOS (experimental), 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 Movie Detection – Intelligent filename parsing
• 🍿 Movie-Focused – Currently optimized for movies (TV show tracking planned)

⚡ 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, experimental/untested).

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

📚 Documentation

• Windows Guide
• Linux Guide
• Mac Guide
• Supported Media Players
• Usage Guide
• Advanced & Developer Guide
• Troubleshooting Guide
• Todo List

🔍 How It Works

graph LR
    A[Media Player] -->|Player Title| B[Simkl Scrobbler]
    B -->|Parse Title| C[Movie 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

• 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

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

• Simkl – API platform
• guessit – Filename parsing
• iamkroot's Trakt Scrobbler – Inspiration
• masyk – Logo and technical guidance

---

Made with ❤️ by kavinthangavel

⭐ Star us on GitHub • 🐞 Report Bug • ✨ Request Feature