Code Monkey home page Code Monkey logo

irc-newsbot's Introduction

IRC-Newsbot

IRC-Newsbot is a IRC bot for streaming realtime news from twitter. In addition, it includes some basic must-have features such as YouTube and Twitter url resolving.

IRC-Newsbot uses twitter streaming API to live stream the content of your twitter timeline to the IRC channel of your choice. Just follow the twitter users you want to stream and unfollow the ones you dont.

Additional twitch.tv user status feature provides status updates when a live streamer you are following goes online. To get twitch.tv updates, add twitchOauthKey to options and follow the twitch users you wish to receive updates for. Use !twitch channel command for listing all currently online twitch users.

YouTube API Key: https://developers.google.com/youtube/registering_an_application

Twitch oauth key: http://www.twitchapps.com/tmi/ (May have to register new application at https://www.twitch.tv/settings/connections instead)

Twitch Client-ID: https://www.twitch.tv/settings/connections (Register application -> Edit) see: https://blog.twitch.tv/client-id-required-for-kraken-api-calls-afbb8e95f843#.sf30zyrts

Twitter API keys: https://dev.twitter.com/

https://www.npmjs.com/package/irc-newsbot

Install

npm install irc-newsbot

Usage

Simple example for setting up the bot and connecting to a channel.

var newsbot = require('irc-newsbot');

// Set options for the bot.
// Leaving youtube, twitch or twitter key fields empty will simply disable those features of the bot.
// Highlights and Blacklists can also be left empty []
var options = {
  ircServer: 'irc.freenode.net',
  ircChannel: '#channel',
  ircNick: 'NewsBot',
  ircPort: 6667,
  ircNickServPassword: 'abcdefg', // Remove this line if you dont need to auth via NickServ
  youtubeApiKey: 'abcdefghij_klmn_1234abcdefghij',
  twitchOauthKey: 'abc123456789',
  twitchClientId: 'abcdefg123',
  twitterConsumerKey: 'abc123456789',
  twitterConsumerSecret: 'abc123456789',
  twitterAccessTokenKey: 'abc123456789',
  twitterAccessTokenSecret: 'abc123456789',
  twitterWordBlacklist: ["hollywood", "celeb"], // Filter out tweets containing blacklisted words
  twitterUserHighlight: ["verge", "arstechnica"] // Highlight tweets from these users
}

newsbot(options);

irc-newsbot's People

Contributors

synecy avatar

Stargazers

Christopher Van avatar

Watchers

James Cloos avatar

Forkers

sagax

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.