Skip to content

tayjaybabee/cinch-tinychat

Repository files navigation

Gem Version Dependency Status Build Status Coverage Status

Authors

@doubledave @Namasteh

Files

tiny_chat.rb

Dependencies

Description

The TinyChat gem (created for the Cinch IRC Bot Framework) is used to parse an XML API from apigee.com for TinyChat the browser chat client. Using it's commands you can have essential information of a TinyChat room returned to the channel.

Installation

To install the gem:

gem install cinch-tinychat

Configuration

Firstly, the TinyChat gem does not need an API key as it simply parses VML data from a link delivered through the bot.

Secondly, in order for this plugin to work you must load it into the bot. In most Cinch IRC bot formats you will do the following:

At the top of bot.rb put this line:

require 'cinch-tinychat'

In the c.plugins section of bot.rb insert this:

[Cinch::Plugins::TinyChat]

Usage

The TinyChat plugin will query the room you ask it to and return with information on it.

  • !(tinychat|tc) <room>: The bot will return with room information.

About

The TinyChat gem will query the room you ask it to and return with information on it.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages