Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/Last-Order/Minyami

A lovely video downloader for HLS videos
https://github.com/Last-Order/Minyami

hls

Last synced: about 1 month ago
JSON representation

A lovely video downloader for HLS videos

Host: GitHub
URL: https://github.com/Last-Order/Minyami
Owner: Last-Order
License: gpl-3.0
Created: 2018-05-18T14:25:24.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-03-10T13:37:41.000Z (9 months ago)
Last Synced: 2024-05-30T00:03:40.323Z (7 months ago)
Topics: hls
Language: TypeScript
Homepage:
Size: 889 KB
Stars: 543
Watchers: 17
Forks: 35
Open Issues: 5
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: COPYING

Awesome Lists containing this project

awesome-video - Last-Order/Minyami - A lovely video downloader for HLS videos. (HLS / Talks Presentations Podcasts)

README

# README

[![Build Status](https://github.com/Last-Order/Minyami/workflows/Node%20CI/badge.svg)](https://github.com/Last-Order/Minyami/actions)

[中文说明](readme.zh-cn.md)

## Dependencies

- mkvmerge (optional, mkv output required)

! Minyami requires Node Active/Maintenance LTS latest or Current latest. Active LTS is recommended. Details [here](https://nodejs.org/en/about/previous-releases).

Make sure you had put the binary files into your system `PATH`.

## Installation

`npm -g i minyami` or `yarn global add minyami`

Please also install the following extension to work with Minyami

1. Install Chrome extension (recommended): https://chrome.google.com/webstore/detail/minyami/cgejkofhdaffiifhcohjdbbheldkiaed (which is also open-sourced [here](https://github.com/Last-Order/Minyami-chrome-extension))

## Usage

```
Help:
Commands Description Alias

--help Show help documentation -h
Show help of a specified comma
--version Show version
--download Download video -d
m3u8 file path
--threads Threads limit
(Optional) Limit of threads, defaults to 5
--retries Retry limit
(Optional) Limit of retry times
--output, o Output path
(Optional) Output file path, defaults to ./output.mkv
--temp-dir Temporary file path
(Optional) Temporary file path, defaults to env.TEMP
--key Set key manually (Internal use)
(Optional) Key for decrypt video.
--cookies Cookies used to download

--headers, H HTTP Header used to download
Custom header. eg. "User-Agent: xxxxx". This option will override --cookies.
--live Download live
--format (Optional) Set output format. default: ts
Format name. ts or mkv.
--proxy Use the specified HTTP/HTTPS/SOCKS5 proxy
Set proxy in [protocol://:] format. eg. --proxy "http://127.0.0.1:1080".
--no-proxy Disable reading proxy configuration from system environment variables or system settings.
--slice Download specified part of the stream
Set time range in [- format]. eg. --slice "45:00-53:00"
--no-merge Do not merge m3u8 chunks.
--keep, k Keep temporary files.
--keep-encrypted-chunks Do not delete encrypted chunks after decryption.
--chunk-naming-strategy Temporary file naming strategy. Defaults to 1.
--resume Resume a download. (Archive) -r
m3u8 file path
--clean Clean cache files

Options:

Options Description
--verbose, debug Debug output
```

## FAQ

Q: Should I keep the browser open when downloading?

A: It's not necessary.

Q: How to set proxy for Minyami?

A: You can use `--proxy` to set proxy server for Minyami. HTTP/SOCKS5 proxy are supported. Or you can use environment variables `HTTP_PROXY`/`HTTPS_PROXY`/`ALL_PROXY` to provide proxy configuration for Minyami. And Minyami will read proxy settings from environment variables and Windows system proxy settings. To disable any proxy setting from context, you can add `--disable-proxy` or set `env.NO_PROXY` to and non-empty values.

Q: How to set temporary file location?

A: You can use `--temp-dir` to set the directory of temporary files.

Q: How to set multiple HTTP headers?

A: By providing multiple -H/--headers option. For example, `minyami -d xxxx -H "Cookie: xxxx" --headers "User-Agent: yyy"`.

## Use as a library (3.1.0+)

```TypeScript
import { ArchiveDownloader } from 'minyami';
import { LiveDownloader } from 'minyami';
```

### Event: `chunk-downloaded`

- `currentChunkInfo` `` The information of the chunk which is just downloaded.

The `'chunk-downloaded'` event is emitted when every media chunk is downloaded.

### Event: `chunk-error`

- `error: Error`

The `'chunk-error'` event is emitted when failed to download or decrypt media chunks.

### Event: `downloaded`

The `'downloaded'` event is emitted after all chunks are downloaded but before starting merge.

### Event: `finished`

The `'finished'` event is emitted after all the works are done. CLI program exits after this event is emitted.

### Event: `merge-error`

- `error: Error`

The `merge-error` event is emitted when a merge progress is failed.

### Event: `critical-error`

- `error: Error`

The `critical-error` is emitted when a error that Minyami can't handle happens.

## Contribution

Minyami is developed with TypeScript. You need to install TypeScript Compiler before you start coding.

**Install development dependencies**

```
npm install -g typescript
git clone https://github.com/Last-Order/Minyami
cd Minyami
npm install
```

To build the project, just run `tsc`.

## Copyright