toxon
/
lita-tox
Archived
1
0
Fork 0
Code Releases Activity
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.
70 Commits 1 Branch 5 Tags 164 KiB
Ruby 97.1%
Shell 2.9%
Go to file
Braiden Vasco 8c61abd417 Generate changelog 2015-09-13 20:43:38 +00:00
bin Configure gem console 2015-09-12 17:27:41 +00:00
ext/tox More detailed checks 2015-09-13 17:15:27 +00:00
lib Basic implementation 2015-09-13 19:40:46 +00:00
locales Initialize Lita adapter 2015-07-25 12:10:34 +05:00
spec Merge branch 'master' into initialize_lita_adapter 2015-07-25 13:26:47 +05:00
.gitignore .gitignore extension files 2015-07-25 18:17:25 +05:00
.rspec Configure testing 2015-07-25 12:31:14 +05:00
.rubocop.yml Configure Travis CI 2015-07-25 12:38:42 +05:00
.simplecov Merge branch 'master' into initialize_lita_adapter 2015-07-25 13:26:47 +05:00
.travis.yml Merge branch 'master' into initialize_lita_adapter 2015-07-25 13:26:47 +05:00
.yardopts Use YARD 2015-07-25 13:02:30 +05:00
CHANGELOG.md Generate changelog 2015-09-13 20:43:38 +00:00
Gemfile Configure Coveralls 2015-07-25 12:42:19 +05:00
LICENSE Initial commit 2015-07-24 20:37:42 +00:00
README.md Add instructions 2015-09-13 20:34:26 +00:00
Rakefile Add extension Rake task "tox" 2015-07-25 18:20:40 +05:00
lita-tox.gemspec Configure gem console 2015-09-12 17:27:41 +00:00

README.md

Lita::Adapters::Tox

Gem Version Build Status Coverage Status

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