Skip to content

Commit

Permalink
subliminal readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
michael committed Aug 28, 2015
1 parent 18b65f0 commit 677e1fc
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Prerequesite Installation Instructions
- `Gevent` - Run `pip install gevent`
- `stevedore` - Run `pip install stevedore` (this will be automatically installed with subliminal)
- `dateutil` - Run `pip install python-dateutil` (this will be automatically installed with subliminal)
- `subliminal`- Run `pip install subliminal` to enable automatically downloading subtitles

General MP4 Configuration
--------------
Expand Down Expand Up @@ -71,9 +72,9 @@ General MP4 Configuration
- `tagfile` = True/False - Enable or disable tagging file with appropriate metadata after encoding.
- `tag-language` = en - Set your tag language for TMDB/TVDB entries metadata retrieval. Use either 2 or 3 character language codes.
- `download-artwork` = True/False - Enabled downloading and embeddeding of Season or Movie posters and embeddeding of that image into the mp4 as the cover image.
- `download-subs` = True/False - When enabled the script will attempt to download subtitles of your specified languages automatically using subliminal and merge them into the final mp4 file.
- `embed-subs` = True/False - Enabled by default. Embeds subtitles in the resulting MP4 file that are found embedded in the source file as well as external SRT/VTT files. Disabling embed-subs will cause the script to extract any subtitles that meet your language criteria into external SRT/VTT files. The script will also attempt to download SRT files if possible and this feature is enabled.
**YOU MUST INSTALL SUBLIMINAL AND ITS DEPENDENCIES FOR THIS TO WORK.** You must go into the `setup\subliminal` directory included in this script and run `setup.py install` to add support for fetching of subtitles. The version included with this script is modified from the stock version of subliminal, so you must install the included version.
- `download-subs` = True/False - When enabled the script will attempt to download subtitles of your specified languages automatically using subliminal and merge them into the final mp4 file.
**YOU MUST INSTALL SUBLIMINAL AND ITS DEPENDENCIES FOR THIS TO WORK.** You must run `pip install subliminal` in order for this feature to be enabled.
- `sub-providers` = Comma separated values for potential subtitle providers. Must specify at least 1 provider to enable `download-subs`. Providers include `podnapisi` `thesubdb` `opensubtitles` `tvsubtitles` `addic7ed`

Sick Beard Setup
Expand Down

0 comments on commit 677e1fc

Please sign in to comment.