Git Product home page Git Product logo

clipper's Introduction

clipper

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

Prerequisites

  • Node.js v8.17.0 (Any node major version 8 or higher should work, it just hasn't been tested).
  • A registered applicaiton on Twitch Developer Console.
  • Knowledge of how to install/run Node and use npm.

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.

clipper's People

Contributors

dark-swordsman avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

clipper's Issues

VODs and Highlights

#I personally go through all my streams and make highlights and videos out of it. Currently using TwitchLeecher, but the software does not provide a feature for one-click download of for instance 10 latest VODs in one go. Instead you have to download each separately.

I would love to see VODs and Highlights added as downloadable options, which would make me switch software.

Allow for multiple streamers at once

This could be a feature that goes along with some sort of CLI that is more complex than just the days input.

I personally set up the program to only do one since I only need one. However, we could at least do something like turn the broadcasterName into an array and allow it to pull multiple clips per streamer.

Account for 100+ clips in a single metadata request

The current Get Clips endpoint is limited to 100 clips.

The metadata method doesn't account for this and won't paginate through the api.

Update the getClipsMetadataByBroadcasterId() method to:

  • Check if the response came with a Pagination key/is maxed at 100 clips
  • If so, paginate the data until the clip array length is less than 100 or the last paginating returns 0 clips.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.