Everything in this repository, including the README that you are currently reading, is currently under active development. This is pre-release code. As long as this message is displayed, information below may not yet be implemented in the code and the code may not be suitable for production use.
A plugin for Cinch, the IRC bot framework for Ruby. It allows users to play the popular colorful card game in an IRC channel with other IRC users.
First install the gem by running:
[sudo] gem install cinch-uno
or, even better, by adding it to your Gemfile:
gem 'cinch-uno' ~> "0.0.5"
and running bundle
Then load it in your bot:
require "cinch"
require "cinch/plugins/uno"
bot = Cinch::Bot.new do
configure do |c|
c.plugins.plugins = [Cinch::Plugins::Uno]
end
end
bot.start- uno - Starts a game of Uno and waits for players to join.
- hand - The bot sends you a private message containing your current hand.
- top - Shows the top card on the discard pile.
- play [card color] [card type] - Plays a card.
- play wild [card color] - Plays a wild card, specifying the colour it will represent for the next player.
- skip - Skips your turn and moves to the next player.
- challenge - Challenge the validity of the last player's use of Wild Draw Four.
- accept - Accept the validity of the last player's use of Wild Draw Four.
The plugin has rspec unit and integration tests. To run them:
rspec
You may need to bundle install first.