2 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:
-
Adapter doesn't save Tox state, so you have to send friendship request again after each run. Current Tox ID is shown at start as Lita's information message
-
Only private chats are supported. Adapter will not respond to group invite
-
libtoxcore is not included in the gem. It should be compiled manually to build the gem native extension successfully (see the instructions below)
-
JRuby is not supported. Only C extension for Tox is implemented
-
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 at that file
When libtoxcore is installed, add lita-tox to your Lita instance's Gemfile:
gem 'lita-tox', '~> 0.0.0'
Configuration
No configuration is needed. You only have to specify adapter as :tox
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
end