Skip to content

README.md

Latest commit

 

History

History
82 lines (63 loc) · 2.21 KB

README.md

File metadata and controls

82 lines (63 loc) · 2.21 KB
Raw

clickbait

Description

Collection of plugins for use with the cinch framework.

Usage

bundler

Using bundler for project dependencies.

% gem install bundler

After cloning the repository, install gems. Make sure that bundle is accessible through your $PATH. This will most likely be in $HOME/.gem/ruby/2.2.0/bin/bundle (your version might differ).

% bundle install --path vendor/bundle

Bundler will read the contents of the Gemfile and install dependencies.

Configure

example.rb

require 'bundler/setup'

module Clickbait
  Dir['plugins/*.rb'].each { |p| require_relative p }

  bot = Cinch::Bot.new do
    configure do |c|
      c.nick = 'mybot'
      c.user = 'something'
      c.server = 'irc.freenode.net'
      c.channels = ['#chan1', '#chan2']
      c.port = 7000
      c.ssl.use = true
      c.ssl.verify = true
      c.plugins.plugins = Plugins.constants.map { |p| Plugins.const_get p }
      c.plugins.options[Plugins::Youtube] = { api_key: 'CHANGE_ME' }
      c.plugins.options[Plugins::Imdb]    = { api_key: 'get one at omdbapi.com' }
      c.plugins.options[Plugins::HTTPTitle] = { blacklist: [
        'youtube.com',
        'youtu.be',
        'twitch.tv',
        'imdb.com',
        'twitter.com'
      ] }
      c.plugins.options[Plugins::Twitter]  = {
        consumer_key: 'create an app at https://apps.twitter.com',
        consumer_secret: 'see above'
      }
    end
  end

  bot.loggers.level = :info
  bot.start
end

List of plugins

Youtube

Post titles from youtube. You will need an API key, if you're feeling lazy just use the HTTPTitle plugin for similar functionality.

HTTPTitle

Posts titles from urls mentioned in the channel(s). You can choose to blacklist certain domains to avoid interfering with other plugins. Also useful for sites that offer stale and boring titles not related to its content.

Twitch

Used to collect information from a stream using the Twitch API.

OldURL

Reports if a URL has previously been posted in a channel. You can use it with a variety of adapters, see Sequel for more information.