configuration - kavinthangavel/Media-Player-Scrobbler-for-Simkl GitHub Wiki

⚙️ Advanced & Developer Guide

This guide combines advanced configuration and developer documentation for MPS for SIMKL.

🛠️ Advanced Configuration

Settings can be customized via config files, environment variables, or command-line options. See the Media Players Guide for player-specific settings.

Config File Locations

Platform Config File Location
Windows %APPDATA%\kavinthangavel\simkl-mps\.simkl_mps.env
macOS ~/Library/Application Support/kavinthangavel/simkl-mps/.simkl_mps.env
Linux ~/.local/share/kavinthangavel/simkl-mps/.simkl_mps.env

Example Settings

# .simkl_mps.env
SIMKL_ACCESS_TOKEN=your_access_token_here
USER_ID=your_user_id

See Media Players Guide for player-specific environment variables.

👩‍💻 Developer Guide

Project Structure

Media-Player-Scrobbler-for-Simkl/
  docs/                # Documentation
  simkl_mps/           # Main package
    players/           # Media player integrations
    utils/             # Utility functions
  pyproject.toml       # Project metadata
  README.md            # Project overview
  LICENSE              # License info

Setup & Environment

git clone https://github.com/kavinthangavel/Media-Player-Scrobbler-for-Simkl.git
cd Media-Player-Scrobbler-for-Simkl
poetry install --with dev
# or
pip install -e ".[dev]"

Adding a New Media Player

  1. Create a new file in players/ (e.g. simkl_mps/players/new_player.py)
  2. Implement a class with a get_position_duration() method
  3. Add the player to players/__init__.py
  4. Update detection in window_detection.py

Building & Publishing

poetry build
poetry publish

Architecture Overview

graph TD
    A[Window Detection] -->|Active Windows| B[Media Monitor]
    B -->|Window Info| C[Movie Scrobbler]
    C -->|Movie Title| D[Title Parser]
    D -->|Parsed Info| E[SIMKL API Client]
    E -->|Movie ID & Metadata| F[Progress Tracker]
    F -->|Position Updates| G{Completion Check}
    G -->|>80% Complete| H[Mark as Watched]
    G -->|<80% Complete| F
    I[Player Integrations] -->|Position & Duration| F
    J[Backlog Cleaner] <-->|Offline Queue| C
    K[Media Cache] <-->|Movie Info| C
    L[Tray Application] <-->|Status & Controls| B
    I -.->|Connectivity| M{Internet Available?}
    M -->|Yes| E
    M -->|No| J
    style A fill:#d5f5e3,stroke:#333,stroke-width:2px
    style E fill:#f9d5e5,stroke:#333,stroke-width:2px
    style H fill:#f9d5e5,stroke:#333,stroke-width:2px
    style I fill:#d5eef7,stroke:#333,stroke-width:2px
Loading

For more, see the Usage Guide and Media Players Guide.

⚠️ **GitHub.com Fallback** ⚠️