Trigonoculus / cinch-codenames

cinch plugin allowing play-by-IRC of Codenames

cinch-codenames

This is an IRC bot using cinch, cinch-game-bot and codenames to allow play-by-IRC of "Codenames" by Vlaada Chvátil

https://boardgamegeek.com/boardgame/178900

Setup

You'll need a recent version of Ruby. Ruby 2.1 or newer is required because of required keyword arguments. The build status will confirm compatibility with various Ruby versions. Note that 2.1 is in security maintenance mode, so it would be better to use a later version.

You'll need to install the required gems, which can be done automatically via bundle install, or manually by reading the Gemfile and using gem install on each gem listed.

Usage

Given that you have performed the requisite setup, the minimal code to get a working bot might resemble:

require 'cinch'
require 'cinch/plugins/codenames'

bot = Cinch::Bot.new do
  configure do |c|
    c.nick            = 'CodenamesBot'
    c.server          = 'irc.example.org'
    c.channels        = ['#playcodenames']
    c.plugins.plugins = [Cinch::Plugins::Codenames]
    c.plugins.options[Cinch::Plugins::Codenames] = {
      channels: ['#playcodenames'],
      settings: 'codenames-settings.yaml',
    }
  end
end

bot.start