Skip to content

Latest commit

 

History

History
85 lines (52 loc) · 4.65 KB

README.md

File metadata and controls

85 lines (52 loc) · 4.65 KB
Raw

Twitch Clips (and VODs) Downloader

codecov

workflow

NodeJS tool to batch download clips and VODs (and it's metadata) from a Twitch channel.

This tool can PROBABLY download ALL clips from a channel (not only the top 1000). At this point in time this tool has been tested on multiple big channels and seems to be able to get all clips (433k clips from hasanabi).

In order to maximize clip coverage, this tool will not allow Twitch API to report more then 500 clips in a single period. Pagination beyond this point is unreliable (caps around 1k clips but varies alot). To fix this, periods with more than 500 clips, will be split in 2, and the process will restart until a single period reports less than 500 clips.

State of the project

This project is not abandoned but at the same time not being actively developed because of my time constraints.

I realized the project grew beyond the scope of its name: a batch clip downloader, and figured I needed to re-organize everything into more manageable pieces. I'm still figuring out what the final plan of attack will be, for now this is what I'm planning:

Export core functionalities into a separate package

This is mostly done by now, but was needed to keep user stuff from developer stuff. This also allows me to focus on keeping the core functionalities up-to-date and frequently tested and also share the most important code between all the tools

Make this project more usable

Currently this tool will only download EVERYTHING from a channel, and this is not the most common use-case (even for me). I plan on adding things like: download single VOD/clip, download from list of URLs, filters, a better CLI, etc.

A GUI version

Since most users are scared of the CLI, I want to implement a GUI using Electron to this project more accessible and user-friendly.

A VOD player

This tool is also capable of downloading the entire VOD chat from Twitch, allowing a player to replay the entire chat just like you can for VODs that are still available.

Proper documentation

The ultimate plan is to turn the core functionalities package into the swiss-knife of tools for Twitch media related backups, allowing any developer to easily write their own backup/download tool without having to worry about requests, multiple connections, API auth, fetching VOD .m3u8 playlists, etc

Dependencies

  • NodeJS - used to run this tool;
  • Python - used to run youtube-dl;
  • ffmpeg - used to transcode VODs from .ts to .mp4;
  • NPM or Yarn - to install dependencies;
  • Twitch App Client-ID and Client Secret (explained below) - to access Twitch's API.

How to use

Create an app on Twitch Console

Register an application on Twitch Console, click Manage and copy the Client ID and generate a Client Secret.

Install NodeJS dependencies

Run this command on your console:

npm install
Run via NPM

Run the script via NPM with (this is needed to get dotenv loaded):

npm run start
Prompts

Every information needed will be prompted on startup via de terminal.

Each time you run this script, it will ask you for a channel name, and then confirm if you want to download everything.

Environment Variables

Here are the descriptions for each variable:

  • DEBUG: print a fuck-metric-ton of information, just keep it false for normal use;
  • CLIENT_ID: Twitch API Client ID;
  • CLIENT_SECRET: Twitch API Client Secret;
  • BASEPATH: where files (clips, VODs, fragments) should be stored;
  • YOUTUBE_DL_PATH: where youtube-dl executable is located;
  • VIDEOS_PARALLEL_DOWNLOADS: how many VOD fragments should be downloaded at the same time.
  • CLIPS_PARALLEL_DOWNLOADS: how many clips should be downloaded at the same time;
  • BIN_PATH: path where binaries will be stored;
  • DEFAULT_PERIOD_HOURS: default period size in hours (12 is a good number for big channels. Lower this to avoid period splitting, increase this to reduce API counts and speedup URL fetching).