Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/uiharukazari2008/funimation-downloader

Clone of seiya-dev's Funimation Downloader for AwatsukiDPS
https://github.com/uiharukazari2008/funimation-downloader

Last synced: 11 days ago
JSON representation

Clone of seiya-dev's Funimation Downloader for AwatsukiDPS

Awesome Lists containing this project

README

        

# Funimation Downloader NX

Funimation Downloader NX is capable of downloading videos from the *Funimation* streaming service.

## Legal Warning

This application is not endorsed by or affiliated with *Funimation*. This application enables you to download videos for offline viewing which may be forbidden by law in your country. The usage of this application may also cause a violation of the *Terms of Service* between you and the stream provider. This tool is not responsible for your actions; please make an informed decision before using this application.

## Prerequisites

* NodeJS >= 7.8.0 (https://nodejs.org/)
* NPM >= 4.0.0 (https://www.npmjs.org/)
* Streamlink >= 0.5.0 (https://github.com/streamlink/streamlink)
* tsMuxeR >= 2.6.12 (https://www.videohelp.com/software/tsMuxeR)
* MP4Box >= 0.6.0 (https://github.com/gpac/gpac)
* MKVToolNix >= 10.0.0 (https://github.com/mbunkus/mkvtoolnix)

### Paths Configuration

By default this application uses the following paths to programs (main executables):
* `./bin/streamlink/build/streamlink`
* `./bin/tsMuxeR/tsMuxeR`
* `./bin/mp4box/mp4box`
* `./bin/mkvtoolnix/mkvmerge`

To change these paths you need to edit `config.bin.js` in `./scripts/config/` directory.

### Node Modules

After installing NodeJS with NPM goto `scripts` directory and type: `npm i`

## Switches

### Authentication

* `--mail --pass ` sets the email and password.

### Get Show ID

* `--search ` sets the show title for search

### Download Video

* `-s --sel ` sets the show id and episode id
* `--alt` alternative episode listing (if available)
* `-q p` sets the video quality (optional, "720p" by default)
* `--sub` switch from English dub to Japanese dub with subtitles
* `--socks ` set ipv4 socks proxy for all requests to funimation api
* `--proxy ` set ipv4 http(s) proxy for all requests to funimation api
* `--nosubs` skip download subtitles for Dub (if available)

### Muxing

`[note] this application mux into mp4 by default`
* `--mkv` mux into mkv
* `--mks` add subtitles to mkv (if available)

### Filenaming Options (optional)

* `-a ` release group ("Funimation" by default)
* `-t ` show title override
* `--ep ` episode number override
* `--suffix ` filename suffix override (first "SIZEp" will be replaced with actual video size, "SIZEp" by default)

### Filename Template

[`release group`] `title` - `episode` [`suffix`].`extension`