README

OpenSubtitles subtitle-provider plugin for Phlix — search and download subtitles for movies and TV shows via the OpenSubtitles REST API.

What it does

This plugin integrates OpenSubtitles into the Phlix subtitle pipeline. It allows searching for subtitles by:

• IMDB ID — find subtitles for a specific movie/TV show
• Filename — extract media info from a filename and search matching subtitles
• File hash — match subtitles using the OpenSubtitles hash algorithm

Install

The plugin is unsigned by design. Install via the Phlix admin UI:

1. Log in to your Phlix server as an admin user (users.is_admin = 1).

2. Browse to /admin/plugins.

3. Paste this URL into the Install from URL form and submit:

   https://raw.githubusercontent.com/detain/phlix-plugin-opensubtitles/main/plugin.json
   

4. Configure your OpenSubtitles API key in the plugin settings.

Configuration

How it works

The plugin implements the Phlix\Shared\Plugin\LifecycleInterface contract and connects to the OpenSubtitles REST API v2:

1. Login — registers a user agent and obtains a session token
2. Search — queries subtitles by IMDB ID, filename, or hash
3. Download — fetches the subtitle file and feeds it into Phlix's subtitle pipeline

API

The OpenSubtitles REST API is documented at opensubtitles.com.

License

MIT — see LICENSE.