dark-swordsman / clipper

18 stars 3 forks source link

clipper

Node.js utility to download twitch clips from a specific broadcaster.

Prerequisites

If you're new

First of all, this is a Node.js program. It is not a Windows executable. You can not simply download it and press "clipper.exe".

Since most of you viewing this are probably on Windows 10, have never heard of "NPM" or "Node", and I don't want github issues of "how do i run this?!", I invite you to read the following guide:

How to Install Node.js® and NPM on Windows

How to use it

  1. Go to the Twitch Developer Console and register a new app.
  2. Download the zip or git clone this repo to a location on your computer.
  3. Copy config.example.json and rename the new copy "config.json".
  4. Fill in the config.json with information from your app page and other info, and make sure to save it:
    • clientId
    • clientSecret
    • broadcasterName (the streamer you want to download clips from)
    • downloadLocation (where you want the clips to download)
      • preferably from the root of the drive to an existing folder, such as:
      • C:/Users/Bob/Videos/clipperclips/
  5. Run npm i to install required packages.
  6. Once it finishes, run npm start or npm run start.
  7. The application will prompt you for the time period (in days from today).
    • For example: 7 days from today would be a week ago.
  8. The application will download the clips to a new folder in the specified download directory named clips_<broadcaster name>_<MM-DD-YYYY_hhmmss>, and exit automatically.

Contributing

Go to CONTRIBUTING.md.