lita-irc

Build Status Code Climate Coverage Status

lita-irc is an adapter for Lita that allows you to use the robot with IRC.

Installation

Add lita-irc to your Lita instance’s Gemfile:

ruby gem "lita-irc"

Configuration

Required attributes

  • server (String) - The name of the IRC server Lita should connect to.
  • channels (Array
    REXML could not parse this XML/HTML: 
    <String>) - An array of channels Lita should join upon connection.

Optional attributes

  • user (String) - The username for Lita’s IRC account. Default: "Lita".
  • password (String) - The password for Lita’s IRC account. Default: nil.
  • realname (String) - The “real name” field for Lita’s IRC account. Default: "Lita".
  • log_level (Symbol) - Sets the log level for Cinch’s loggers. By default, Cinch’s loggers are disabled. Default: nil.

Note: config.robot.name is used as Lita’s IRC nickname. config.adapters.irc.nick is ignored.

Additional Cinch options

Under the hood, lita-irc uses Cinch for the IRC connection. Cinch has several configuration options that you may want to set. To do this, assign a proc/lambda to config.adapters.irc.cinch. lita-irc will yield the Cinch configuration object to the proc, so you can configure it as you’d like. Note that for the options listed in the sections above, those values will overwrite anything set in the proc.

Example

ruby Lita.configure do |config| config.robot.name = "Lita" config.robot.adapter = :irc config.adapters.irc.server = "irc.freenode.net" config.adapters.irc.channels = ["#litabot"] config.adapters.irc.user = "Lita" config.adapters.irc.realname = "Lita" config.adapters.irc.password = "secret" config.adapters.irc.cinch = lambda do |cinch_config| cinch_config.max_reconnect_delay = 123 end end

Events

The IRC adapter will trigger the :connected and :disconnected events when the robot has connected and disconnected from IRC, respectively. There is no payload data for either event.

License

MIT