Skip to content
kavinthangavel edited this page Apr 26, 2025 · 10 revisions

๐ŸŽฎ Usage Guide

This guide explains how to use MPS for SIMKL to track your movies and sync with your SIMKL profile.

๐Ÿ Getting Started

  1. Install the app for your platform (see guides above).
  2. Authenticate with SIMKL on first run.
  3. Configure your media players (see Media Players Guide).
  4. Play movies in your configured player. The app tracks and syncs progress automatically.

๐Ÿ–ฅ๏ธ Windows (EXE)

  • Just install and launch. The app runs in the tray โ€”no commands needed.
  • Use the tray icon for status and controls.

๐Ÿง Linux (pipx)

  • Install with pipx (see Linux Guide).
  • Start with simkl-mps tray or simkl-mps start.
  • Tray icon provides controls and status.

๐Ÿ Mac (pip, untested)

  • Install with pip (see Mac Guide).
  • Start with simkl-mps tray or simkl-mps start.
  • Tray icon provides controls and status.

Note: Mac support is experimental and untested.

๐Ÿ› ๏ธ Common Operations

  • 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

๐Ÿ“ Tips

Clone this wiki locally