Skip to content

utajum/Sub-Zero

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sub-Zero for Plex, 1.3.5.281

logo

Subtitles done right

Originally based on @bramwalet's awesome Subliminal.bundle

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

If you like this, buy me a beer: Donate

Installation

  • go to Library/Application Support/Plex Media Server/Plug-ins/
  • rm -r Sub-Zero.bundle
  • get the release you want from https://github.com/pannal/Sub-Zero/releases/
  • unzip the release
  • restart your plex media server!!!
  • more indepth: see article on Plex website.

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.3.5.281

  • fix tasks broken for 1.2 -> 1.3.5 upgraders

1.3.5.273 (same build as Beta Release 1.3.0.273) - changes from previous stable 1.2.11.180

  • add a channel menu, making this plugin a hybrid (Agent+Channel)
  • add a generic background task scheduler
  • add a task to search for subtitles for items with missing subtitles (manually triggered and automatic)
  • add artwork
  • add Plex.tv credentials/token-generation support (needed for Plex Home users for the API to work)
  • addic7ed: improve show name matching again
  • channel: able to browse current on-deck and recently-added items, and refresh or force-refresh (search for new subtitles) single items
  • add library/series/video blacklist for items which should be skipped in "Search for missing subtitles"-task
  • add donation links
  • change the license to The Unlicense (while keeping the original MIT license from subliminal.bundle intact)
  • store subtitle information in internal plugin storage (for later usage)
  • many internal code improvements
  • update documentation

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.
  • Plex.tv username/password: Generally recommended to be provided; needed if you use Plex Home to make the API work (the whole channel menu depends on it)
  • 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"
  • Scheduler:
    • Periodically search for recent items with missing subtitles: self-explanatory, executes the task "Search for missing subtitles" from the channel menu regularly. Configure how often it should do that. For the average library 6 hours minimum is recommended, to not hammer the providers too heavily
    • Item age to be considered recent: The "Search for missing subtitles"-task only considers those items in the recently-added list, that are at most this old
    • Sections to ignore: section/library IDs to be ignored in the "Search for missing subtitles"-task; numbers, comma-separated
    • Series to ignore: series IDs to be ignored in the "Search for missing subtitles"-task; numbers; comma-separated
    • Items to ignore: item IDs ... see above

Scheduler

The built-in scheduler is capable of running a number of tasks periodically in a separate Thread of the plugin. This currently is used to automatically periodically search for new subtitles for your media items. See configuration above.

Ignore lists, what the heck?

There are numerous occasions where one wouldn't want a certain item or even a library be included in the periodic "Search for missing subtitles"-task. Anime libraries are a good example of that, or home videos. Perhaps you've got your favourite series in your native language and don't want subtitles for it.

Those ignore lists currently only accept numeric IDs. How you can obtain those is explained below.

How to obtain the IDs for the ignore lists
  • Sections/Libraries: click on a library in PlexWeb and you'll see something like this in your browser's address bar: /web/index.html#!/server/long_identifier_hash/section/3 - 3 is the library/section ID
  • Series: click on a series in PlexWeb, take 25660 from /web/index.html#!/server/long_identifier_hash/details/%2Flibrary%2Fmetadata%2F25660
  • Items (episodes/movies): click on an item in PlexWeb, take 25662 from /web/index.html#!/server/long_identifier_hash/details/%2Flibrary%2Fmetadata%2F25662

I will make this easier in future versions.

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

The Unlicense

Libraries

Uses the following libraries and their LICENSE:

About

Plex Metadata agent plugin based on Subliminal

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 52.0%
  • HTML 48.0%