https://github.com/guerrerocarlos/irc-robot
node.js and coffescript chatting experience enhancer (HUBOT)
https://github.com/guerrerocarlos/irc-robot
Last synced: 3 months ago
JSON representation
node.js and coffescript chatting experience enhancer (HUBOT)
- Host: GitHub
- URL: https://github.com/guerrerocarlos/irc-robot
- Owner: guerrerocarlos
- Created: 2011-11-16T04:11:30.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2011-11-16T04:14:09.000Z (over 13 years ago)
- Last Synced: 2025-01-07T18:32:51.477Z (5 months ago)
- Language: CoffeeScript
- Homepage:
- Size: 101 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Hubot
=====
This is a version of GitHub's Campfire bot, hubot. He's pretty cool.
This version is designed to be deployed on heroku.
Playing with Hubot
==================
You'll need to install the necessary dependencies for hubot. All of
those dependencies are provided by [npm](http://npmjs.org).
% bin/hubot
You'll see some startup output about where your scripts come from.
Loading deploy-local scripts at /Users/me/nubot/scripts
Loading hubot core scripts for relative scripts at /Users/me/nubot/src/hubot/scripts
Hubot: the Shell.
{ id: '1', name: 'Shell' }
Loading hubot-scripts from /Users/me/nubot/hubot-scripts.json
Successfully connected to Redis
Then you can interact with Hubot by typing `hubot help`.
hubot help
animate me - The same thing as `image me`, except adds a few
convert me to - Convert expression to given units.
help - Displays all of the help commands that Hubot knows about.
...
Take a look at the scripts in the `./scripts` folder for examples.
Delete any scripts you think are silly. Add whatever functionality you
want hubot to have.
hubot-scripts
=============
There will inevitably be functionality that everyone will want. Instead
of adding it to hubot itself, you can submit pull requests to
[hubot-scripts](https://github.com/github/hubot-scripts). To enable
scripts from the hubot-scripts package, add the script name with extension as a
double quoted string to the hubot-scripts.json file in this repo.
Deployment
==========
% heroku create --stack cedar
% git push heroku master
% heroku ps:scale app=1
% heroku addons:add redistogo:nano
If you run into any problems, checkout heroku's [docs](http://devcenter.heroku.com/articles/node-js).
You'll need to edit the `Procfile` to say what the bot's name is.
Hubot also needs three environmental variables set to run and to keep him
running on heroku.
Campfire Variables
------------------
Create a separate user for your bot and get their token from the web UI.
% heroku config:add HUBOT_CAMPFIRE_TOKEN="..."
Get the numeric ids of the rooms you want the bot to join, comma
delimited. If you want the bot to connect to `https://mysubdomain.campfirenow.com/room/42`
and `https://mysubdomain.campfirenow.com/room/1024` then you'd add it like this:
% heroku config:add HUBOT_CAMPFIRE_ROOMS="42,1024"
Add the subdomain hubot should connect to. If you web URL looks like
`http://mysubdomain.campfirenow.com` then you'd add it like this:
% heroku config:add HUBOT_CAMPFIRE_ACCOUNT="mysubdomain"
IRC Variables
------------------
% heroku config:add HUBOT_IRC_SERVER="irc.freenode.net"
% heroku config:add HUBOT_IRC_ROOMS="#github,#node.js"
% heroku config:add HUBOT_IRC_NICK="MICCHECK1212"
Twilio Variables
------------------
You must have a Twilio account with credit and a number that can send and
receive SMS messages.
% heroku config:add HUBOT_SMS_FROM="+14156662671"
% heroku config:add HUBOT_SMS_SID="AC5d10e5624da757326d12f8d31c08c20b"
% heroku config:add HUBOT_SMS_TOKEN="4ada63e18146a204e468fb6289030231"
After getting Hubot up and running, update the "SMS Request URL" for your
Twilio number to point to your Hubot instance.
Restart the bot
---------------
You may want to get comfortable with `heroku logs` and `heroku restart`
if you're having issues.