4 # :title: Uno Game Plugin for rbot
6 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
8 # Copyright:: (C) 2008 Giuseppe Bilotta
12 # Uno Game: get rid of the cards you have
15 # TODO allow full form card names for play
16 # TODO allow color specification with wild
17 # TODO allow choice of rules re stacking + and playing Reverse with them
18 # TODO highscore table
21 COLORS = %w{Red Green Blue Yellow}
22 SPECIALS = %w{+2 Reverse Skip}
23 NUMERICS = (0..9).to_a
24 VALUES = NUMERICS + SPECIALS
26 def UnoGame.color_map(clr)
39 def UnoGame.irc_color_bg(clr)
40 Irc.color([:white,:black][COLORS.index(clr)%2],UnoGame.color_map(clr))
43 def UnoGame.irc_color_fg(clr)
44 Irc.color(UnoGame.color_map(clr))
47 def UnoGame.colorify(str, fg=false)
49 str.length.times do |i|
51 UnoGame.irc_color_fg(COLORS[i%4]) :
52 UnoGame.irc_color_bg(COLORS[i%4]) ) +str[i,1]
57 UNO = UnoGame.colorify('UNO!', true)
63 attr_reader :shortform
67 def initialize(color, value)
68 raise unless COLORS.include? color
70 raise unless VALUES.include? value
71 if NUMERICS.include? value
79 @shortform = (@color[0,1]+@value).downcase
81 @shortform = (@color[0,1]+@value.to_s[0,1]).downcase
83 @to_s = UnoGame.irc_color_bg(@color) +
84 Bold + ['', @color, @value, ''].join(' ') + NormalText
88 return 0 unless @value.to_s[0,1] == '+'
89 return @value[1,1].to_i
93 SPECIALS.include?(@value)
97 cc = self.color <=> other.color
99 return self.value.to_s <=> other.value.to_s
107 # Wild, Wild +4 cards
109 def initialize(value=nil)
111 raise if value and not value == '+4'
114 @shortform = 'w'+value
120 @to_s = UnoGame.colorify(['', @color, @value, ''].compact.join(' '))
137 has << c if c.shortform == short
146 Bold + @user.to_s + Bold
154 # previous discard, in case of challenge
155 attr_reader :last_discard
156 # channel the game is played in
160 # true if the player picked a card (and can thus pass turn)
161 attr_reader :player_has_picked
162 # number of cards to be picked if the player can't play an appropriate card
165 def initialize(plugin, channel)
189 return p if p.user == user
193 return p if p.user.irc_downcase == user.irc_downcase(channel.casemap)
196 get_player(user.to_s)
201 def announce(msg, opts={})
202 @bot.say channel, msg, opts
205 def notify(player, msg, opts={})
206 @bot.notice player.user, msg, opts
210 @base_stock = COLORS.inject([]) do |list, clr|
212 list << Card.new(clr, n)
213 list << Card.new(clr, n) unless n == 0
218 @base_stock << Wild.new
219 @base_stock << Wild.new('+4')
224 @stock.replace @base_stock
225 # remove the cards in the players hand
226 @players.each { |p| p.cards.each { |c| @stock.delete_one c } }
227 # remove current top discarded card if present
229 @stock.delete_one(discard)
235 debug "Starting game"
238 announce _("%{p} deals the first card from the stock") % {
244 while Wild === card do
245 @stock.insert(rand(@stock.length), card)
254 @start_time = Time.now
259 Utils.secs_to_string(Time.now-@start_time)
266 # if there are two players, the Reverse acts like a Skip, unless
267 # there's a @picker running, in which case the Reverse should bounce the
268 # pick on the other player
269 if @players.length > 2
271 # put the current player back in its place
272 @players.unshift @players.pop
273 announce _("Playing order was reversed!")
275 announce _("%{cp} bounces the pick to %{np}") % {
276 :cp => @players.first,
285 @players << @players.shift
286 announce _("%{p} skips a turn!") % {
287 # this is first and not last because the actual
288 # turn change will be done by the following next_turn
304 def set_discard(card)
306 @value = card.value.dup rescue card.value
310 @color = card.color.dup
313 @picker += card.picker
314 @last_picker = @discard.picker
324 def next_turn(opts={})
325 @players << @players.shift
326 @player_has_picked = false
331 # if play is forced, check against the only allowed cards
332 return false if @must_play and not @must_play.include?(card)
334 # When a +something is online, you can only play a +something of same or
335 # higher something, or a Reverse of the correct color, or a Reverse on
339 return true if card.picker >= @last_picker
340 return true if card.value == 'Reverse' and (card.color == @color or @discard.value == card.value)
343 # You can always play a Wild
344 return true if Wild === card
345 # On a Wild, you must match the color
347 return card.color == @color
349 # Otherwise, you can match either the value or the color
350 return (card.value == @value) || (card.color == @color)
355 def play_card(source, cards)
356 debug "Playing card #{cards}"
357 p = get_player(source)
358 shorts = cards.gsub(/\s+/,'').match(/^(?:([rbgy]\+?\d){1,2}|([rbgy][rs])|(w(?:\+4)?)([rbgy])?)$/).to_a
361 announce _("what cards were that again?")
365 short = shorts[1] || shorts[2] || shorts[3]
371 toplay = (full == short) ? 1 : 2
373 debug [full, short, jolly, jcolor, toplay].inspect
374 # r7r7 -> r7r7, r7, nil, nil
375 # r7 -> r7, r7, nil, nil
376 # w -> w, nil, w, nil
377 # wg -> wg, nil, w, g
378 if cards = p.has_card?(short)
380 unless can_play(cards.first)
381 announce _("you can't play that card")
384 if cards.length >= toplay
385 # if the played card is a W+4 not played during a stacking +x
386 # TODO if A plays an illegal W+4, B plays a W+4, should the next
387 # player be able to challenge A? For the time being we say no,
388 # but I think he should, and in case A's move was illegal
389 # game would have to go back, A would get the penalty and replay,
390 # while if it was legal the challenger would get 50% more cards,
391 # i.e. 12 cards (or more if the stacked +4 were more). This would
392 # only be possible if the first W+4 was illegal, so it wouldn't
393 # apply for a W+4 played on a +2 anyway.
395 if @picker == 0 and Wild === cards.first and cards.first.value
396 # save the previous discard in case of challenge
397 @last_discard = @discard.dup
398 # save the color too, in case it was a Wild
399 @last_color = @color.dup
401 # mark the move as not challengeable
405 set_discard(p.cards.delete_one(cards.shift))
407 set_discard(p.cards.delete_one(cards.shift))
408 announce _("%{p} plays %{card} twice!") % {
413 announce _("%{p} plays %{card}") % { :p => p, :card => @discard }
415 if p.cards.length == 1
416 announce _("%{p} has %{uno}!") % {
419 elsif p.cards.length == 0
430 choose_color(p.user, jcolor)
432 announce _("%{p}, choose a color with: co r|b|g|y") % { :p => p }
435 announce _("you don't have two cards of that kind")
438 announce _("you don't have that card")
443 return unless @last_discard
448 announce _("%{cp} challenges %{lp}'s %{card}!") % {
449 :cp => cp, :lp => lp, :card => @discard
451 # show the cards of the previous player to the current player
452 notify cp, _("%{p} has %{cards}") % {
453 :p => lp, :cards => lp.cards.join(' ')
455 # check if the previous player had a non-special card of the correct color
458 if c.color == @last_color and not c.special?
464 announce _("%{lp}'s move was legal, %{cp} must pick %{b}%{n}%{b} cards!") % {
465 :cp => cp, :lp => lp, :b => Bold, :n => @picker
473 announce _("%{lp}'s move was %{b}not%{b} legal, %{lp} must pick %{b}%{n}%{b} cards and play again!") % {
474 :cp => cp, :lp => lp, :b => Bold, :n => @picker
476 lp.cards << @discard # put the W+4 back in place
479 @color = @last_color.dup
480 @discard = @last_discard.dup
482 @value = @discard.value.dup rescue @discard.value
486 # force the player to play the current cards
487 @must_play = lp.cards.dup
489 # give him the penalty cards
493 # and restore the turn
494 @players.unshift @players.pop
501 announce _("%{p} passes turn, and has to pick %{b}%{n}%{b} cards!") % {
502 :p => p, :b => Bold, :n => @picker
507 if @player_has_picked
508 announce _("%{p} passes turn") % { :p => p }
510 announce _("you need to pick a card first")
517 def choose_color(user, color)
528 announce _('what color is that?')
531 announce _('color is now %{c}') % {
532 :c => UnoGame.irc_color_bg(@color)+" #{@color} "
539 announce _("This %{uno} game has been going on for %{time}") % {
541 :time => elapsed_time
544 announce _("The game hasn't started yet")
549 announce _("%{uno} playing turn: %{players}") % {
550 :uno => UNO, :players => players.join(' ')
554 def show_turn(opts={})
556 cards = opts[:cards] if opts.key?(:cards)
557 player = @players.first
558 announce _("it's %{player}'s turn") % { :player => player }
559 show_user_cards(player) if cards
562 def has_turn?(source)
563 @players.first.user == source
568 announce _("next player must respond correctly or pick %{b}%{n}%{b} cards") % {
569 :b => Bold, :n => @picker
575 announce _("Current discard: %{card} %{c}") % { :card => @discard,
576 :c => (Wild === @discard) ? UnoGame.irc_color_bg(@color) + " #{@color} " : nil
581 def show_user_cards(player)
582 p = Player === player ? player : get_player(player)
583 notify p, _('Your cards: %{cards}') % {
584 :cards => p.cards.join(' ')
588 def show_all_cards(u=nil)
589 announce(@players.inject([]) { |list, p|
590 list << [p, p.cards.length].join(': ')
599 announce _("%{player} picks a card") % { :player => p }
601 @player_has_picked = true
604 def deal(player, num=1)
607 picked << @stock.delete_one
608 if @stock.length == 0
609 announce _("Shuffling discarded cards")
611 if @stock.length == 0
612 announce _("No more cards!")
613 end_game # FIXME nope!
618 notify player, _("You picked %{picked}") % { :picked => picked.join(' ') }
619 player.cards += picked
624 if p = get_player(user)
625 announce _("you're already in the game, %{p}") % {
630 @dropouts.each do |dp|
632 announce _("you dropped from the game, %{p}, you can't get back in") % {
640 cards = @players.inject(0) do |s, pl|
646 announce _("%{p} joins this game of %{uno}") % {
650 return if @start_time
652 @bot.timer.reschedule(@join_timer, 10)
653 elsif @players.length > 1
654 announce _("game will start in 20 seconds")
655 @join_timer = @bot.timer.add_once(20) {
661 def drop_player(nick)
662 # A nick is passed because the original player might have left
664 unless p = get_player(nick)
665 announce _("%{p} isn't playing %{uno}") % {
670 announce _("%{p} gives up this game of %{uno}") % {
675 if p == @players.first
685 while p.cards.length > 0
686 @stock.insert(rand(@stock.length), p.cards.shift)
689 @dropouts << @players.delete_one(p)
692 def replace_player(old, new)
694 user = channel.get_user(new)
695 if p = get_player(user)
696 announce _("%{p} is already playing %{uno} here") % {
701 # We scan the player list of the player with the old nick, instead
702 # of using get_player, in case of IRC drops etc
704 if p.user.nick == old
706 announce _("%{p} takes %{b}%{old}%{b}'s place at %{uno}") % {
707 :p => p, :b => Bold, :old => old, :uno => UNO
712 announce _("%{b}%{old}%{b} isn't playing %{uno} here") % {
713 :uno => UNO, :b => Bold, :old => old
717 def end_game(halted = false)
718 runtime = @start_time ? Time.now - @start_time : 0
721 announce _("%{uno} game halted after %{time}") % {
722 :time => elapsed_time,
726 announce _("%{uno} game halted before it could start") % {
731 announce _("%{uno} game finished after %{time}! The winner is %{p}") % {
732 :time => elapsed_time,
733 :uno => UNO, :p => @players.first
736 if @picker > 0 and not halted
738 announce _("%{p} has to pick %{b}%{n}%{b} cards!") % {
739 :p => p, :n => @picker, :b => Bold
744 score = @players.inject(0) do |sum, p|
745 if p.cards.length > 0
746 announce _("%{p} still had %{cards}") % {
747 :p => p, :cards => p.cards.join(' ')
749 sum += p.cards.inject(0) do |cs, c|
756 closure = { :dropouts => @dropouts, :players => @players, :runtime => runtime }
758 announce _("%{p} wins with %{b}%{score}%{b} points!") % {
759 :p => @players.first, :score => score, :b => Bold
761 closure.merge!(:winner => @players.first, :score => score,
762 :opponents => @players.length - 1)
765 @plugin.do_end_game(@channel, closure)
770 # A won game: store score and number of opponents, so we can calculate
771 # an average score per opponent (requested by Squiddhartha)
772 define_structure :UnoGameWon, :score, :opponents
773 # For each player we store the number of games played, the number of
774 # games forfeited, and an UnoGameWon for each won game
775 define_structure :UnoPlayerStats, :played, :forfeits, :won
777 class UnoPlugin < Plugin
784 def help(plugin, topic="")
788 _("'jo' to join in"),
789 _("'pl <card>' to play <card>: e.g. 'pl g7' to play Green 7, or 'pl rr' to play Red Reverse, or 'pl y2y2' to play both Yellow 2 cards"),
790 _("'pe' to pick a card"),
791 _("'pa' to pass your turn"),
792 _("'co <color>' to pick a color after playing a Wild: e.g. 'co g' to select Green (or 'pl w+4 g' to select the color when playing the Wild)"),
793 _("'ca' to show current cards"),
794 _("'cd' to show the current discard"),
795 _("'ch' to challenge a Wild +4"),
796 _("'od' to show the playing order"),
797 _("'ti' to show play time"),
798 _("'tu' to show whose turn it is")
801 _("A Wild +4 can only be played legally if you don't have normal (not special) cards of the current color. ") +
802 _("The next player can challenge a W+4 by using the 'ch' command. ") +
803 _("If the W+4 play was illegal, the player who played it must pick the W+4, pick 4 cards from the stock, and play a legal card. ") +
804 _("If the W+4 play was legal, the challenger must pick 6 cards instead of 4.")
806 _("play all your cards, one at a time, by matching either the color or the value of the currently discarded card. ") +
807 _("cards with special effects: Skip (next player skips a turn), Reverse (reverses the playing order), +2 (next player has to take 2 cards). ") +
808 _("Wilds can be played on any card, and you must specify the color for the next card. ") +
809 _("Wild +4 also forces the next player to take 4 cards, but it can only be played if you can't play a color card. ") +
810 _("you can play another +2 or +4 card on a +2 card, and a +4 on a +4, forcing the first player who can't play one to pick the cumulative sum of all cards. ") +
811 _("you can also play a Reverse on a +2 or +4, bouncing the effect back to the previous player (that now comes next). ")
813 (_("%{uno} game. !uno to start a game. see help uno rules for the rules. commands: %{cmds}") % {
814 :uno => UnoGame::UNO,
815 :cmds => help(plugin, 'commands')
821 return unless @games.key?(m.channel)
822 g = @games[m.channel]
826 g.add_player(m.source)
829 if g.has_turn?(m.source)
830 if g.player_has_picked
831 m.reply _("you already picked a card")
835 g.pick_card(m.source)
838 m.reply _("It's not your turn")
842 if g.has_turn?(m.source)
845 m.reply _("It's not your turn")
848 if g.has_turn?(m.source)
849 g.play_card(m.source, m.params.downcase)
851 m.reply _("It's not your turn")
853 when :co # pick color
854 if g.has_turn?(m.source)
855 g.choose_color(m.source, m.params.downcase)
857 m.reply _("It's not your turn")
859 when :ca # show current cards
861 g.show_all_cards(m.source)
862 when :cd # show current discard
866 if g.has_turn?(m.source)
870 m.reply _("previous move cannot be challenged")
873 m.reply _("It's not your turn")
875 when :od # show playing order
878 when :ti # show play time
881 when :tu # show whose turn is it
883 if g.has_turn?(m.source)
884 m.nickreply _("it's your turn, sleepyhead")
886 g.show_turn(:cards => false)
891 def create_game(m, p)
892 if @games.key?(m.channel)
893 m.reply _("There is already an %{uno} game running here, say 'jo' to join in") % { :uno => UnoGame::UNO }
896 @games[m.channel] = UnoGame.new(self, m.channel)
897 m.reply _("Ok, created %{uno} game on %{channel}, say 'jo' to join in") % {
898 :uno => UnoGame::UNO,
899 :channel => m.channel
904 unless @games.key?(m.channel)
905 m.reply _("There is no %{uno} game running here") % { :uno => UnoGame::UNO }
908 @games[m.channel].end_game(true)
911 def chan_reg(channel)
912 @registry.sub_registry(channel.downcase)
915 def chan_stats(channel)
916 stats = chan_reg(channel).sub_registry('stats')
929 def chan_pstats(channel)
930 pstats = chan_reg(channel).sub_registry('players')
931 pstats.set_default(UnoPlayerStats.new(0,0,[]))
935 def do_end_game(channel, closure)
936 reg = chan_reg(channel)
937 stats = chan_stats(channel)
939 stats['played_runtime'] += closure[:runtime]
941 stats['finished'] += 1
942 stats['finished_runtime'] += closure[:runtime]
944 pstats = chan_pstats(channel)
946 closure[:players].each do |pl|
953 closure[:dropouts].each do |pl|
961 winner = closure[:winner]
962 won = UnoGameWon.new(closure[:score], closure[:opponents])
963 k = winner.user.downcase
964 pls = pstats[k] # already marked played +1 above
969 @games.delete(channel)
972 def do_chanstats(m, p)
973 stats = chan_stats(m.channel)
975 nf = stats['finished']
977 str = _("%{nf} %{uno} games completed over %{np} games played. ") % {
978 :np => np, :uno => UnoGame::UNO, :nf => nf
980 cgt = stats['finished_runtime']
981 tgt = stats['played_runtime']
982 str << _("%{cgt} game time for completed games") % {
983 :cgt => Utils.secs_to_string(cgt)
986 str << _(" on %{tgt} total game time. ") % {
987 :tgt => Utils.secs_to_string(tgt)
992 str << _("%{avg} average game time for completed games") % {
993 :avg => Utils.secs_to_string(cgt/nf)
995 str << _(", %{tavg} for all games") % {
996 :tavg => Utils.secs_to_string(tgt/np)
1000 m.reply _("nobody has played %{uno} on %{chan} yet") % {
1001 :uno => UnoGame::UNO, :chan => m.channel
1007 dnick = p[:nick] || m.source # display-nick, don't later case
1008 nick = dnick.downcase
1009 ps = chan_pstats(m.channel)[nick]
1011 m.reply _("%{nick} never played %{uno} here") % {
1012 :uno => UnoGame::UNO, :nick => dnick
1019 score = ps.won.inject(0) { |sum, w| sum += w.score }
1020 str = _("%{nick} played %{np} %{uno} games here, ") % {
1021 :nick => dnick, :np => np, :uno => UnoGame::UNO
1023 str << _("forfeited %{nf} games, ") % { :nf => nf } if nf > 0
1024 str << _("won %{nw} games") % { :nw => nw}
1026 str << _(" with %{score} total points") % { :score => score }
1027 avg = ps.won.inject(0) { |sum, w| sum += w.score/w.opponents }/nw
1028 str << _(" and an average of %{avg} points per opponent") % { :avg => avg }
1033 def replace_player(m, p)
1034 unless @games.key?(m.channel)
1035 m.reply _("There is no %{uno} game running here") % { :uno => UnoGame::UNO }
1038 @games[m.channel].replace_player(p[:old], p[:new])
1041 def drop_player(m, p)
1042 unless @games.key?(m.channel)
1043 m.reply _("There is no %{uno} game running here") % { :uno => UnoGame::UNO }
1046 @games[m.channel].drop_player(p[:nick] || m.source.nick)
1049 def print_stock(m, p)
1050 unless @games.key?(m.channel)
1051 m.reply _("There is no %{uno} game running here") % { :uno => UnoGame::UNO }
1054 stock = @games[m.channel].stock
1055 m.reply(_("%{num} cards in stock: %{stock}") % {
1056 :num => stock.length,
1057 :stock => stock.join(' ')
1058 }, :split_at => /#{NormalText}\s*/)
1064 pg.map 'uno', :private => false, :action => :create_game
1065 pg.map 'uno end', :private => false, :action => :end_game
1066 pg.map 'uno drop', :private => false, :action => :drop_player
1067 pg.map 'uno giveup', :private => false, :action => :drop_player
1068 pg.map 'uno drop :nick', :private => false, :action => :drop_player, :auth_path => ':other'
1069 pg.map 'uno replace :old [with] :new', :private => false, :action => :replace_player
1070 pg.map 'uno stock', :private => false, :action => :print_stock
1071 pg.map 'uno chanstats', :private => false, :action => :do_chanstats
1072 pg.map 'uno stats [:nick]', :private => false, :action => :do_pstats
1074 pg.default_auth('stock', false)
1075 pg.default_auth('end', false)
1076 pg.default_auth('drop::other', false)
1077 pg.default_auth('replace', false)