Code Monkey home page Code Monkey logo

hubot-twitch's Introduction

Twitch adapter for Hubot

Hubot is a chat bot by GitHub, modelled after their Campfire bot. Twitch is the world's leading video platform and community for gamers. This adapter allows your Hubot to join channels on Twitch.

Getting started

You will need a Twitch account to start, which you can sign up for free.

Next, you will need to create an account for your Hubot.

Hubot defaults to using its shell, so to use Twitch instead, you can run hubot with -a twitch-adapter:

% bin/hubot -a twitch-adapter

If you are deploying to Heroku or using foreman, you need to make sure the hubot is called with -a twitch-adapter in the Procfile:

web: bin/hubot -a twitch-adapter -n Hubot

Configuring

The adapter requires the following environment variables.

  • HUBOT_TWITCH_USERNAME
  • HUBOT_TWITCH_PASSWORD
  • HUBOT_TWITCH_CHANNELS

You can use the Twitch Chat OAuth Password Generator to generate a password for your Hubot.

Configuring the variables on Heroku

% heroku config:set HUBOT_TWITCH_USERNAME="myusername"
% heroku config:set HUBOT_TWITCH_PASSWORD="oauth:mypassword"
% heroku config:set HUBOT_TWITCH_CHANNELS="#mychannel"

Configuring the variables on UNIX

% export HUBOT_TWITCH_USERNAME="myusername"
% export HUBOT_TWITCH_PASSWORD="oauth:mypassword"
% export HUBOT_TWITCH_CHANNELS="#mychannel"

Configuring the variables on Windows

Using PowerShell:

setx HUBOT_TWITCH_USERNAME="myusername" /m
setx HUBOT_TWITCH_PASSWORD="oauth:mypassword" /m
setx HUBOT_TWITCH_CHANNELS="#mychannel" /m

Additional configuration

The adapter also supports the following environmental variables:

  • HUBOT_TWITCH_CLIENT_ID
  • HUBOT_TWITCH_CLIENT_SECRET
  • HUBOT_TWITCH_REDIRECT_URI
  • HUBOT_TWITCH_OWNERS
  • HUBOT_TWITCH_DEBUG
  • HUBOT_TWITCH_DELAY

hubot-twitch's People

Contributors

crisu83 avatar owenthereal avatar zob3k avatar

Stargazers

Ryan Conrad avatar

Watchers

 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.