1 # Plugin for the Ruby IRC bot (http://linuxbrit.co.uk/rbot/)
3 # A trivia quiz game. Fast paced, featureful and fun.
5 # (c) 2006 Mark Kretschmann <markey@web.de>
6 # (c) 2006 Jocke Andersson <ajocke@gmail.com>
7 # (c) 2006 Giuseppe Bilotta <giuseppe.bilotta@gmail.com>
8 # Licensed under GPL V2.
11 # Class for storing question/answer pairs
12 QuizBundle = Struct.new( "QuizBundle", :question, :answer )
14 # Class for storing player stats
15 PlayerStats = Struct.new( "PlayerStats", :score, :jokers, :jokers_time )
16 # Why do we still need jokers_time? //Firetech
18 # Maximum number of jokers a player can gain
26 #######################################################################
28 # One Quiz instance per channel, contains channel specific data
29 #######################################################################
31 attr_accessor :registry, :registry_conf, :questions, :question, :answer, :answer_core,
32 :first_try, :hint, :hintrange, :rank_table, :hinted
34 def initialize( channel, registry )
36 @registry = registry.sub_registry( 'private' )
38 @registry = registry.sub_registry( channel )
40 @registry_conf = @registry.sub_registry( "config" )
42 # Per-channel copy of the global questions table. Acts like a shuffled queue
43 # from which questions are taken, until empty. Then we refill it with questions
44 # from the global table.
45 @registry_conf["questions"] = [] unless @registry_conf.has_key?( "questions" )
47 # Autoask defaults to true
48 @registry_conf["autoask"] = true unless @registry_conf.has_key?( "autoask" )
50 @questions = @registry_conf["questions"]
59 # We keep this array of player stats for performance reasons. It's sorted by score
60 # and always synced with the registry player stats hash. This way we can do fast
61 # rank lookups, without extra sorting.
62 @rank_table = @registry.to_a.sort { |a,b| b[1].score<=>a[1].score }
67 #######################################################################
69 #######################################################################
70 class QuizPlugin < Plugin
74 @questions = Array.new
78 # Function that returns whether a char is a "separator", used for hints
94 # Fetches questions from a file on the server and from the wiki, then merges
95 # and transforms the questions and fills the global question table.
98 # Read the winning messages file
99 @win_messages = Array.new
100 if File.exists? "#{@bot.botclass}/quiz/win_messages"
101 IO.foreach("#{@bot.botclass}/quiz/win_messages") { |line| @win_messages << line.chomp }
103 warning( "win_messages file not found!" )
106 # TODO: Make this configurable, and add support for more than one file (there's a size limit in linux too ;) )
107 path = "#{@bot.botclass}/quiz/quiz.rbot"
108 debug "Fetching from #{path}"
110 m.reply "Fetching questions from local database and wiki.."
114 datafile = File.new( path, File::RDONLY )
115 localdata = datafile.read
117 m.reply "Failed to read local database file. oioi."
123 serverdata = @bot.httputil.get_cached( URI.parse( "http://amarok.kde.org/amarokwiki/index.php/Rbot_Quiz" ) )
124 serverdata = serverdata.split( "QUIZ DATA START\n" )[1]
125 serverdata = serverdata.split( "\nQUIZ DATA END" )[0]
126 serverdata = serverdata.gsub( / /, " " ).gsub( /&/, "&" ).gsub( /"/, "\"" )
128 m.reply "Failed to download wiki questions. oioi."
130 m.reply "No questions loaded, aborting."
137 # Fuse together and remove comments, then split
138 data = "\n\n#{localdata}\n\n#{serverdata}".gsub( /^#.*$/, "" )
139 entries = data.split( "\nQuestion: " )
140 #First entry will be empty.
145 # We'll need at least two lines of data
147 # Check if question isn't empty
149 while p[1].match( /^Answer: (.*)$/ ) == nil and p.size > 2
150 # Delete all lines between the question and the answer
153 p[1] = p[1].gsub( /Answer: /, "" ).strip
154 # If the answer was found
156 # Add the data to the array
157 b = QuizBundle.new( p[0], p[1] )
164 m.reply "done, #{@questions.length} questions loaded."
168 # Returns new Quiz instance for channel, or existing one
170 def create_quiz( channel )
171 unless @quizzes.has_key?( channel )
172 @quizzes[channel] = Quiz.new( channel, @registry )
175 return @quizzes[channel]
179 def say_score( m, nick )
180 q = create_quiz( m.channel.to_s )
182 if q.registry.has_key?( nick )
183 score = q.registry[nick].score
184 jokers = q.registry[nick].jokers
187 q.rank_table.each_index { |rank| break if nick == q.rank_table[rank][0] }
190 m.reply "#{nick}'s score is: #{score} Rank: #{rank} Jokers: #{jokers}"
192 m.reply "#{nick} does not have a score yet. Lamer."
197 def help( plugin, topic="" )
199 "Quiz game aministration commands (requires authentication): 'quiz autoask <on/off>' => enable/disable autoask mode. 'quiz transfer <source> <dest> [score] [jokers]' => transfer [score] points and [jokers] jokers from <source> to <dest> (default is entire score and all jokers). 'quiz setscore <player> <score>' => set <player>'s score to <score>. 'quiz setjokers <player> <jokers>' => set <player>'s number of jokers to <jokers>. 'quiz deleteplayer <player>' => delete one player from the rank table (only works when score and jokers are set to 0)."
201 "A multiplayer trivia quiz. 'quiz' => ask a question. 'quiz hint' => get a hint. 'quiz solve' => solve this question. 'quiz skip' => skip to next question. 'quiz joker' => draw a joker to win this round. 'quiz score [player]' => show score for [player] (default is yourself). 'quiz top5' => show top 5 players. 'quiz top <number>' => show top <number> players (max 50). 'quiz stats' => show some statistics. 'quiz fetch' => refetch questions from databases.\nYou can add new questions at http://amarok.kde.org/amarokwiki/index.php/Rbot_Quiz"
206 # Updates the per-channel rank table, which is kept for performance reasons.
207 # This table contains all players sorted by rank.
209 def calculate_ranks( m, q, nick )
210 if q.registry.has_key?( nick )
211 stats = q.registry[nick]
213 # Find player in table
216 q.rank_table.each_index do |i|
217 if nick == q.rank_table[i][0]
223 # Remove player from old position
226 q.rank_table.delete_at( i )
231 # Insert player at new position
233 q.rank_table.each_index do |i|
234 if stats.score > q.rank_table[i][1].score
235 q.rank_table[i,0] = [[nick, stats]]
241 # If less than all other players' scores, append to table
243 i += 1 unless q.rank_table.empty?
244 q.rank_table << [nick, stats]
247 # Print congratulations/condolences if the player's rank has changed
250 m.reply "#{nick} ascends to rank #{i + 1}. Congratulations :)"
252 m.reply "#{nick} slides down to rank #{i + 1}. So Sorry! NOT. :p"
256 q.rank_table << [[nick, PlayerStats.new( 1 )]]
261 # Reimplemented from Plugin
264 return unless @quizzes.has_key?( m.channel.to_s )
265 return unless m.kind_of?(PrivMessage)
266 q = @quizzes[m.channel.to_s]
268 return if q.question == nil
270 message = m.message.downcase.strip
272 if message == q.answer.downcase or message == q.answer_core.downcase
276 reply = "WHOPEEE! #{m.sourcenick.to_s} got it on the first try! That's worth an extra point. Answer was: #{q.answer}"
277 elsif q.rank_table.length >= 1 and m.sourcenick.to_s == q.rank_table[0][0]
278 reply = "THE QUIZ CHAMPION defends his throne! Seems like #{m.sourcenick.to_s} is invicible! Answer was: #{q.answer}"
279 elsif q.rank_table.length >= 2 and m.sourcenick.to_s == q.rank_table[1][0]
280 reply = "THE SECOND CHAMPION is on the way up! Hurry up #{m.sourcenick.to_s}, you only need #{q.rank_table[0][1].score - q.rank_table[1][1].score - 1} points to beat the king! Answer was: #{q.answer}"
281 elsif q.rank_table.length >= 3 and m.sourcenick.to_s == q.rank_table[2][0]
282 reply = "THE THIRD CHAMPION strikes again! Give it all #{m.sourcenick.to_s}, with #{q.rank_table[1][1].score - q.rank_table[2][1].score - 1} more points you'll reach the 2nd place! Answer was: #{q.answer}"
284 reply = @win_messages[rand( @win_messages.length )].dup
285 reply.gsub!( "<who>", m.sourcenick )
286 reply.gsub!( "<answer>", q.answer )
292 if q.registry.has_key?( m.sourcenick.to_s )
293 player = q.registry[m.sourcenick.to_s]
295 player = PlayerStats.new( 0, 0, 0 )
298 player.score = player.score + points
300 # Reward player with a joker every X points
301 if player.score % 15 == 0 and player.jokers < Max_Jokers
303 m.reply "#{m.sourcenick.to_s} gains a new joker. Rejoice :)"
306 q.registry[m.sourcenick.to_s] = player
307 calculate_ranks( m, q, m.sourcenick.to_s )
310 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
312 # First try is used, and it wasn't the answer.
318 # Stretches an IRC nick with dots, simply to make the client not trigger a hilight,
319 # which is annoying for those not watching. Example: markey -> m.a.r.k.e.y
321 def unhilight_nick( nick )
324 0.upto( nick.length - 1 ) do |i|
325 new_nick += nick[i, 1]
326 new_nick += "." unless i == nick.length - 1
333 #######################################################################
335 #######################################################################
336 def cmd_quiz( m, params )
337 fetch_data( m ) if @questions.empty?
338 q = create_quiz( m.channel.to_s )
341 m.reply "#{Bold}#{Color}03Current question: #{Color}#{Bold}#{q.question}"
342 m.reply "Hint: #{q.hint}" if q.hinted
346 # Fill per-channel questions buffer
347 if q.questions.empty?
348 temp = @questions.dup
351 i = rand( temp.length )
352 q.questions << temp[i]
357 i = rand( q.questions.length )
358 q.question = q.questions[i].question
359 q.answer = q.questions[i].answer.gsub( "#", "" )
362 q.answer_core = /(#)(.*)(#)/.match( q.questions[i].answer )[2]
366 q.answer_core = q.answer.dup if q.answer_core == nil
368 # Check if core answer is numerical and tell the players so, if that's the case
369 # The rather obscure statement is needed because to_i and to_f returns 99(.0) for "99 red balloons", and 0 for "balloon"
370 q.question += "#{Color}07 (Numerical answer)#{Color}" if q.answer_core.to_i.to_s == q.answer_core or q.answer_core.to_f.to_s == q.answer_core
372 q.questions.delete_at( i )
377 (0..q.answer_core.length-1).each do |index|
378 if is_sep(q.answer_core[index,1])
379 q.hint << q.answer_core[index]
386 # Generate array of unique random range
387 q.hintrange = (0..q.answer_core.length-1).sort_by{rand}
389 m.reply "#{Bold}#{Color}03Question: #{Color}#{Bold}" + q.question
393 def cmd_solve( m, params )
394 return unless @quizzes.has_key?( m.channel.to_s )
395 q = @quizzes[m.channel.to_s]
397 m.reply "The correct answer was: #{q.answer}"
401 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
405 def cmd_hint( m, params )
406 return unless @quizzes.has_key?( m.channel.to_s )
407 q = @quizzes[m.channel.to_s]
410 m.reply "#{m.sourcenick.to_s}: Get a question first!"
412 num_chars = case q.hintrange.length # Number of characters to reveal
424 index = q.hintrange.pop
425 # New hint char until the char isn't a "separator" (space etc.)
426 end while is_sep(q.answer_core[index,1])
427 q.hint[index] = q.answer_core[index]
429 m.reply "Hint: #{q.hint}"
432 if q.hint == q.answer_core
433 m.reply "#{Bold}#{Color}04BUST!#{Color}#{Bold} This round is over. #{Color}04Minus one point for #{m.sourcenick.to_s}#{Color}."
436 if q.registry.has_key?( m.sourcenick.to_s )
437 stats = q.registry[m.sourcenick.to_s]
439 stats = PlayerStats.new( 0, 0, 0 )
442 stats["score"] = stats.score - 1
443 q.registry[m.sourcenick.to_s] = stats
445 calculate_ranks( m, q, m.sourcenick.to_s )
448 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
454 def cmd_skip( m, params )
455 return unless @quizzes.has_key?( m.channel.to_s )
456 q = @quizzes[m.channel.to_s]
459 cmd_quiz( m, params )
463 def cmd_joker( m, params )
464 q = create_quiz( m.channel.to_s )
467 m.reply "#{m.sourcenick.to_s}: There is no open question."
471 if q.registry[m.sourcenick.to_s].jokers > 0
472 player = q.registry[m.sourcenick.to_s]
475 q.registry[m.sourcenick.to_s] = player
477 calculate_ranks( m, q, m.sourcenick.to_s )
479 if player.jokers != 1
484 m.reply "#{Bold}#{Color}12JOKER!#{Color}#{Bold} #{m.sourcenick.to_s} draws a joker and wins this round. You have #{player.jokers} #{jokers} left."
485 m.reply "The answer was: #{q.answer}."
488 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
490 m.reply "#{m.sourcenick.to_s}: You don't have any jokers left ;("
495 def cmd_fetch( m, params )
500 def cmd_top5( m, params )
501 q = create_quiz( m.channel.to_s )
502 if q.rank_table.empty?
503 m.reply "There are no scores known yet!"
507 m.reply "* Top 5 Players for #{m.channel.to_s}:"
509 [5, q.rank_table.length].min.times do |i|
510 player = q.rank_table[i]
512 score = player[1].score
513 m.reply " #{i + 1}. #{unhilight_nick( nick )} (#{score})"
518 def cmd_top_number( m, params )
519 num = params[:number].to_i
520 return unless 1..50 === num
521 q = create_quiz( m.channel.to_s )
522 if q.rank_table.empty?
523 m.reply "There are no scores known yet!"
528 m.reply "* Top #{num} Players for #{m.channel.to_s}:"
529 n = [ num, q.rank_table.length ].min
531 player = q.rank_table[i]
533 score = player[1].score
534 ar << "#{i + 1}. #{unhilight_nick( nick )} (#{score})"
536 m.reply ar.join(" | ")
540 def cmd_stats( m, params )
541 fetch_data( m ) if @questions.empty?
543 m.reply "* Total Number of Questions:"
544 m.reply " #{@questions.length}"
548 def cmd_score( m, params )
549 say_score( m, m.sourcenick.to_s )
553 def cmd_score_player( m, params )
554 say_score( m, params[:player] )
558 def cmd_autoask( m, params )
559 q = create_quiz( m.channel.to_s )
561 if params[:enable].downcase == "on"
562 q.registry_conf["autoask"] = true
563 m.reply "Enabled autoask mode."
564 cmd_quiz( m, nil ) if q.question == nil
565 elsif params[:enable].downcase == "off"
566 q.registry_conf["autoask"] = false
567 m.reply "Disabled autoask mode."
569 m.reply "Invalid autoask parameter. Use 'on' or 'off'."
574 def cmd_transfer( m, params )
575 q = create_quiz( m.channel.to_s )
577 debug q.rank_table.inspect
579 source = params[:source]
581 transscore = params[:score].to_i
582 transjokers = params[:jokers].to_i
583 debug "Transferring #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
585 if q.registry.has_key?(source)
586 sourceplayer = q.registry[source]
587 score = sourceplayer.score
591 if score < transscore
592 m.reply "#{source} only has #{score} points!"
595 jokers = sourceplayer.jokers
599 if jokers < transjokers
600 m.reply "#{source} only has #{jokers} jokers!!"
603 if q.registry.has_key?(dest)
604 destplayer = q.registry[dest]
606 destplayer = PlayerStats.new(0,0,0)
609 sourceplayer.score -= transscore
610 destplayer.score += transscore
611 sourceplayer.jokers -= transjokers
612 destplayer.jokers += transjokers
614 q.registry[source] = sourceplayer
615 calculate_ranks(m, q, source)
617 q.registry[dest] = destplayer
618 calculate_ranks(m, q, dest)
620 m.reply "Transferred #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
622 m.reply "#{source} doesn't have any points!"
627 def cmd_del_player( m, params )
628 q = create_quiz( m.channel.to_s )
629 debug q.rank_table.inspect
632 if q.registry.has_key?(nick)
633 player = q.registry[nick]
636 m.reply "Can't delete player #{nick} with score #{score}."
639 jokers = player.jokers
641 m.reply "Can't delete player #{nick} with #{jokers} jokers."
644 q.registry.delete(nick)
647 q.rank_table.each_index { |rank|
648 if nick == q.rank_table[rank][0]
653 q.rank_table.delete_at(player_rank)
655 m.reply "Player #{nick} deleted."
657 m.reply "Player #{nick} isn't even in the database."
662 def cmd_set_score(m, params)
663 q = create_quiz( m.channel.to_s )
664 debug q.rank_table.inspect
667 val = params[:score].to_i
668 if q.registry.has_key?(nick)
669 player = q.registry[nick]
672 player = PlayerStats.new( val, 0, 0)
674 q.registry[nick] = player
675 calculate_ranks(m, q, nick)
676 m.reply "Score for player #{nick} set to #{val}."
680 def cmd_set_jokers(m, params)
681 q = create_quiz( m.channel.to_s )
684 val = [params[:jokers].to_i, Max_Jokers].min
685 if q.registry.has_key?(nick)
686 player = q.registry[nick]
689 player = PlayerStats.new( 0, val, 0)
691 q.registry[nick] = player
692 m.reply "Jokers for player #{nick} set to #{val}."
698 plugin = QuizPlugin.new
699 plugin.default_auth( 'edit', false )
702 plugin.map 'quiz', :action => 'cmd_quiz'
703 plugin.map 'quiz solve', :action => 'cmd_solve'
704 plugin.map 'quiz hint', :action => 'cmd_hint'
705 plugin.map 'quiz skip', :action => 'cmd_skip'
706 plugin.map 'quiz joker', :action => 'cmd_joker'
707 plugin.map 'quiz score', :action => 'cmd_score'
708 plugin.map 'quiz score :player', :action => 'cmd_score_player'
709 plugin.map 'quiz fetch', :action => 'cmd_fetch'
710 plugin.map 'quiz top5', :action => 'cmd_top5'
711 plugin.map 'quiz top :number', :action => 'cmd_top_number'
712 plugin.map 'quiz stats', :action => 'cmd_stats'
715 plugin.map 'quiz autoask :enable', :action => 'cmd_autoask', :auth_path => 'edit'
716 plugin.map 'quiz transfer :source :dest :score :jokers', :action => 'cmd_transfer', :auth_path => 'edit', :defaults => {:score => '-1', :jokers => '-1'}
717 plugin.map 'quiz deleteplayer :nick', :action => 'cmd_del_player', :auth_path => 'edit'
718 plugin.map 'quiz setscore :nick :score', :action => 'cmd_set_score', :auth_path => 'edit'
719 plugin.map 'quiz setjokers :nick :jokers', :action => 'cmd_set_jokers', :auth_path => 'edit'