https://github.com/beatfreaker/subdownloader

:pencil: Painless subtitle downloader
https://github.com/beatfreaker/subdownloader

Last synced: about 1 month ago
JSON representation

:pencil: Painless subtitle downloader

• Host: GitHub
• URL: https://github.com/beatfreaker/subdownloader
• Owner: beatfreaker
• License: mit
• Created: 2015-08-13T18:51:12.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-10-02T08:59:46.000Z (about 7 years ago)
• Last Synced: 2024-09-20T07:45:10.694Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 2.54 MB
• Stars: 141
• Watchers: 5
• Forks: 17
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: license

Awesome Lists containing this project

• awesome-nodejs-cn - subdownloader - 电影和电视剧的字幕下载器 (包 / 命令行程序)
• awesome-nodejs - subdownloader - Painless subtitle downloader - ★ 99 (Command-line apps)
• awesome-node - subdownloader - Subtitle downloader for movies and TV series. (Packages / Command-line apps)
• awesome-nodejs-cn - subdownloader - 电影和电视剧字幕下载器. (目录 / 命令行应用)

README

        
# subdownloader

Painless subtitle downloader

Downloading subtitle for one or more files is just a command away. It can get any better then this.

## Installation

```

npm install -g subdownloader

```

## How to use

- Navigate to the folder in which you have the file for which you want to download subtitles through command prompt.

- Execute `subdownload` command and let all the magic happens.

- `sd` is a shorthand command. You can use `sd` instead of `subdownload`

## Options

- To download subtitles for all the movies in a folder execute.

  `> subdownload`

- To download subtitles for single movie execute.

  `> subdownload --listLangs`

- To list available languages for subtitle.

  `> subdownload "Movie Name"`

- To download subtitles for more then one movie but not all movies in a folder execute.

  `> subdownload "Movie Name" --lang=fr`

- To download subtitles of specific language.

  

  `> subdownload "Movie 1" "Movie 2" .... "Movie n"`

- To enable deep download means to download subtitles for files in a folder as well as subfolders.

	

  `> subdownload --deep`

- Use `> subdownload --help` for listing all the options available.

## API

```js

var subd = require('subdownloader');

//filesArray - is the array of path to the files for which 

//you want to download the subtitles

//obj - in return you will return an object having success and failed files array

subd.subdownload(filesArray).then(function(obj){

	console.log(obj);

	//=> { success: [successfile1,successfile2], failed: [failedfile1]}

});

```

## Demo

![Demo image](https://github.com/beatfreaker/subdownloader/blob/master/demo/demo.gif)

Note : This module uses [SubDB](http://thesubdb.com/) to download subtitles.

## License

MIT © [Chintan Radia](http://beatfreaker.github.io/)