[Best viewed with Courier New font.]

    ._______.
   |Veebers|------------------
   -`  _       _       _           _    
    ||      (_)     (_)     | |         | |   -
   - | |_ _ __ ___   ___  __ _| |__   ___ | |_  
    | __| '__| \ \ / / |/ _` | '_ \ / _ \| __| -
   - | |_| |  | |\ V /| | (_| | |_) | (_) | |_  
     \__|_|  |_| \_/ |_|\__,_|_.__/ \___/ \__| -
   -                                   ._______.
   ------------------|ver 1.5|-   
                                       `

====================================================
= ::Bug Fixes::                                    =
====================================================

Version 1.4.1
    + Optimised code.


====================================================
= ::New Features::                                 =
====================================================

Version 1.4
    + Message editor for custom messages.
    + Support for more than one set of questions.
    + More options in the Bot Settings.
    + Added user access levels.
    + New commands: !whois, !kick, and !ban.
    + Award for reaching a certain number of points
        or for answering a certain number of
        questions right in a row.

Version 1.3
    + !score [user] can be used to check other
        people's scores.
    + Custom messages.

Version 1.2
    + Automatically generates hints.
    + !score command.

Version 1.1
    + Custom trigger.
    + !say command.
    + !join command.



====================================================
= ::Bot Commands::                                 =
====================================================

Users who have access to these commands may use
them. Such users are listed in "commands.ini". The
owner of the bot doesn't need to give himself access
in "commands.ini".

The bot commands are:
    !score - Displays your score.
    !score [user] - Displays a user's score.
    !start [set] - Start the trivia session with the
      specified question set. The sets are stored in
      the "\questions\" directory.
      (Ex: "!start trivia" would start the trivia
      with questions in "\questions\trivia.dat".)
    !stop - Stop the trivia session.
    !join [channel] - Joins a channel.
    !kick [user] - Kicks the user.
    !ban [user] - Ignores the user's messages so
      he/she cannot answer the questions. This also
      may ban the user out of the channel if the
      bot acquires ops.
    !say [message] - Make the bot say something.



====================================================
= ::The INI Files::                                =
====================================================

::Awards.INI::::....

[Score]
(number of points)=(award)

  (number of points) is the score required to earn
  whatever award is specified in (award).

  Example:
  "20=a used condom" will give "a used condom" to a
  person when he/she scores 20 points.


[Row]
(number of rows)=(award)

  Similar to the [Score] section, (number of rows)
  is the number of questions answered in a row by a
  user. The user will get the (award) when he/she
  gets (number of rows) questions in a row.

  Example:
  "3=a bag of weed" will give "a bag of weed" to a
  person when he/she gets 3 subsequent questions
  correctly in a single row.


::Commands.INI::::....

[Commands]
score=(access required)
whois=(access required)
start=(access required)
stop=(access required)
join=(access required)
kick=(access required)
ban=(access required)
say=(access required)

  You'll notice that there are bot commands listed
  here. The (access required) is the amount of user
  access is required to use that command. If a user
  doesn't have enough access to use a command, he/
  she cannot use it.

  Example:
  "ban=5" means that a user with an access of 5 or
  more can use the !ban command, while users with
  access below 5 cannot.


[UserAccess]
(username)=(access)

  This section handles user access. (username) is
  the username, and (access) is the access level for
  the person specified in (username).

  Example:
  "Vanguard[T]=5" gives "Vanguard[T]" an access of
  5. He can use commands that require 5 or less
  access to use.


::Config.INI::::....

Note: Config.INI doesn't need to be edited using
notepad. You can just open the bot and go select
"Bot Settings" under the menu.

[BotSettings]
Owner=(Owner of the bot)
Username=(Username of the bot)
Password=(Password for the Username)
CDKey=(CD-Key for whatever product you're using)
HomeChannel=(Channel to join on connection)
Server=(battle.net server to connect to)
Trigger=(1-character only; the bot trigger)
HintDelay=(Delay in between hints in ms)
QuestionDelay=(Delay in between questions in ms)
Client=(The product to connect with)

  The "CDKey" should always agree with the "Client".


[Strings]
(action)=(message)

  The (action) is the bot action and the (message)
  is the message displayed when the bot executes
  the (action). All the actions are listed in
  "Config.INI" by default.


::Userscores.INI::::....

[Userscores]
(username)=(score)

  This section is pretty self-explanitory. The
  (username) is the username of a person who
  has a (score) amount of points. The (score)
  will increase for every question answered
  correctly.



====================================================
= ::Editing Questions::                            =
====================================================

All the questions are located in the "/questions/"
directory. All your custom questions should be
placed in there. To make custom questions, you need
to follow the same format the other question files
have. Here's a "base" of a question file.

  [Questions]
  Questions=(number of questions)
  UserHints=(yes to use hints, no to not)

  Question1=(question for question 1)
  Answer1=(answer to question 1)

"Questions" is how many questions there are total.
If you set "UserHints" to yes, the bot will display
hints. If it is set to no, the bot will not display
any hints. "Question1" is the first question.
"Answer1" is the answer to its corresponding
question, which is set in "Question1". The next
question will be defined as "Question2", and its
answer, likewise, will be defined as "Answer2". The
questions after that will have the number increment
each time.

After you make your question file, you must save it
with the file extension, ".dat". You must save it
in the "/questions/" directory.

