Sub‐Zero Configuration

#TODO: Fix this page with new pics

Accessing the configuration

To access the configuration of Sub-Zero, first select the Channels menu, and then press the little cogs icon. You can also access Sub-Zero's settings from the Agents menu in your PMS configuration.

The configuration page will now show. Let's go through that for a short couple of steps:

Language configuration

1. Subtitle language (1)/(2)/(3): The languages to download subtitles for
2. Additional Subtitle languages (Use ISO-639-1 or IETF language codes, on a comma separated list)
3. Only download foreign/forced subtitles
4. Treat IETF language tags as ISO 639-1 (e.g. pt-BR = pt; this means that a pt-BR language tag will display as "Portuguese" in clients)
5. Restrict to one language (Only used if you only download for one language, and will avoid MyMedia.LangCode.srt)
6. When detecting embedded subtitles in a media, and it's without a language code (UND/Unknown), it will be treated as selected language number 1

Provider configuration

Sub-Zero allows you to select the best subtitle from multiple providers To configure those, look

here

Scanning configuration

1. I keep the exact (release-) filename of my media files:
   • If you don't rename your media files automatically or manually and keep the original release's file names, enabling this option may help finding suitable subtitles for your media. Otherwise: disable this.
2. Scan: Include embedded subtitles:
   • When enabled, subliminal finds embedded subtitles (ignoring forced) that are already present within the media file.
3. Scan: Include external subtitles:
   • When enabled, subliminal finds subtitles located near the media file (or in the configured sub-folder) on the filesystem. (SideCars)
4. Scan: include "exotic" embedded or external subtitle formats (anything else than .srt/.ssa/.ass)
   • Enabling this if you got subtitles in other formats than above, but do note, that they most likely req. transcoding
5. Scan: Which external subtitles should be picked up
   • Exact: Only is media file and subtitles are named identical
   • Loose: Filename contains the media filename
   • Any: Pickup any file

1. Minimum score for TV-Show subtitle download (keep the default value for best results):

   • When configured, what is the minimum score for subtitles to download them? Lower scored subtitles are not downloaded. See here for more info

2. Minimum score for Movie download (keep the default value for best results):

   • When configured, what is the minimum score for subtitles to download them? Lower scored subtitles are not downloaded.See here for more info

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

Subtitles storage configuration

1. Normalize subtitle encoding to UTF-8 (UTF-8 encoding is needed by most Plex Players)
2. Store subtitles next to media files (instead of metadata)

• (default: current media file's folder) See Store as metadata or on filesystem

3. Custom Subtitle folder:

• See Store as metadata or on filesystem

4. Custom Subtitle folder

• See Store as metadata or on filesystem

5. Fall back to metadata storage if filesystem storage failed

• If PMS is running on Linux, or on Windows as a service, it has to have read/write rights to media storage, in order to be able to scan/save subtitle files next to the media. If that fails, we can instead store in the PMS Library

6. When saving a subtitle file next to a media, set file permissions as configured
7. When scanning a filestore, if we find subtitles for a media file that is non-existant, SZ will delete it

Scheduler configuration

1. Scheduler: Periodically search for recent items with missing subtitles

• Here you can specify a scheduled interval, where SZ can catch up on missing subs

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

3. 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, since this could cause you to be banned for a period of time

4. Scheduler: Days to search for better subtitles (max: 30 days)
5. Scheduler: Overwrite manually selected subtitles when better found

Advanced configuration

1. Amount of data to store for the history
2. How many download tries per subtitle (on timeout or error): How often should we retry a failed subtitle download?
3. Ignore folders (...)

• If a folder contains one of the files named subzero.ignore, .subzero.ignore, .nosz, don't process them. This applies to sections/libraries, movies, series, seasons, episodes

4. Ignore anything in the following paths (comma-separated)
5. Enable Sub-Zero channel.this will disable manual operation, but still allows Sub-Zero to work automatically
6. Call this executable upon successful subtitle download

• Here you can specify a file to be executed after SZ finish downloading a subtitle
• Available parameters: %(subtitle_language)s %(subtitle_path)s %(subtitle_filename)s %(provider)s %(score)s %(storage)s %(series_id)s %(series)s %(title)s %(section)s %(filename)s %(path)s %(folder)s %(season_id)s %(type)s %(id)s %(season)s

7. Check for correct folder permissions of every library on plugin start

• if enabled, SZ checks for write permissions of your library folders and warns about them in the plugin channel

8. How verbose should the logging be?:

• Controls how much info SZ writes into the log files (default: only warnings) - this is decoupled from your PMS

9. Log to console (for development/debugging):

• You know when you need it

10. Help the developers collecting anonymous usage statistics

• Helps in planning new features

Next page

Back to main page

Go to top