usage - kavinthangavel/Media-Player-Scrobbler-for-Simkl GitHub Wiki
This guide explains how to use MPS for SIMKL to track your movies and sync with your SIMKL profile.
- For installation, see the Windows Guide, Linux Guide, or Mac Guide.
- For player setup, see the Media Players Guide.
- Install the app for your platform (see guides above).
- Authenticate with SIMKL on first run.
- Configure your media players (see Media Players Guide).
- Play movies in your configured player. The app tracks and syncs progress automatically.
- Just install and launch. The app runs in the tray —no commands needed.
- Use the tray icon for status and controls.
- Install with pipx (see Linux Guide).
- Start with
simkl-mps tray
orsimkl-mps start
. - Tray icon provides controls and status.
- Install with pip (see Mac Guide).
- Start with
simkl-mps tray
orsimkl-mps start
. - Tray icon provides controls and status.
Note: Mac support is experimental and untested.
MPS for SIMKL uses the system tray/notification area to show its current status across all platforms:
Icon | Status | Description |
---|---|---|
![]() |
Running | App is actively monitoring and ready to track media playback |
![]() |
Paused | Tracking is temporarily paused, no new media will be scrobbled |
![]() |
Stopped | App is inactive and not tracking (but still running in tray) |
![]() |
Error | There's an issue with the app (authentication, API, etc.) |
Right-click the tray icon to access the app menu with options to:
- Start/stop/pause monitoring
- View currently detected media
- Access settings
- Exit the application
- Tray: Right-click for menu, status, and tools.
-
CLI:
simkl-mps start # Start in background simkl-mps tray # Start with tray UI simkl-mps status # Check status simkl-mps stop # Stop the app simkl-mps --help # Help
- Always configure your media players for best results (Media Players Guide).
- Use clear filenames:
Movie Title (Year).ext
. - For troubleshooting, see the Troubleshooting Guide.
- For advanced options, see Advanced & Developer Guide.
- For planned features, see the Todo List.