irc-newsbot
v0.2.8
Published
Real Time News IRC Bot for connecting Twitter streaming API to IRC.
Downloads
26
Maintainers
Readme
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);