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 )
35 @registry = registry.sub_registry( channel )
36 @registry_conf = @registry.sub_registry( "config" )
38 # Per-channel copy of the global questions table. Acts like a shuffled queue
39 # from which questions are taken, until empty. Then we refill it with questions
40 # from the global table.
41 @registry_conf["questions"] = [] unless @registry_conf.has_key?( "questions" )
43 # Autoask defaults to true
44 @registry_conf["autoask"] = true unless @registry_conf.has_key?( "autoask" )
46 @questions = @registry_conf["questions"]
55 # We keep this array of player stats for performance reasons. It's sorted by score
56 # and always synced with the registry player stats hash. This way we can do fast
57 # rank lookups, without extra sorting.
58 @rank_table = @registry.to_a.sort { |a,b| b[1].score<=>a[1].score }
63 #######################################################################
65 #######################################################################
66 class QuizPlugin < Plugin
70 @questions = Array.new
74 # Function that returns whether a char is a "separator", used for hints
90 # Fetches questions from a file on the server and from the wiki, then merges
91 # and transforms the questions and fills the global question table.
94 # TODO: Make this configurable, and add support for more than one file (there's a size limit in linux too ;) )
95 # Read the winning messages file
96 @win_messages = Array.new
97 if File.exists? "#{@bot.botclass}/quiz/win_messages"
98 IO.foreach("#{@bot.botclass}/quiz/win_messages") { |line| @win_messages << line.chomp }
100 warning( "win_messages file not found!" )
103 path = "#{@bot.botclass}/quiz/quiz.rbot"
104 debug "Fetching from #{path}"
106 m.reply "Fetching questions from local database and wiki.."
110 datafile = File.new( path, File::RDONLY )
111 localdata = datafile.read
113 m.reply "Failed to read local database file. oioi."
119 serverdata = @bot.httputil.get( URI.parse( "http://amarok.kde.org/amarokwiki/index.php/Rbot_Quiz" ) )
120 serverdata = serverdata.split( "QUIZ DATA START\n" )[1]
121 serverdata = serverdata.split( "\nQUIZ DATA END" )[0]
122 serverdata = serverdata.gsub( / /, " " ).gsub( /&/, "&" ).gsub( /"/, "\"" )
124 m.reply "Failed to download wiki questions. oioi."
126 m.reply "No questions loaded, aborting."
133 # Fuse together and remove comments, then split
134 data = "#{localdata}\n\n#{serverdata}".gsub( /^#.*$/, "" )
135 entries = data.split( "\nQuestion: " )
136 #First entry will be empty.
141 # We'll need at least two lines of data
143 # Check if question isn't empty
145 while p[1].match( /^Answer: (.*)$/ ) == nil and p.size > 2
146 # Delete all lines between the question and the answer
149 p[1] = p[1].gsub( /Answer: /, "" ).strip
150 # If the answer was found
152 # Add the data to the array
153 b = QuizBundle.new( p[0], p[1] )
160 m.reply "done, #{@questions.length} questions loaded."
164 # Returns new Quiz instance for channel, or existing one
166 def create_quiz( channel )
167 unless @quizzes.has_key?( channel )
168 @quizzes[channel] = Quiz.new( channel, @registry )
171 return @quizzes[channel]
175 def say_score( m, nick )
176 q = create_quiz( m.target.to_s )
178 if q.registry.has_key?( nick )
179 score = q.registry[nick].score
180 jokers = q.registry[nick].jokers
183 q.rank_table.each_index { |rank| break if nick == q.rank_table[rank][0] }
186 m.reply "#{nick}'s score is: #{score} Rank: #{rank} Jokers: #{jokers}"
188 m.reply "#{nick} does not have a score yet. Lamer."
193 def help( plugin, topic="" )
195 "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)."
197 "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"
202 # Updates the per-channel rank table, which is kept for performance reasons
204 def calculate_ranks( m, q, nick )
205 if q.registry.has_key?( nick )
206 stats = q.registry[nick]
208 # Find player in table
210 q.rank_table.each_index do |i|
211 break if nick == q.rank_table[i][0]
215 q.rank_table.delete_at( i )
217 # Insert player at new position
219 q.rank_table.each_index do |i|
220 if stats.score >= q.rank_table[i][1].score
221 q.rank_table[i,0] = [[nick, stats]]
227 # If less than all other players' scores, append at the end
229 q.rank_table << [nick, stats]
234 m.reply "#{nick} ascends to rank #{i + 1}. Congratulations :)"
236 m.reply "#{nick} slides down to rank #{i + 1}. So Sorry! NOT. :p"
239 q.rank_table << [[nick, PlayerStats.new( 1 )]]
241 debug q.rank_table.inspect
245 # Reimplemented from Plugin
248 return unless @quizzes.has_key?( m.target.to_s )
249 q = @quizzes[m.target.to_s]
251 return if q.question == nil
253 message = m.message.downcase.strip
255 if message == q.answer.downcase or message == q.answer_core.downcase
259 reply = "WHOPEEE! #{m.sourcenick.to_s} got it on the first try! That's worth an extra point. Answer was: #{q.answer}"
260 elsif q.rank_table.length >= 1 and m.sourcenick.to_s == q.rank_table[0][0]
261 reply = "THE QUIZ CHAMPION defends his throne! Seems like #{m.sourcenick.to_s} is invicible! Answer was: #{q.answer}"
262 elsif q.rank_table.length >= 2 and m.sourcenick.to_s == q.rank_table[1][0]
263 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}"
264 elsif q.rank_table.length >= 3 and m.sourcenick.to_s == q.rank_table[2][0]
265 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}"
267 reply = @win_messages[rand( @win_messages.length )]
268 reply.gsub!( "<who>", m.sourcenick )
269 reply.gsub!( "<answer>", q.answer )
275 if q.registry.has_key?( m.sourcenick.to_s )
276 player = q.registry[m.sourcenick.to_s]
278 player = PlayerStats.new( 0, 0, 0 )
281 player.score = player.score + points
283 # Reward player with a joker every X points
284 if player.score % 15 == 0 and player.jokers < Max_Jokers
286 m.reply "#{m.sourcenick.to_s} gains a new joker. Rejoice :)"
289 q.registry[m.sourcenick.to_s] = player
290 calculate_ranks( m, q, m.sourcenick.to_s )
293 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
295 # First try is used, and it wasn't the answer.
301 # Stretches an IRC nick with dots, simply to make the client not trigger a hilight,
302 # which is annoying for those not watching. Example: markey -> m.a.r.k.e.y
304 def unhilight_nick( nick )
307 0.upto( nick.length - 1 ) do |i|
308 new_nick += nick[i, 1]
309 new_nick += "." unless i == nick.length - 1
316 #######################################################################
318 #######################################################################
319 def cmd_quiz( m, params )
320 fetch_data( m ) if @questions.empty?
321 q = create_quiz( m.target.to_s )
324 m.reply "#{Bold}#{Color}03Current question: #{Color}#{Bold}#{q.question}"
325 m.reply "Hint: #{q.hint}" if q.hinted
329 # Fill per-channel questions buffer
330 if q.questions.empty?
331 temp = @questions.dup
334 i = rand( temp.length )
335 q.questions << temp[i]
340 i = rand( q.questions.length )
341 q.question = q.questions[i].question
342 q.answer = q.questions[i].answer.gsub( "#", "" )
345 q.answer_core = /(#)(.*)(#)/.match( q.questions[i].answer )[2]
349 q.answer_core = q.answer.dup if q.answer_core == nil
351 # Check if core answer is numerical and tell the players so, if that's the case
352 # The rather obscure statement is needed because to_i and to_f returns 99(.0) for "99 red balloons", and 0 for "balloon"
353 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
355 q.questions.delete_at( i )
360 (0..q.answer_core.length-1).each do |index|
361 if is_sep(q.answer_core[index,1])
362 q.hint << q.answer_core[index]
369 # Generate array of unique random range
370 q.hintrange = (0..q.answer_core.length-1).sort_by{rand}
372 m.reply "#{Bold}#{Color}03Question: #{Color}#{Bold}" + q.question
376 def cmd_solve( m, params )
377 return unless @quizzes.has_key?( m.target.to_s )
378 q = @quizzes[m.target.to_s]
380 m.reply "The correct answer was: #{q.answer}"
384 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
388 def cmd_hint( m, params )
389 return unless @quizzes.has_key?( m.target.to_s )
390 q = @quizzes[m.target.to_s]
393 m.reply "#{m.sourcenick.to_s}: Get a question first!"
395 num_chars = case q.hintrange.length # Number of characters to reveal
407 index = q.hintrange.pop
408 # New hint char until the char isn't a "separator" (space etc.)
409 end while is_sep(q.answer_core[index,1])
410 q.hint[index] = q.answer_core[index]
412 m.reply "Hint: #{q.hint}"
415 if q.hint == q.answer_core
416 m.reply "#{Bold}#{Color}04BUST!#{Color}#{Bold} This round is over. #{Color}04Minus one point for #{m.sourcenick.to_s}#{Color}."
419 if q.registry.has_key?( m.sourcenick.to_s )
420 stats = q.registry[m.sourcenick.to_s]
422 stats = PlayerStats.new( 0, 0, 0 )
425 stats["score"] = stats.score - 1
426 q.registry[m.sourcenick.to_s] = stats
428 calculate_ranks( m, q, m.sourcenick.to_s )
431 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
437 def cmd_skip( m, params )
438 return unless @quizzes.has_key?( m.target.to_s )
439 q = @quizzes[m.target.to_s]
442 cmd_quiz( m, params )
446 def cmd_joker( m, params )
447 q = create_quiz( m.target.to_s )
450 m.reply "#{m.sourcenick.to_s}: There is no open question."
454 if q.registry[m.sourcenick.to_s].jokers > 0
455 player = q.registry[m.sourcenick.to_s]
458 q.registry[m.sourcenick.to_s] = player
460 calculate_ranks( m, q, m.sourcenick.to_s )
462 if player.jokers != 1
467 m.reply "#{Bold}#{Color}12JOKER!#{Color}#{Bold} #{m.sourcenick.to_s} draws a joker and wins this round. You have #{player.jokers} #{jokers} left."
468 m.reply "The answer was: #{q.answer}."
471 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
473 m.reply "#{m.sourcenick.to_s}: You don't have any jokers left ;("
478 def cmd_fetch( m, params )
483 def cmd_top5( m, params )
484 q = create_quiz( m.target.to_s )
486 debug q.rank_table.inspect
488 m.reply "* Top 5 Players for #{m.target.to_s}:"
490 [5, q.rank_table.length].min.times do |i|
491 player = q.rank_table[i]
493 score = player[1].score
494 m.reply " #{i + 1}. #{unhilight_nick( nick )} (#{score})"
499 def cmd_top_number( m, params )
500 num = params[:number].to_i
501 return unless 1..50 === num
502 q = create_quiz( m.target.to_s )
504 debug q.rank_table.inspect
507 m.reply "* Top #{num} Players for #{m.target.to_s}:"
508 n = [ num, q.rank_table.length ].min
510 player = q.rank_table[i]
512 score = player[1].score
513 ar << "#{i + 1}. #{unhilight_nick( nick )} (#{score})"
518 m.reply "Noone in #{m.target.to_s} has a score!"
525 def cmd_stats( m, params )
526 fetch_data( m ) if @questions.empty?
528 m.reply "* Total Number of Questions:"
529 m.reply " #{@questions.length}"
533 def cmd_score( m, params )
534 say_score( m, m.sourcenick.to_s )
538 def cmd_score_player( m, params )
539 say_score( m, params[:player] )
543 def cmd_autoask( m, params )
544 q = create_quiz( m.target.to_s )
546 if params[:enable].downcase == "on"
547 q.registry_conf["autoask"] = true
548 m.reply "Enabled autoask mode."
549 cmd_quiz( m, nil ) if q.question == nil
550 elsif params[:enable].downcase == "off"
551 q.registry_conf["autoask"] = false
552 m.reply "Disabled autoask mode."
554 m.reply "Invalid autoask parameter. Use 'on' or 'off'."
559 def cmd_transfer( m, params )
560 q = create_quiz( m.target.to_s )
562 debug q.rank_table.inspect
564 source = params[:source]
566 transscore = params[:score].to_i
567 transjokers = params[:jokers].to_i
568 debug "Transferring #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
570 if q.registry.has_key?(source)
571 sourceplayer = q.registry[source]
572 score = sourceplayer.score
576 if score < transscore
577 m.reply "#{source} only has #{score} points!"
580 jokers = sourceplayer.jokers
584 if jokers < transjokers
585 m.reply "#{source} only has #{jokers} jokers!!"
588 if q.registry.has_key?(dest)
589 destplayer = q.registry[dest]
591 destplayer = PlayerStats.new(0,0,0)
594 sourceplayer.score -= transscore
595 destplayer.score += transscore
596 sourceplayer.jokers -= transjokers
597 destplayer.jokers += transjokers
599 q.registry[source] = sourceplayer
600 calculate_ranks(m, q, source)
602 q.registry[dest] = destplayer
603 calculate_ranks(m, q, dest)
605 m.reply "Transferred #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
607 m.reply "#{source} doesn't have any points!"
612 def cmd_del_player( m, params )
613 q = create_quiz( m.target.to_s )
614 debug q.rank_table.inspect
617 if q.registry.has_key?(nick)
618 player = q.registry[nick]
621 m.reply "Can't delete player #{nick} with score #{score}."
624 jokers = player.jokers
626 m.reply "Can't delete player #{nick} with #{jokers} jokers."
629 q.registry.delete(nick)
632 q.rank_table.each_index { |rank|
633 if nick == q.rank_table[rank][0]
638 q.rank_table.delete_at(player_rank)
640 m.reply "Player #{nick} deleted."
642 m.reply "Player #{nick} isn't even in the database."
647 def cmd_set_score(m, params)
648 q = create_quiz( m.target.to_s )
649 debug q.rank_table.inspect
652 val = params[:score].to_i
653 if q.registry.has_key?(nick)
654 player = q.registry[nick]
657 player = PlayerStats.new( val, 0, 0)
659 q.registry[nick] = player
660 calculate_ranks(m, q, nick)
661 m.reply "Score for player #{nick} set to #{val}."
665 def cmd_set_jokers(m, params)
666 q = create_quiz( m.target.to_s )
669 val = [params[:jokers].to_i, Max_Jokers].min
670 if q.registry.has_key?(nick)
671 player = q.registry[nick]
674 player = PlayerStats.new( 0, val, 0)
676 q.registry[nick] = player
677 m.reply "Jokers for player #{nick} set to #{val}."
683 plugin = QuizPlugin.new
684 plugin.default_auth( 'edit', false )
687 plugin.map 'quiz', :action => 'cmd_quiz'
688 plugin.map 'quiz solve', :action => 'cmd_solve'
689 plugin.map 'quiz hint', :action => 'cmd_hint'
690 plugin.map 'quiz skip', :action => 'cmd_skip'
691 plugin.map 'quiz joker', :action => 'cmd_joker'
692 plugin.map 'quiz score', :action => 'cmd_score'
693 plugin.map 'quiz score :player', :action => 'cmd_score_player'
694 plugin.map 'quiz fetch', :action => 'cmd_fetch'
695 plugin.map 'quiz top5', :action => 'cmd_top5'
696 plugin.map 'quiz top :number', :action => 'cmd_top_number'
697 plugin.map 'quiz stats', :action => 'cmd_stats'
700 plugin.map 'quiz autoask :enable', :action => 'cmd_autoask', :auth_path => 'edit'
701 plugin.map 'quiz transfer :source :dest :score :jokers', :action => 'cmd_transfer', :auth_path => 'edit', :defaults => {:score => '-1', :jokers => '-1'}
702 plugin.map 'quiz deleteplayer :nick', :action => 'cmd_del_player', :auth_path => 'edit'
703 plugin.map 'quiz setscore :nick :score', :action => 'cmd_set_score', :auth_path => 'edit'
704 plugin.map 'quiz setjokers :nick :jokers', :action => 'cmd_set_jokers', :auth_path => 'edit'