toxon
/
lita-tox
Archived
1
0
Fork 0
Tox adapter for the Lita chat bot http://lita.io
This repository has been archived on 2023-03-27. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Braiden Vasco 00cabc17b6 Fix example dependencies 2018-03-23 23:10:59 +00:00
bin Configure RuboCop and fix code style 2017-07-20 19:33:29 +00:00
example Fix example dependencies 2018-03-23 23:10:59 +00:00
lib Fix adapter to use new Tox library 2017-07-20 20:26:59 +00:00
locales Initialize Lita adapter 2015-07-25 12:10:34 +05:00
spec Fix specs 2017-07-20 20:43:35 +00:00
vendor Update vendor dependencies 2018-03-23 21:35:50 +00:00
.gitignore Upgrage .gitignore 2018-03-23 21:27:08 +00:00
.gitmodules Add submodules 2017-07-20 19:22:56 +00:00
.rspec Configure testing 2015-07-25 12:31:14 +05:00
.rubocop.yml Configure RuboCop and fix code style 2017-07-20 19:33:29 +00:00
.simplecov Fix coverage 2017-07-20 19:48:49 +00:00
.travis.yml Fix Travis CI build 2017-07-20 20:33:19 +00:00
.yardopts Use YARD 2015-07-25 13:02:30 +05:00
Gemfile Fix coverage 2017-07-20 19:48:49 +00:00
LICENSE Change license text 2017-07-20 19:00:52 +00:00
README.md Bump version (0.5.0) 2018-03-23 22:57:39 +00:00
Rakefile Remove changelog 2018-03-23 22:56:06 +00:00
lita-tox.gemspec Bump version (0.5.0) 2018-03-23 22:57:39 +00:00

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