media players - kavinthangavel/Media-Player-Scrobbler-for-Simkl GitHub Wiki
This guide provides comprehensive information about compatible media players and detailed configuration instructions to ensure optimal movie tracking performance.
Media player configuration is a critical step for accurate movie tracking. While the application can work with basic window title detection, configuring your media players for advanced tracking significantly improves accuracy and reliability.
graph TD
A[Tracking Methods] --> B[Basic Tracking]
A --> C[Advanced Tracking]
B -->|Window Title Only| D[Limited Accuracy]
C -->|Player API Integration| E[High Accuracy]
C --> F[Required Setup]
F --> G[Player Configuration]
G --> H[Optimal Performance]
style A fill:#4285f4,stroke:#333,stroke-width:2px,color:#fff
style C fill:#34a853,stroke:#333,stroke-width:2px,color:#fff
style H fill:#fbbc05,stroke:#333,stroke-width:2px,color:#fff
Follow the platform-specific instructions below to set up your preferred media player for the best tracking experience.
Player | Windows | macOS | Linux | Advanced Tracking | Configuration Difficulty |
---|---|---|---|---|---|
VLC | ✅ | ✅ | ✅ | ✅ | Easy |
MPV | ✅ | ✅ | ✅ | ✅ | Moderate |
MPC-HC/BE | ✅ | ❌ | ❌ | ✅ | Easy |
MPC-QT | ✅ | ❌ | ✅ | ✅ | Easy |
Windows Media Player | ✅ | ❌ | ❌ | ❌ | Not Available |
QuickTime | ❌ | ✅ | ❌ | ❌ | Not Available |
MPV Wrappers* | ✅ | ✅ | ✅ | ✅ | Moderate |
Other Players | ✅ | ✅ | ✅ | ❌ | Not Available |
*MPV Wrappers: Celluloid, MPV.net, SMPlayer, IINA, Haruna, etc.
Note: The application currently supports movie tracking only. TV show support is planned for future updates.
Step-by-Step Configuration:
- Open VLC Media Player
- Navigate to Tools → Preferences
- At the bottom left, change Show settings to All
- Navigate to Interface → Main interfaces
- Check the box for Web to enable the web interface
- Go to Interface → Main interfaces → Lua
- Set "simkl" as a password in the Lua HTTP Password field
- Optional: Change the port number (default is 8080)
- Click Save and restart VLC
- Visit http://localhost:8080/
- Enter Your Password (hint: simkl)
For Detailed Step by Step Config Config with Images - Make Sure to set a Password
Verification:
- The scrobbler will automatically connect to VLC on port 8080 (or your custom port)
- Play a movie in VLC to test - you should see accurate position tracking
Windows Configuration:
- Locate or create the MPV configuration directory:
- Press
Win+R
and enter%APPDATA%
to open the Roaming folder Or - Navigate to
%APPDATA%\mpv\
(create it if it doesn't exist)
- Press
- Create or edit
mpv.conf
file - Add the following lines:
# Enable IPC socket for advanced tracking input-ipc-server=\\.\pipe\mpvsocket
- Save the file and restart MPV
Verification:
- Play a movie in MPV
- The scrobbler will connect to the pipe socket
- Position data should be accurately tracked
Windows Configuration:
-
Most MPV wrapper players use the same MPV backend configuration:
- For MPV.net: Configure in
%APPDATA%\mpv.net\mpv.conf
- For Haruna Player: Configure in
%APPDATA%\haruna\mpv.conf
- For Celluloid: Configure in
%APPDATA%\celluloid\mpv.conf
- For MPV.net: Configure in
-
Add the following line to the appropriate configuration file:
# Enable IPC socket for advanced tracking input-ipc-server=\\.\pipe\mpvsocket
-
Save the file and restart the player
Verification:
- Play a movie in your MPV wrapper player
- The scrobbler should connect and show accurate position data
Step-by-Step Configuration:
- Open MPC-HC or MPC-BE
- Navigate to View → Options
- Go to Player → Web Interface
- Check Listen on port: and ensure it's set to 13579 (default)
- Click OK and restart MPC
Verification:
- Play a movie in MPC
- The scrobbler will connect to the web interface
- Position data should be accurately tracked
Step-by-Step Configuration:
- Open MPC-QT
- Navigate to View → Options
- Go to Player → Web Interface
- Check Enable web server
- Ensure port is set to 13579 (default)
- Uncheck the Allow Access From Localhost Only
- Click OK and restart MPC-QT
Verification:
- Play a movie in MPC-QT
- The scrobbler will connect to the web interface
- Position data should be accurately tracked
SMPlayer is a versatile media player that can use MPV as its backend.
Configuration Steps:
- Open SMPlayer
- Go to Options → Preferences
- Click on Advanced in the left sidebar
- Select the MPlayer/MPV tab
- In the Options: field, add:
(for Windows) or
--input-ipc-server=\\.\pipe\mpvsocket
(for Linux/macOS)--input-ipc-server=/tmp/mpvsocket
- Click OK and restart SMPlayer
Verification:
- Play a movie in SMPlayer
- The scrobbler should connect to the MPV backend
- Position data should be accurately tracked
Syncplay allows synchronized playback across multiple users and can use MPV as its player.
Configuration Steps:
- Open Syncplay
- In the configuration dialog, set Media Player to mpv
- In the Player arguments: field, add:
(for Windows) or
--input-ipc-server=\\.\pipe\mpvsocket
(for Linux/macOS)--input-ipc-server=/tmp/mpvsocket
- Click Save and restart Syncplay
Verification:
- Start a Syncplay session and play a movie
- The scrobbler should connect to the MPV backend
- Position data should be accurately tracked
Follow the same configuration steps as shown in the Windows VLC section above.
- Create or locate the MPV configuration directory:
-
~/.config/mpv/
(create it if it doesn't exist)
-
- Create or edit
mpv.conf
- Add the following line:
# Enable IPC socket for advanced tracking input-ipc-server=/tmp/mpvsocket
- Save and restart MPV
macOS Configuration:
-
For IINA:
- IINA uses MPV as its backend
- Configure in
~/.config/mpv/mpv.conf
or - Configure in
~/Library/Application Support/io.iina.iina/mpv.conf
-
Add the following line to the appropriate configuration file:
# Enable IPC socket for advanced tracking input-ipc-server=/tmp/mpvsocket
-
Save the file and restart IINA
Verification:
- Play a movie in your MPV wrapper player
- The scrobbler should connect and show accurate position data
Basic window title tracking only. No advanced integration available.
Follow the same configuration steps as shown in the Windows VLC section above.
- Create or locate the MPV configuration directory:
-
~/.config/mpv/
(create it if it doesn't exist)
-
- Create or edit
mpv.conf
- Add the following line:
# Enable IPC socket for advanced tracking input-ipc-server=/tmp/mpvsocket
- Ensure the socket path has appropriate permissions
- Save and restart MPV
Linux Configuration:
-
Configure the appropriate MPV config file:
- For Celluloid: Configure in
~/.config/mpv/mpv.conf
- For Haruna Player: Configure in
~/.config/haruna/mpv.conf
- For Celluloid: Configure in
-
Add the following line to the appropriate configuration file:
# Enable IPC socket for advanced tracking input-ipc-server=/tmp/mpvsocket
-
Save the file and restart the player
For Celluloid (GNOME MPV):
- Edit the MPV config as above
- In Celluloid, go to Preferences > MPV Configuration
- Add:
input-ipc-server=/tmp/mpvsocket
- Restart Celluloid
graph LR
A[Player Integration Methods] --> B[Web Interface]
A --> C[IPC Socket]
A --> D[Window Title]
B --> E[VLC, MPC]
C --> F[MPV]
D --> G[Other Players]
E --> H[Position + Filename]
F --> H
G --> I[Filename Only]
H --> J[High Accuracy]
I --> K[Basic Accuracy]
style A fill:#4285f4,stroke:#333,stroke-width:2px,color:#fff
style J fill:#34a853,stroke:#333,stroke-width:2px,color:#fff
style K fill:#fbbc05,stroke:#333,stroke-width:2px
With advanced tracking (properly configured players):
- Exact playback position is known
- Precise tracking of watch progress
- Accurate determination of when a movie is completed
- Better handling of pauses and skips
Without player configuration:
- Relies only on window titles
- Less accurate progress estimation
- May miss some watch events
- More prone to false positives/negatives
For optimal movie identification, follow these naming conventions:
graph TD
A[Optimal Movie Filename Format] --> B["MovieTitle (Year).ext"]
B --> C["Inception (2010).mkv"]
B --> D["The Godfather (1972).mp4"]
B --> E["Parasite (2019).avi"]
style A fill:#4285f4,stroke:#333,stroke-width:2px,color:#fff
style C fill:#d5f5e3,stroke:#333,stroke-width:2px
style D fill:#d5f5e3,stroke:#333,stroke-width:2px
style E fill:#d5f5e3,stroke:#333,stroke-width:2px
Recommended Format: MovieTitle (Year).extension
Examples:
Inception (2010).mkv
The Shawshank Redemption (1994).mp4
Pulp Fiction (1994).avi
Additional Tips:
- Include the year for better identification
- Avoid extra text like quality info or release group names in main filename
- Remove unnecessary punctuation
Issue | Possible Cause | Solution |
---|---|---|
VLC connection fails | Web interface not enabled | Enable web interface in VLC settings |
Wrong password | Check the password in VLC Lua HTTP settings | |
Port conflict | Change the port in VLC settings | |
MPV socket error | Incorrect socket path | Verify the path in mpv.conf matches expectations |
Permission issues | Check file permissions on the socket | |
MPC-HC not detected | Web interface disabled | Enable web interface in MPC options |
Wrong port | Verify port is set to 13579 | |
General tracking issues | Filename format | Ensure movie files follow naming best practices |
- Configure your media player according to the instructions
- Start the Media Player Scrobbler for Simkl with debug logging:
simkl-mps tray --debug
- Play a movie in your configured media player
- Check the logs for connection messages and position data
- If successful, position data should appear in the logs
Feature | VLC | MPV | MPC-HC/BE |
---|---|---|---|
Ease of configuration | ★★★★☆ | ★★☆☆☆ | ★★★★☆ |
Cross-platform | ✅ | ✅ | ❌ |
Position accuracy | Very High | High | Very High |
Resource usage | Moderate | Low | Low |
Recommended for | Beginners | Power users | Windows users |
The best player for tracking depends on your platform and preferences, but properly configured VLC offers the most universal compatibility and reliable tracking.