2.5 KiB
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 #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.2.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.savedata_filename = 'savedata'
config.status = "Send me \"#{config.robot.name}: help\""
end