/Sub-Zero

Plex Metadata agent plugin based on Subliminal

Primary LanguagePythonMIT LicenseMIT

Sub-Zero for Plex, 1.1.0.3

logo

Subtitles done right

Originally based on @bramwalet's awesome Subliminal.bundle

Plex forum thread: https://forums.plex.tv/discussion/186575

Installation

Usage

Use the following agent order:

  1. Sub-Zero TV/Movie Subtitles
  2. Local Media Assets
  3. anything else

Encountered a bug?

  • be sure to post your logs: Library/Application Support/Plex Media Server/Logs/PMS Plugin Logs/com.plexapp.agents.subzero.log; there may be multiple logs (com.plexapp.agents.subzero.log.*) depending on the amount of Videos you're refreshing
  • Remember: before you open a bug-ticket please double-check, that you've deleted the Sub-Zero.bundle folder BEFORE every update (to avoid .pyc leftovers)

Changelog

1.1.0.3

  • addic7ed/tvsubtitles: be way smarter about punctuation in series names (A.G.E.N.T.S. ...)
  • ditch LocalMediaExtended and incorporate the functionality in Sub-Zero (RC-users: delete LocalMediaExtended.bundle and re-enable LocalMedia!)
  • remove (unused) setting "Restrict to one language"
  • add "Treat IETF language tags as ISO 639-1 (e.g. pt-BR = pt)" setting (default: true)
  • change default external storage to "current folder" instead of "/subs"
  • adjust default scores

older changes

Description

Plex Metadata agent plugin based on Subliminal. This agent will search on the following sites for the best matching subtitles:

  • OpenSubtitles
  • TheSubDB
  • Podnapisi.NET
  • Addic7ed
  • TVsubtitles.net

All providers can be disabled or enabled on a per provider setting. Certain preferences change the behaviour of subliminal, for instance the minimum score of subtitles to download, or whether to download hearing impaired subtitles or not. The agent stores the subtitles as metadata, but can be configured (See Configuration) to store it next to the media files.

Configuration

Several options are provided in the preferences of this agent.

  • Addic7ed username/password: Provide your addic7ed username here, otherwise the provider won't work. Please make sure your account is activated, before using the agent.
  • Subtitle language (1)/(2)/(3): Your preferred languages to download subtitles for.
  • Additional Subtitle Languages: Additional languages to download; comma-separated; use ISO-639-1 codes)
  • Provider: Enable ...: Enable/disable this provider. Affects both movies and series.
  • Addic7ed: boost over hash score if requirements met: if an Addic7ed subtitle matches the video's series, season, episode, year, and format (e.g. WEB-DL), boost its score, possibly over OpenSubtitles/TheSubDB direct hash match
  • Scan: Include embedded subtitles: When enabled, subliminal finds embedded subtitles that are already present within the media file.
  • Scan: Include external subtitles: When enabled, subliminal finds subtitles located near the media file on the filesystem.
  • Minimum score for download: When configured, what is the minimum score for subtitles to download them? Lower scored subtitles are not downloaded.
  • Download hearing impaired subtitles:
    • "prefer": score subtitles for hearing impaired higher
    • "don't prefer": score subtitles for hearing impaired lower
    • "force HI": skip subtitles if the hearing impaired flag isn't set
    • "force non-HI": skip subtitles if the hearing impaired flag is set
  • Store subtitles next to media files (instead of metadata): See Store as metadata or on filesystem
  • Subtitle folder: (default: current media file's folder) See Store as metadata or on filesystem
  • Custom Subtitle folder: See Store as metadata or on filesystem
  • Treat IETF language tags as ISO 639-1: Treats subtitle files with IETF language identifiers, such as pt-BR, as their ISO 639-1 counterpart. Thus "pt-BR" will be shown as "Portuguese" instead of "Unknown"

Store as metadata or on filesystem

By default, Plex stores posters, fan art and subtitles as metadata in a separate folder which is not managed by the user. In Sub-Zero, though, 'Store subtitles next to media files' is enabled by default. The agent will write the subtitle files in the media folder next to the media file itself. The setting 'Subtitle folder' configures in which folder (current folder or other subfolder) the subtitles are stored. The expert user can also supply 'Custom Subtitle folder' which can also be an absolute path.

When a subfolder (either custom or predefined) is used, the automatic scheduled refresh of Plex won't pick up your subtitles, only a manual refresh will!

License

MIT

Libraries

Uses the following libraries and their LICENSE: