Firetower README

• Linux (somebody please port this to OS X)
• xsel
• libnotify-bin

sudo gem install firetower
firetower setup

Edit $HOME/.firetower/firetower.conf

All configuration is done in Ruby. The context is a Firetower::Sesson object. You can add handlers for events:

receive do |session, event| ... end

Or enable plugins:

use NotifyPlugin

receive do |session, event|
  if event['type'] == 'TextMessage' && event['body'] =~ /^!eval (.*)$/
    event.room.account.paste!(event.room.name, "Eval result:\n" + eval($1).to_s)
  end
end

firetower say 'blah blah blah'

firetower say subdomain='mycompany' room='Water Cooler' 'blah blah blah'

firetower paste < hello.rb

firetower paste --from=clip

firetower paste --from=sel

firetower start

firetower stop

If you want to write your own Firetower plugins, you should create a gem that contains a path something like this:

lib/firetower/plugins/my_awesome_plugin/init_v1.rb

Firetower will load the init_v1.rb file on startup. Typically, a plugin will define a Firetower::Session::Listener class (or more than one) in the Firetower::Plugins namespace:

module Firetower
  module Plugins
    class MyAwesomePlugin < Firetower::Session::Listener
      def startup(session)
        # Some one-time startup code...
      end

      def receive(session, event)
        # Some event-handling code...
      end
    end
  end
end

Users can then enable your plugin by installing your gem and adding a line line to their firetower.conf:

use MyAwesomePlugin

(The MIT License)

Copyright (c) 2010 Avdi Grimm

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.