Eggdrop Tcl Archive

Extended Description File

#####################################################################
#                                                                   #
# "Trivia 2000" Version 2.3 ©Ian-Highlander 2000-2007               #
#            (ian.highlander@eggdropsrus.co.uk)                     #
# A Trivial Pursuit style game with seven queston categories        #
# available to choose from by public command, automatic host adding #
# for tracking users scores, top ten scores command, multi question #
# rounds, switchable answers, question number announcements and     #
# much more.                                                        #
#                                                                   #
# This script started life as a fun hobby for a chat room I was in  #
# many years ago and has become incredibly popular, after a break   #
# from the world of IRC I thought it was time I started the long    #
# promised updates.  To say the popularity of this script was a     #
# surprise to me is an understatement, even with no updates in four #
# years it was still the seventh most popular script downloaded     #
# from egghelp.org's archives. The 1.3 update was downloaded nearly #
# 500 times in a week which is gob-smacking to say the least. I am  #
# constantly emailed by people asking for updates and information   #
# which humbles me beyond words. Thanks for the support to everyone #
# out there who uses my little scripts. I apologise for the length  #
# of this script header but there's so much to say :o)              #
# ----------------------------------------------------------------- #
#                                                                   #
#    IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT IMPORTANT    #
#    ===========================================================    #
# Due to major changes in the code of Trivia 2000 from version 2.2  #
# onwards, this script will now only run on Eggdrop version 1.6.17  #
# or higher due to new commands implented in that version that are  #
# used in Trivia 2000's code.                                       #
#                                                                   #
# Even if you don't read all of this header message, please make    #
# sure you read all the comments in the configuration section of    #
# the script at the top. I have tried to make these as easy to      #
# follow as possible, if you have genuine problems please contact   #
# me, but 95% of "faults" are due to users not actually reading the #
# instructions on how to configure the script properly or use it.   #
#                                                                   #
# ----------------------------------------------------------------- #
# Trivia 2000 would not exist as it is now without the help of      #
# the people below, so thanks to them.                              #
#                                                                   #
# Brian (^^Highlander^^) for his hard work helping me on the        #
# randomisation code. It's actually very clever and tracks all      #
# questions used within a category so it wont repeat a question     #
# until it's used them all from that category unless you change     #
# categories at which point all counters are reset which does       #
# result in repeats if you switch back to the previous one.         #
#                                                                   #
# Stdragon/stdarg who helped write and test the user host adding    #
# code which adds users to your bots userlist when they get a       #
# question right and then tracks them by nickname and hostmask      #
# adding new hostmasks as needed automatically. It wont however add #
# hostmasks to anyone who has any flags on their username in the    #
# bots userlist thus avoiding spamming to gain access to the room.  #
#                                                                   #
# The amazing TCL guru's over at egghelp.org's forums who have      #
# helped me regain my very rusty TCL knowledge and without whose    #
# help, many of the new features just wouldnt work. Especially      #
# Sir_Fz.                                                           #
#                                                                   #
# Thanks to the guys and gals over at the official Queen Online     #
# chat room and forums for putting up with me and helping me test   #
# it thoroughly, nothing tests this script better than a load of    #
# mad Queen fans in a Queen quiz in a Queen chat room, you guys     #
# rock!! :o)                                                        #
#                                                                   #
# The scores section is adapted from Wordgame.tcl v1.0 by "Murf"    #
# which was my original inspiration to write this script, a very    #
# clever little word game that formed the base for the original     #
# beta versions of Trivia 2000 before it grew into what it is today.#
#                                                                   #
# The new style hints are adapted from code written by Tomas        #
# Creemers and emailed to me as an idea it was something I was      #
# trying to do anyway, but Tomas suggested much cleaner code for it #
# which is a lot nicer than anything I'd come up with, I adapted    #
# this to give the multi option hints.                              #
#                                                                   #
# My partner Kerry (The_Vixen) who not only puts up with me being   #
# on a PC 24/7 but also helped choose and test the hideous colours  #
# in the new colour scheme.                                         #
# ----------------------------------------------------------------- #
# - A trivia game script that asks trivia questions to the room     #
#     and tracks users scores.                                      #
# - With seven different question categories built in and           #
#     question files provided.                                      #
# - Single or multiple question rounds.                             #
# - Switchable answer giving by public command for questions        #
#     where no one got the answer.                                  #
# - Switchable announcing of how many questions are left at the     #
#     beginning of each question.                                   #
# - Switchable hints (2 types) which give the first few letters     #
#     of the answer over a period of time.                          #
# - Designed for people wanting something other than the            #
#     standard word game i or trivia scripts.                       #
# ----------------------------------------------------------------- #
# I take no responsibility if this script causes any problems       #
# for you or your bot.                                              #
# Originally designed on Eggdrop 1.3.23 and tested up to            #
# Eggdrop 1.6.17 up to Trivia 2000 v2.1                             #
#                                                                   #
#            ****IMPORTANT NOTE AS FROM VERSION 2.2****             #
#  ****THIS SCRIPT WILL ONLY WORK ON EGGDROP 1.6.17 OR HIGHER!****  #
# This script is provided completely free of charge.                #
# Feel free to amend or improve this script, but if you make        #
# improvements,  please send me a copy :o)                          #
# All I ask is that this message, the copyright message in the      #
# script and the "Loaded" message at the end of the script          #
# are not changed.                                                  #
# ----------------------------------------------------------------- #
# If You would like to receive updates as and when they are         #
# available, please email me.                                       #
# Updates will also be posted on my website:                        #
#           http://www.eggdropsrus.co.uk                            #
# ----------------------------------------------------------------- #
# New in Version 2.3                                                #
# - Fancy coloured ASCII fireworks added to the action when user    #
#     hits max score.                                               #
# - New variable added to user config section "maxscorereset"       #
#     which allows setting of the max score users can reach before  #
#     fireworks are set off and all scores are reset to zero.       #
# - New style hints added giving empty dashes per character in      #
#     the answer to give a better hint.                             #
# - New variable added to user config section "hintsys" which       #
#     allows choosing of old or new hints.                          #
# - Delay added between questions in multiple question rounds,      #
#     delay time can be adjusted in seconds in the configuration    #
#     section. Delay and delay announcement can be disabled by      #
#     setting to zero.                                              #
# - The !choose command will now accept a second part and skip      #
#     the selection of categories completely,                       #
#     i.e. !choose will bring up the choice of categories as        #
#          normal and then users have to choose by typing the       #
#          category in as normal,                                   #
#     OR:  !choose geography for example will automatically set     #
#          it to Geography and put the game in start mode without   #
#          having to display the choices or wait for one.           #
#                                                                   #
# Bug Fix: Corrected an issue where the bot wouldn't respond to     #
#     room hosts using the !stop or !game on/off commands.          #
#     Thanks to Thomas Creemers for reporting this.                 #
# ----------------------------------------------------------------- #
# New in Version 2.2                                                #
# - Completely recoded large sections of the script in order to     #
#     make the bot respond to coloured text.  Previously if you     #
#     weren't using black text it just ignored you.                 #
#     Now works fine with all colours.                              #
#   IMPORTANT: This new code will ONLY work on Eggdrop 1.6.17 or    #
#     higher making this a requirement for Trivia 2000 to work now. #
#     New code added to give error message and switch script off    #
#     if older bot version is in use.                               #
#                                                                   #
# Bug Fix: Changed a duplicate variable in the !hints command that  #
#     was causing it to switch off hints completely under certain   #
#     circumstances. Now works correctly throughout the game.       #
# Bug Fix: Changed a procedure name and recoded slightly to remove  #
#     a conflict with wordgame by Murf if both games where loaded   #
#     the timers on one or the other werent killed properly.        #
#     (thanks Roger)                                                #
# ----------------------------------------------------------------- #
# New in Version 2.1                                                #
# - User definable colours added with a choice of two templates     #
#     supplied in the script - new multi coloured or original       #
#     Trivia 2000 style. Instructions added for users to            #
#     customise the new one.                                        #
# - Hints function added, the script will automatically give the    #
#     first character of the answer, the first two characters of    #
#     the answer and the first three characters of the answer at    #
#     set intervals. If there are only two characters in the answer #
#     it will only give the first clue and if there are only three  #
#     characters in the answer it will only give the first 2 hints. #
# - New command !hints on/off added to be able to switch the        #
#     hints function on or off as required.                         #
# - Added timer variables to set how long each hint takes to        #
#     come up and maximum question time length.                     #
# - General code clean up.                                          #
#                                                                   #
# Bug Fix: Bot no longer accepts correct answers in non-game rooms. #
#     (I hadn't noticed it did it).                                 #
# ----------------------------------------------------------------- #
# New in Version 2.0.5.beta                                         #
# - Multi word answers can now be used in the question files and    #
#     are accepted correctly by the bot.                            #
# - !start command enhanced to accept the number of questions       #
#     required in this round, maximum number to allow is            #
#     configured at the top of the script (default 25).             #
#     The new command format is !start **                           #
#     i.e !start 10 will start a ten question round.                #
#     The !start command still works the same as always.            #
# - New option to announce the number of questions left in the      #
#     round before each question by default.                        #
# - New public command !announce on/off to switch on or off the     #
#     above function.                                               #
# - New option to display the answers if nobody gets the question   #
#     right after each question.                                    #
# - New public command !answers on/off to switch on or off the      #
#     above function.                                               #
# - New function that notifies users when the round has finished.   #
#                                                                   #
# Bug Fix: !stop command now stops the game timers correctly and    #
#     the game wont respond to a correct answer after the !stop     #
#     command is issued.                                            #
#     (I hadn't realised it was even doing it before).              #
# Bug Fix: !game off command now cant be used while a round is      #
#     in progress, !stop command must be issued first to stop       #
#     the game as it also wasnt stopping the timers correctly.      #
# ----------------------------------------------------------------- #
# New in Version 1.3                                                #
# - Slight cock up on the !score command which was only reading the #
#     top ten scores in the file and sorting those into order,      #
#     it's now reading them all and sorting correctly the top ten.  #
#     Basically I recoded something wrong when I adapted it from    #
#     Wordgame.tcl, put my error right and its ok now.              #
# ----------------------------------------------------------------- #
# New in Version 1.2.5                                              #
# - Modification made so that the bot now gives your daily AND      #
#     total scores so far when you get a question correct allowing  #
#     users to track their own scores if not in the top ten.        #
# - Trivia version variable added for easier use and tracking       #
#     during future "enhancements".                                 #
# ----------------------------------------------------------------- #
# New in Version 1.2                                                #
# - !score command now works and shows the top ten scorers          #
#     "Overall" and "Today" scores.                                 #
#                                                                   #
# Bug Fix: Any answers which are numbers now work correctly         #
#     instead of taking the first digit as a colour code and        #
#     displaying it with the first digit missing it now works       #
#     as it should.                                                 #
# ----------------------------------------------------------------- #
# New in Version 1.1                                                #
# - !trivia command bound to same list of commands available as     #
#     !help command, too many people using !trivia because other    #
#     scripts use this command :o), this needed to be explained     #
#     to users easily.                                              #
# - Bot can now be in multiple rooms, game can only be playing in   #
#     one, set this in $gamechan variable.  Anyone trying to use    #
#     game commands in any room other than game room will be        #
#     directed to the correct room.                                 #
# - Bot now adds new players automatically, and keeps score for     #
#     them from first correct answer.                               #
# - Re-wrote half of the score keeping section ready for the        #
#     !score command to be implemented.                             #
#                                                                   #
#####################################################################