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.
203 # This table contains all players sorted by rank.
205 def calculate_ranks( m, q, nick )
206 if q.registry.has_key?( nick )
207 stats = q.registry[nick]
209 # Find player in table
212 q.rank_table.each_index do |i|
213 if nick == q.rank_table[i][0]
219 # Remove player from old position
222 q.rank_table.delete_at( i )
227 # Insert player at new position
229 q.rank_table.each_index do |i|
230 if stats.score > q.rank_table[i][1].score
231 q.rank_table[i,0] = [[nick, stats]]
237 # If less than all other players' scores, append to table
239 i += 1 unless q.rank_table.empty?
240 q.rank_table << [nick, stats]
243 # Print congratulations/condolences if the player's rank has changed
246 m.reply "#{nick} ascends to rank #{i + 1}. Congratulations :)"
248 m.reply "#{nick} slides down to rank #{i + 1}. So Sorry! NOT. :p"
252 q.rank_table << [[nick, PlayerStats.new( 1 )]]
257 # Reimplemented from Plugin
260 return unless @quizzes.has_key?( m.target.to_s )
261 q = @quizzes[m.target.to_s]
263 return if q.question == nil
265 message = m.message.downcase.strip
267 if message == q.answer.downcase or message == q.answer_core.downcase
271 reply = "WHOPEEE! #{m.sourcenick.to_s} got it on the first try! That's worth an extra point. Answer was: #{q.answer}"
272 elsif q.rank_table.length >= 1 and m.sourcenick.to_s == q.rank_table[0][0]
273 reply = "THE QUIZ CHAMPION defends his throne! Seems like #{m.sourcenick.to_s} is invicible! Answer was: #{q.answer}"
274 elsif q.rank_table.length >= 2 and m.sourcenick.to_s == q.rank_table[1][0]
275 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}"
276 elsif q.rank_table.length >= 3 and m.sourcenick.to_s == q.rank_table[2][0]
277 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}"
279 reply = @win_messages[rand( @win_messages.length )].dup
280 reply.gsub!( "<who>", m.sourcenick )
281 reply.gsub!( "<answer>", q.answer )
287 if q.registry.has_key?( m.sourcenick.to_s )
288 player = q.registry[m.sourcenick.to_s]
290 player = PlayerStats.new( 0, 0, 0 )
293 player.score = player.score + points
295 # Reward player with a joker every X points
296 if player.score % 15 == 0 and player.jokers < Max_Jokers
298 m.reply "#{m.sourcenick.to_s} gains a new joker. Rejoice :)"
301 q.registry[m.sourcenick.to_s] = player
302 calculate_ranks( m, q, m.sourcenick.to_s )
305 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
307 # First try is used, and it wasn't the answer.
313 # Stretches an IRC nick with dots, simply to make the client not trigger a hilight,
314 # which is annoying for those not watching. Example: markey -> m.a.r.k.e.y
316 def unhilight_nick( nick )
319 0.upto( nick.length - 1 ) do |i|
320 new_nick += nick[i, 1]
321 new_nick += "." unless i == nick.length - 1
328 #######################################################################
330 #######################################################################
331 def cmd_quiz( m, params )
332 fetch_data( m ) if @questions.empty?
333 q = create_quiz( m.target.to_s )
336 m.reply "#{Bold}#{Color}03Current question: #{Color}#{Bold}#{q.question}"
337 m.reply "Hint: #{q.hint}" if q.hinted
341 # Fill per-channel questions buffer
342 if q.questions.empty?
343 temp = @questions.dup
346 i = rand( temp.length )
347 q.questions << temp[i]
352 i = rand( q.questions.length )
353 q.question = q.questions[i].question
354 q.answer = q.questions[i].answer.gsub( "#", "" )
357 q.answer_core = /(#)(.*)(#)/.match( q.questions[i].answer )[2]
361 q.answer_core = q.answer.dup if q.answer_core == nil
363 # Check if core answer is numerical and tell the players so, if that's the case
364 # The rather obscure statement is needed because to_i and to_f returns 99(.0) for "99 red balloons", and 0 for "balloon"
365 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
367 q.questions.delete_at( i )
372 (0..q.answer_core.length-1).each do |index|
373 if is_sep(q.answer_core[index,1])
374 q.hint << q.answer_core[index]
381 # Generate array of unique random range
382 q.hintrange = (0..q.answer_core.length-1).sort_by{rand}
384 m.reply "#{Bold}#{Color}03Question: #{Color}#{Bold}" + q.question
388 def cmd_solve( m, params )
389 return unless @quizzes.has_key?( m.target.to_s )
390 q = @quizzes[m.target.to_s]
392 m.reply "The correct answer was: #{q.answer}"
396 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
400 def cmd_hint( m, params )
401 return unless @quizzes.has_key?( m.target.to_s )
402 q = @quizzes[m.target.to_s]
405 m.reply "#{m.sourcenick.to_s}: Get a question first!"
407 num_chars = case q.hintrange.length # Number of characters to reveal
419 index = q.hintrange.pop
420 # New hint char until the char isn't a "separator" (space etc.)
421 end while is_sep(q.answer_core[index,1])
422 q.hint[index] = q.answer_core[index]
424 m.reply "Hint: #{q.hint}"
427 if q.hint == q.answer_core
428 m.reply "#{Bold}#{Color}04BUST!#{Color}#{Bold} This round is over. #{Color}04Minus one point for #{m.sourcenick.to_s}#{Color}."
431 if q.registry.has_key?( m.sourcenick.to_s )
432 stats = q.registry[m.sourcenick.to_s]
434 stats = PlayerStats.new( 0, 0, 0 )
437 stats["score"] = stats.score - 1
438 q.registry[m.sourcenick.to_s] = stats
440 calculate_ranks( m, q, m.sourcenick.to_s )
443 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
449 def cmd_skip( m, params )
450 return unless @quizzes.has_key?( m.target.to_s )
451 q = @quizzes[m.target.to_s]
454 cmd_quiz( m, params )
458 def cmd_joker( m, params )
459 q = create_quiz( m.target.to_s )
462 m.reply "#{m.sourcenick.to_s}: There is no open question."
466 if q.registry[m.sourcenick.to_s].jokers > 0
467 player = q.registry[m.sourcenick.to_s]
470 q.registry[m.sourcenick.to_s] = player
472 calculate_ranks( m, q, m.sourcenick.to_s )
474 if player.jokers != 1
479 m.reply "#{Bold}#{Color}12JOKER!#{Color}#{Bold} #{m.sourcenick.to_s} draws a joker and wins this round. You have #{player.jokers} #{jokers} left."
480 m.reply "The answer was: #{q.answer}."
483 cmd_quiz( m, nil ) if q.registry_conf["autoask"]
485 m.reply "#{m.sourcenick.to_s}: You don't have any jokers left ;("
490 def cmd_fetch( m, params )
495 def cmd_top5( m, params )
496 q = create_quiz( m.target.to_s )
497 if q.rank_table.empty?
498 m.reply "There are no scores known yet!"
502 m.reply "* Top 5 Players for #{m.target.to_s}:"
504 [5, q.rank_table.length].min.times do |i|
505 player = q.rank_table[i]
507 score = player[1].score
508 m.reply " #{i + 1}. #{unhilight_nick( nick )} (#{score})"
513 def cmd_top_number( m, params )
514 num = params[:number].to_i
515 return unless 1..50 === num
516 q = create_quiz( m.target.to_s )
517 if q.rank_table.empty?
518 m.reply "There are no scores known yet!"
523 m.reply "* Top #{num} Players for #{m.target.to_s}:"
524 n = [ num, q.rank_table.length ].min
526 player = q.rank_table[i]
528 score = player[1].score
529 ar << "#{i + 1}. #{unhilight_nick( nick )} (#{score})"
531 m.reply ar.join(" | ")
535 def cmd_stats( m, params )
536 fetch_data( m ) if @questions.empty?
538 m.reply "* Total Number of Questions:"
539 m.reply " #{@questions.length}"
543 def cmd_score( m, params )
544 say_score( m, m.sourcenick.to_s )
548 def cmd_score_player( m, params )
549 say_score( m, params[:player] )
553 def cmd_autoask( m, params )
554 q = create_quiz( m.target.to_s )
556 if params[:enable].downcase == "on"
557 q.registry_conf["autoask"] = true
558 m.reply "Enabled autoask mode."
559 cmd_quiz( m, nil ) if q.question == nil
560 elsif params[:enable].downcase == "off"
561 q.registry_conf["autoask"] = false
562 m.reply "Disabled autoask mode."
564 m.reply "Invalid autoask parameter. Use 'on' or 'off'."
569 def cmd_transfer( m, params )
570 q = create_quiz( m.target.to_s )
572 debug q.rank_table.inspect
574 source = params[:source]
576 transscore = params[:score].to_i
577 transjokers = params[:jokers].to_i
578 debug "Transferring #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
580 if q.registry.has_key?(source)
581 sourceplayer = q.registry[source]
582 score = sourceplayer.score
586 if score < transscore
587 m.reply "#{source} only has #{score} points!"
590 jokers = sourceplayer.jokers
594 if jokers < transjokers
595 m.reply "#{source} only has #{jokers} jokers!!"
598 if q.registry.has_key?(dest)
599 destplayer = q.registry[dest]
601 destplayer = PlayerStats.new(0,0,0)
604 sourceplayer.score -= transscore
605 destplayer.score += transscore
606 sourceplayer.jokers -= transjokers
607 destplayer.jokers += transjokers
609 q.registry[source] = sourceplayer
610 calculate_ranks(m, q, source)
612 q.registry[dest] = destplayer
613 calculate_ranks(m, q, dest)
615 m.reply "Transferred #{transscore} points and #{transjokers} jokers from #{source} to #{dest}"
617 m.reply "#{source} doesn't have any points!"
622 def cmd_del_player( m, params )
623 q = create_quiz( m.target.to_s )
624 debug q.rank_table.inspect
627 if q.registry.has_key?(nick)
628 player = q.registry[nick]
631 m.reply "Can't delete player #{nick} with score #{score}."
634 jokers = player.jokers
636 m.reply "Can't delete player #{nick} with #{jokers} jokers."
639 q.registry.delete(nick)
642 q.rank_table.each_index { |rank|
643 if nick == q.rank_table[rank][0]
648 q.rank_table.delete_at(player_rank)
650 m.reply "Player #{nick} deleted."
652 m.reply "Player #{nick} isn't even in the database."
657 def cmd_set_score(m, params)
658 q = create_quiz( m.target.to_s )
659 debug q.rank_table.inspect
662 val = params[:score].to_i
663 if q.registry.has_key?(nick)
664 player = q.registry[nick]
667 player = PlayerStats.new( val, 0, 0)
669 q.registry[nick] = player
670 calculate_ranks(m, q, nick)
671 m.reply "Score for player #{nick} set to #{val}."
675 def cmd_set_jokers(m, params)
676 q = create_quiz( m.target.to_s )
679 val = [params[:jokers].to_i, Max_Jokers].min
680 if q.registry.has_key?(nick)
681 player = q.registry[nick]
684 player = PlayerStats.new( 0, val, 0)
686 q.registry[nick] = player
687 m.reply "Jokers for player #{nick} set to #{val}."
693 plugin = QuizPlugin.new
694 plugin.default_auth( 'edit', false )
697 plugin.map 'quiz', :action => 'cmd_quiz'
698 plugin.map 'quiz solve', :action => 'cmd_solve'
699 plugin.map 'quiz hint', :action => 'cmd_hint'
700 plugin.map 'quiz skip', :action => 'cmd_skip'
701 plugin.map 'quiz joker', :action => 'cmd_joker'
702 plugin.map 'quiz score', :action => 'cmd_score'
703 plugin.map 'quiz score :player', :action => 'cmd_score_player'
704 plugin.map 'quiz fetch', :action => 'cmd_fetch'
705 plugin.map 'quiz top5', :action => 'cmd_top5'
706 plugin.map 'quiz top :number', :action => 'cmd_top_number'
707 plugin.map 'quiz stats', :action => 'cmd_stats'
710 plugin.map 'quiz autoask :enable', :action => 'cmd_autoask', :auth_path => 'edit'
711 plugin.map 'quiz transfer :source :dest :score :jokers', :action => 'cmd_transfer', :auth_path => 'edit', :defaults => {:score => '-1', :jokers => '-1'}
712 plugin.map 'quiz deleteplayer :nick', :action => 'cmd_del_player', :auth_path => 'edit'
713 plugin.map 'quiz setscore :nick :score', :action => 'cmd_set_score', :auth_path => 'edit'
714 plugin.map 'quiz setjokers :nick :jokers', :action => 'cmd_set_jokers', :auth_path => 'edit'