windows guide - ByteTrix/Media-Player-Scrobbler-for-Simkl GitHub Wiki
This guide covers install, setup, and daily usage for Windows users.
The Windows installer provides the most streamlined experience with automatic updates and system integration.
flowchart LR
A[Download Installer] --> B[Run as Administrator]
B --> C[Accept License Agreement]
C --> D[Choose Install Location]
D --> E[Select Components]
E --> F[Configure Settings]
F --> G[Complete Installation]
G --> H[Launch Application]
H --> I[Authenticate with SIMKL]
I --> J[Configure Media Players]
style A fill:#4285f4,stroke:#333,stroke-width:2px,color:#fff
style G fill:#34a853,stroke:#333,stroke-width:2px,color:#fff
style J fill:#fbbc05,stroke:#333,stroke-width:2px,color:#fff
- Download the latest installer
- Right-click the installer and select "Run as administrator" (recommended)
- Follow the setup wizard:
- Accept the license agreement
- Choose your preferred installation location (optional)
- Select components to install:
- Desktop shortcut
- Start menu shortcuts
- Auto-start on login (recommended)
- Auto-update checking (recommended)
- All-in-one package: Includes all dependencies (no separate Python installation required)
- System integration: Creates desktop and start menu shortcuts
- Auto-start capability: Option to run automatically when Windows starts
- Auto-update system: Checks for updates weekly
- Clean uninstallation: Properly removes all components
- The installer now honors common enterprise parameters: use
/quiet,/silent,/s,/qn, or/passivewhen automating deployments - Each alias maps internally to Inno Setup's
/VERYSILENT /SUPPRESSMSGBOXES /NORESTARTflags, ensuring the Microsoft Store silent install check succeeds - Combine additional switches such as
/LOG="C:\\temp\\mpss-install.log"as needed; they will be preserved when silent aliases are used - When running interactively, the traditional
/SILENTor/VERYSILENToptions continue to function unchanged
After installation completes:
- The application launches automatically
- Authenticate with your SIMKL account when prompted
- A system tray icon appears in the notification area
- CRITICAL STEP: Configure your media players for optimal tracking (see below)
For the best tracking experience, configure your preferred media players: Media Players
Right-click the system tray icon to access:
flowchart TD
A[System Tray Icon] -->|Right-click| B[Context Menu]
B --> C[Status Information]
B --> D[Start/Pause Tracking]
B --> E[Scrobbling]
E --> E1[Retry Last Scrobble]
E --> E2[Sync Backlog Now]
E --> E3[Completion Threshold]
E --> E4[Open Local Watch History]
B --> E5[SIMKL]
E5 --> E5A[Authenticate/Re-auth]
E5 --> E5B[Open Website]
E5 --> E5C[Open Watch History]
B --> F[Maintenance]
F --> F1[Open Logs]
F --> F2[Open Data Folder]
F --> F3[Clear Backlog]
F --> F4[Clear Cache]
F --> F5[Clear Watch History]
F --> F6[Clear Logs]
F --> F7[Reset App Data]
B --> G[More]
G --> G1[Donate β€οΈ]
G --> G2[Check for Updates]
G --> G3[Help]
G --> G4[About]
B --> H[Exit]
style A fill:#4285f4,stroke:#333,stroke-width:2px,color:#fff
style D fill:#34a853,stroke:#333,stroke-width:2px,color:#fff
style F fill:#fbbc05,stroke:#333,stroke-width:2px
- Status information: Current monitoring state and connection status
- Start/Pause Tracking: Pause or resume tracking on demand
-
Scrobbling: Recovery and threshold controls
- Retry Last Scrobble: Clears cache for the active file and attempts to re-identify and scrobble it. Use when the wrong title/episode appears.
- Sync Backlog Now: Immediately processes any offline scrobbles waiting in backlog.
- Completion Threshold: Quickly switch between preset watch thresholds (65%, 80%, 90%) or define a custom percentage.
- Open Local Watch History: Open the local watch history viewer in your web browser.
-
SIMKL: Account and service management
- Authenticate / Re-authenticate: Launch the SIMKL login flow if you are signing in for the first time or need to refresh an expired token.
- Open Website: Visit the SIMKL website.
- Open Watch History: View your watch history on SIMKL.
-
Maintenance: Logs, data, and cache management
- Open Logs: Jump straight to app diagnostics from the tray.
- Open Data Folder: Open the application data directory.
- Clear Backlog: Deletes pending offline scrobbles to stop repeated sync prompts.
- Clear Cache: Removes local media cache data while keeping logs and settings intact.
-
Clear Watch History: Removes the local
watch_history.jsonfile and viewer data without touching your SIMKL account. - Clear Logs: Truncates application and playback logs so you can capture a fresh session before debugging.
- Reset App Data (Danger): Performs a full resetβuse only when you want a clean re-authentication; the app exits afterward.
-
More: Additional utilities
- Donate β€οΈ: Support the project.
- Check for Updates: Check if a newer version is available.
- Help: Open help documentation.
- About: View application information.
- Exit: Close the application
If you selected auto-start during installation, the app launches when you sign in.
To change startup behavior later:
- Open Task Manager β Startup apps (or Settings β Apps β Startup)
- Enable or disable MPS for SIMKL
-
Configuration file:
%%USERPROFILE%\kavin\simkl-mps\.simkl_mps.env -
Log files:
%USERPROFILE%\kavin\simkl-mps\simkl_mps.log -
Backlog:
%USERPROFILE%\kavin\simkl-mps\backlog.json
The Windows installer version includes an automatic update system:
- If auto-check is enabled, the application checks for updates weekly
- When an update is available, a notification appears
- Click the update option in the tray menu
- Your default browser opens and the update downloads automatically
- Install the Setup
- The application restarts with the new version
- Use the Windows installer for the best experience
- Enable auto-start for convenience
- Configure VLC or MCP-HC for the most accurate tracking
- Use the system tray menu for quick access to functions
-
Proper filenames significantly improve media identification:
- Best format:
Movie Title (Year).extension - Example:
Inception (2010).mkv
- Best format:
| Issue | Solution |
|---|---|
| Installation fails | Run as administrator, check Windows Defender settings |
| Application doesn't start | Check Event Viewer for errors, verify .NET Framework installation |
| Tray icon missing | Check if app is running in Task Manager, restart app |
| VLC connection fails | Verify web interface is enabled and password is correct |
| MPV not detected | Check if socket path in config matches expectations |
| Movie not identified | Use clearer filename, check log for details |
- Right-click the system tray icon
- Select Maintenance β Open Logs
- The log file opens in your default text editor
For advanced troubleshooting:
- Open Command Prompt or PowerShell
- Navigate to the installation directory
- Run:
simkl-mps tray --debug
To remove the application from your Windows system:
- Open Settings β Apps β Apps & features
- Find "MPS for SIMKL"
- Click Uninstall
- Follow the uninstallation wizard
- Choose whether to remove user data (settings, logs, backlog) ("No" is Recommended)
- β Install using the Windows installer
- β Enable auto-start for convenience
- β Configure your media players (critical step!)
- β Use clear filenames for your media
- β Play media and verify it is detected and tracked
- β Check your SIMKL profile to confirm progress is synced