INSTALL
-------

You might need some experience with eggdrop to install the bot, but it
should not be too much ;)  If you experience any trouble feel free to
email me (moxon@meta-x.de).  And yes, my english is really bad :(


0. PREPARE an eggdrop

   Get and install a copy of eggdrop.  Read it's readmes to get
   familiar with it it you aren't.  Maybe you wish to increase NICKMAX
   in eggdrop.h if you compile yourself, such that users joining with
   nicks longer than the standard length of 9 will be recognized by
   the bot.  Depends on the net you wish to place the bot in.

   MoxQuizz was developed with version 1.4.3 and is known to work with
   1.4.4, 1.5.x and 1.6.x.  The shipped moxquizz.conf refers to 1.6.x.
   Take moxquizz.conf-1.4.x if you have an earlier version of eggdrop
   installed.

   NOTE: If you experience strange extra characters (e.g. in the
         tips), this is due to the unicode support in TCL.  Upgrade to
         at least eggdrop version 1.6.2 to get rid of them


1. PREPARE yourself

   Read the README.


2. Make sure you are PREPARED

   Give your best to understand the README.


3. UNPACK the distribution

   Just unpack MoxQuizz into a directory containing eggdrop.  There
   should then be a subdirectory called "moxquizz-...." and a link
   "moxquizz", containing all relevant files.


4. CONFIGURATION of MoxQuizz

   Adjust certain variables to your needs.  You can let
   supplemental/setup.pl do this for you if you have perl installed.
   Start it from the quiz directory (perl ./supplemental/setup.pl) and
   supply apropriate values to its questions!  Make sure to create a
   directory named tmp in your eggdrop directory.  If you have perl,
   you can skip to the next two IFs.

   IF you don't like setup.sh, adjust the included moxquizz.conf to
   suit your needs and place it in the eggdrop directory (the one
   above "moxquizz").  Change at least IRC server, channel bot admin
   and bot owner.

   IF you don't like even that and love configuring eggdrop by
   yourself, make sure to include at least the following lines in your
   .conf file:

        source moxquizz/moxfun.fcl
        source moxquizz/moxquizz.tcl

   THEN you have to EDIT moxquizz.tcl.  There is a single variable you
   want to change (but you have read README, so you already know
   which):

        $quizchannel   

   IF you registered your bot with a nickserv, adjust $nickservpass,
   $nickservtext and $nickservmask in moxtools.tcl (look for "nickserv
   identification").  Make sure moxtools.tcl is loaded from your
   egdrop config file (source it alike moxfun.tcl above).  If not,
   forget about moxtools.


5. INITIALIZE the eggdrop user records

   Start with

        ./moxquizz.conf -m
   or
        eggdrop moxquizz.conf -m

   and identify yourself to the bot to become the master.


6. Restart without -m and give you at least the flags P and Q to be
   able to control the bot.

   To do this, you have to log into the partyline of the bot.  First
   set a password by:

        /msg <botnick> pass <your password>

   Then initiate a DCC CHAT with you bot and log in (either "/dcc chat
   <botnick>" or "/CTCP <botnick> CHAT".

   Inside the bot say:

	.chattr <yourhandle> +PQ

   to get the flags.

7. Optionally tell the bot to initialize (should be ok without) and
   print some text by saying inside the bot:

   .!init

   This might take a while, since eggdrop might need to set its
   message queues up.  Afterwards say !ask in the channel to start the
   quiz.

8. Enjoy!
