Skip to content
This repository has been archived by the owner on Jan 27, 2021. It is now read-only.

Commit

Permalink
Initial release of SixBotGG.
Browse files Browse the repository at this point in the history
  • Loading branch information
roncli committed Mar 3, 2016
1 parent c11d561 commit 62aafa2
Show file tree
Hide file tree
Showing 5 changed files with 420 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
settings.js
.idea
node_modules
58 changes: 56 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,56 @@
# SixBotGG
A custom Twitch chat bot for Six Gaming's Twitch channel at http://twitch.tv/sixgaminggg
SixBotGG
========

This is the source repository for the [Six Gaming Twitch Channel](http://twitch.tv/sixgaminggg) chat bot known as [SixBotGG](http://twitch.tv/sixbotgg). This bot is written in [node.js](http://nodejs.org).

Installation
============

1. Install the node modules from the base directory (ignore errors and warnings on Windows):

npm install
2. Run the following command from the base directory:

node index.js

settings.js
===========

The following should be the contents of settings.js:

module.exports = {
irc: {
server: "irc.twitch.tv",
nick: "(The nickname of the bot you wish to log in as)",
options: {
userName: "(The nickname of the bot, properly capitalized)",
realName: "(A long name for the bot)",
port: 6667,
password: "(The oauth key to log into, retrieved from Twitch)",
autoConnect: false
}
},
twitch: {
clientId: "(Your client ID, retrieved from your Twitch connected app)",
clientSecret: "(Your client secret, retrieved from your Twitch connected app)",
redirectUri: "(Your redirect URI from your Twitch connected app)",
scopes: []
}
};

Version History
===============

1.0.0 - 3/2/2016
----------------

This is the initial release of the SixBotGG chat bot.

* Auto logs into Twitch and enters the #sixgaminggg chat
* Recognizes the !facebook, !twitter, !youtube, and !itunes commands from all users.
* Auto-cycles through the above four commands when both 10 minutes and 5 chat messages have occurred.
* Recognizes the !host <user> and !unhost commands from moderators.
* Automatically cycles every 10 minutes through hosting a select list of streamers when SixGamingGG is offline.
* Hosts someone else when the currently hosted client's stream ends.
* Stops hosting when manually hosting another streamer, or SixGamingGG starts streaming.
8 changes: 8 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
var irc = require("irc"),
twitchApi = require("twitch-api"),
settings = require("./settings"),
sixGaming = require("./sixgaming"),
client = new irc.Client(settings.irc.server, settings.irc.nick, settings.irc.options),
twitch = new twitchApi(settings.twitch);

sixGaming.start(client, twitch);
29 changes: 29 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"name": "SixBotGG",
"version": "1.0.0",
"description": "A Twitch IRC bot for Six Gaming.",
"homepage": "https://github.com/roncli/SixBotGG",
"bugs": {
"url": "https://github.com/roncli/SixBotGG/issues",
"email": "roncli@roncli.com"
},
"license": "None",
"author": {
"name": "Ronald M. Clifford",
"email": "roncli@roncli.com",
"url": "http://www.roncli.com"
},
"repository": {
"type": "git",
"url": "https://github.com/roncli/SixBotGG.git"
},
"dependencies": {
"irc": "0.4.1",
"promised-io": "0.3.5",
"twitch-api": "0.4.3"
},
"engines": {
"node": ">=5.0.0"
},
"private": true
}
Loading

0 comments on commit 62aafa2

Please sign in to comment.