Archived

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.

Braiden Vasco 3b21b2108c Specify type for attribute "savedata_filename"

2015-09-13 23:44:59 +00:00

2.3 KiB

Raw Blame History

Lita::Adapters::Tox

Tox adapter for the Lita chat bot.

WARNING

Still in development. Read the README carefully.

TODO

Current development version have some limitations which should be fixed in first release:

[issue #15] Only private chats are supported. Adapter will not respond to group invite
[issue #16] libtoxcore is not included in the gem. It should be compiled manually to build the gem native extension successfully. Follow the instructions in that file
[issue #17] JRuby is not supported. Only C extension for Tox is implemented
[issue #18] Message length is limited to value of TOX_MAX_MESSAGE_LENGTH (see source code of libtoxcore)
Adapter has incomplete API for Lita. Only basic methods are implemented

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.1.0'

Configuration

Optional attributes

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

Example

This is an example lita_config.rb file:

Lita.configure do |config|
  config.robot.name = 'Lita'
  config.robot.mention_name = 'lita'

  config.robot.adapter = :tox

  config.savedata_filename = 'savedata'
end

2.3 KiB Raw Blame History