ericqweinstein / ruben

An IRC chat bot written in Ruby.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Ruben

Build Status

Description

Ruben is an IRC chat bot written in Ruby. He is inspired, in part, by Hubot, his CoffeeScript brother from another mother.

Dependencies

  • Ruby 1.9.3+
  • Rake 10.0.4 (for running tests, if that's your jam)
  • RSpec 2.13.0 (see above)

Installation

Version 1.1.0 is available from RubyGems; you can get your version of Ruben by typing

$ gem install ruben

Getting Started

Ruben comes with a bin/ruben executable, so you can run him with

$ ruben <server> <port> <channel> <nick>

Ruben takes a server name, port number, channel name, and nick as command line arguments. For example, if you type:

$ ruben irc.freenode.net 6667 test_chan ruben_

You should see:

$ >> USER ruben 0 * :Ruben
$ >> NICK ruben_
$ >> JOIN #test_chan

...

You can get Ruben's usage information by typing ruben -h or ruben --help.

Adding Scripts

You can extend Ruben's functionality by adding scripts to /scripts. Each script should be a .rb file that instantiates a new Listener object, like so:

thing_to_do lambda do
  # Arcane magicks go here
end

Listener.new(/Regexp/, thing_to_do)

Ruben's listeners hear every incoming IRC message. If a listener's Regexp matches the inbound message, Ruben will call the associated lambda.

About

An IRC chat bot written in Ruby.

License:MIT License


Languages

Language:Ruby 100.0%