Installation - kavinthangavel/Media-Player-Scrobbler-for-Simkl GitHub Wiki
This comprehensive guide explains how to install Media Player Scrobbler for SIMKL on Windows, macOS, and Linux, with detailed platform-specific instructions.
Platform | Recommended Method | Docs |
---|---|---|
Windows | Installer (recommended) or pip | Usage |
macOS | pip with macOS extras | Usage |
Linux | pip with Linux extras | Usage |
The Windows installer provides the most streamlined experience with automatic updates and system integration.
- Download the latest installer
- Run the setup wizard as Administrator (recommended)
- Follow the installation steps
- Launch from the Start menu when installation completes
- Authenticate with SIMKL when prompted (one-time setup)
- The app runs silently in your system tray
- All-in-one package: Bundles all dependencies, no need for separate Python installation
- System integration: Desktop and start menu shortcuts
- Auto-start option: Automatically run on Windows startup (recommended)
- Auto-update system: Weekly checks for updates (optional but recommended)
- Simple updates: One-click updates from the tray menu
- Minimal footprint: Optimized for low resource usage
flowchart TD
A[Download Installer] --> B[Run Setup as Admin]
B --> C[Accept License]
C --> D[Choose Install Location]
D --> E[Select Components]
E --> F[Installation]
F --> G[Launch Application]
G --> H[Authenticate with Simkl]
H --> I[Configure Media Players]
style A fill:#4285f4,stroke:#333,stroke-width:2px,color:#fff
style F fill:#34a853,stroke:#333,stroke-width:2px,color:#fff
style I fill:#fbbc05,stroke:#333,stroke-width:2px,color:#fff
CRITICAL STEP: After installation, configure your media players for optimal tracking. See the Media Players guide for detailed instructions.
- Open Settings → Apps → Apps & features
- Find "Media Player Scrobbler for SIMKL"
- Click Uninstall
- Choose whether to remove user data and settings
For users who prefer Python package management or need platform-specific installations:
# Simple installation
pip install simkl-mps
# Start the application
simkl-mps start
Important Notes:
- Requires Python 3.9 or higher
- Authenticate with SIMKL on first run
- For advanced tracking, configure your media players (see Media Players)
- Auto-start and system tray functionality may require additional setup compared to the Windows installer
Windows
For Windows Installer:
- Windows 10/11 (recommended)
- Administrator rights for installation
- No additional requirements
For pip installation:
- Python 3.9 or higher
- pip package manager
macOS
Install with macOS-specific dependencies:
pip install "simkl-mps[macos]"
Requirements:
- macOS 10.14 or higher
- Python 3.9 or higher
- For system tray functionality:
rumps
package (included in extras)
Linux
Install required system dependencies first (example for Ubuntu/Debian):
sudo apt install python3-pip wmctrl xdotool python3-gi gir1.2-gtk-3.0 libnotify-bin
Then install with Linux extras:
pip install "simkl-mps[linux]"
For other distributions, install equivalent packages for:
- Window management (wmctrl, xdotool)
- Notifications (libnotify)
- GTK integration (if using desktop environment)
- First Run: The application starts automatically after installation (if selected)
- Authentication: Log in to your Simkl account when prompted
-
Media Player Configuration:
⚠️ ESSENTIAL STEP: Configure your media players for advanced tracking- See Media Players Configuration Guide for detailed instructions
- Verification: A system tray icon appears, indicating the application is running
# Check the installed version
simkl-mps --version
# Verify the service is running
simkl-mps status
For detailed usage instructions, see the Usage Guide.
- Startup time: 1-3 seconds
- Memory usage: 30-60 MB (typical)
- 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