Tox adapter for the Lita chat bot
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
example
lib
locales
spec
vendor
.gitignore
.gitmodules
.rspec
.rubocop.yml
.simplecov
.travis.yml
.yardopts
Gemfile
LICENSE
README.md
Rakefile
lita-tox.gemspec

README.md

Lita::Adapters::Tox

Gem Version Build Status Coverage Status

Tox adapter for the Lita chat bot.

Usage

At first, see the documentation for Lita: http://docs.lita.io/

Installation

libtoxcore should be compiled manually at your computer or server. Follow the instructions in that file

When libtoxcore is installed, add lita-tox to your Lita instance's Gemfile:

gem 'lita-tox', '~> 0.5.0'

Configuration

config.robot.name will be used as Tox user name

Mentions in Tox usually use user name, Tox clients usually allow mentioning by writing first letters of user name and pressing <Tab>, so don't use config.robot.mention_name

Optional attributes

  • savedata_filename (String) - Path to file where Tox state will be stored (if provided)
  • status (String) - Tox user status

Example

This is an example lita_config.rb file:

Lita.configure do |config|
  config.robot.name = 'Lita chat bot'

  config.robot.adapter = :tox

  config.adapters.tox.savedata_filename = 'savedata'
  config.adapters.tox.status = "Send me \"#{config.robot.name}: help\""
end