GithubHelp home page GithubHelp logo

agret / twitch-drops-bot Goto Github PK

View Code? Open in Web Editor NEW

This project forked from tychothetaco/twitch-drops-bot

0.0 0.0 0.0 226 KB

A Node.js bot that will automatically watch Twitch streams and claim drop rewards.

License: MIT License

JavaScript 100.00%

twitch-drops-bot's Introduction

Twitch Drops Bot

This is a Node.js bot that uses Puppeteer to automatically watch Twitch streams and claim drop rewards.

Disclaimer

Use this bot at your own risk! This bot uses parts of the Twitch API that are not intended for public use. I am not responsible for anything that happens to your Twitch account.

Usage

  1. Install Node.js
  2. Install Google Chrome
  3. Install this package: npm install .
  4. Start the bot with node src/index.js

Options

There are multiple options you can configure. They can be provided as command line arguments or in a config JSON file. Options passed as command line arguments will override items in the config file. If no command line arguments are provided, a default config file will be generated.

A sample config file looks like this:

{
    "browser": "C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe",
    "games": ["30921", "511224", "488552"],
    "headless": true,
    "headless_login": false,
    "interval": 15,
    "browser_args": []
}

Below is a list of all available options.

Argument Config Description Default
‑‑config <path> Path to your configuration file. config.json
‑‑browser <path> browser Path to your browser executable. Only Chrome is currently supported. Although Puppeteer includes a version of Chromium, it does not support the video format required to watch Twitch streams, so a separate Chrome installation is required. System dependent
‑‑games <ids> games A list of IDs of the games that the bot should automatically watch. See games.csv for a list of game IDs. This item is optional. If empty or omitted, the bot will try to watch all games. []
‑‑username <string> username Your Twitch username. It is only used to automatically fill out the login page. This is required if headless-login is true, otherwise it is optional.
‑‑password <string> password Your Twitch password. It is only used to automatically fill out the login page. This is required if headless-login is true, otherwise it is optional.
‑‑headless-login headless_login Login to Twitch in headless mode. If this is enabled, you must also provide a username and password. This is useful for logging in remotely. false
‑‑headless <boolean> headless Toggle headless mode. If false, this will display the browser at all times. Useful for debugging. true
‑‑interval <minutes> interval The number of minutes to wait between checking for new drop campaigns. 15
‑‑browser‑args <args> browser_args Extra arguments to pass to the browser instance. []

twitch-drops-bot's People

Contributors

agret avatar tychothetaco avatar

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.