Project

lita-tox

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Tox adapter for the Lita chat bot.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.7
~> 0.10
~> 10.0
~> 3.3
~> 0.49.1
~> 0.10

Runtime

~> 4.7
~> 0.0.2
 Project Readme

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