XPTB Lite 0.2.4 by Craciun Dan - http://www.tuxarena.com/intro/xptb.php
=======================================================================


INSTALLATION
------------
Make sure you have Perl and the Net::IRC Perl module installed.
For example, on a Debian system this should be done as root like:

apt-get install perl libnet-irc-perl

In Ubuntu or Mint:

sudo apt-get install libnet-irc-perl

The package libnet-irc-perl should have a similar name in other
distributions too.

RUNNING XPTB LITE
-----------------
The script is already executable, so to run it just type:

./xptblite.pl SERVER PORT NICK CHANNEL

Notice that the SERVER, PORT, NICK and CHANNEL parameters are
optional. You can run XPTB Lite only as:

./xptblite.pl

In this case the script will automatically read the
xptblite.cfg file (which should be placed in the same directory
as xptblite.pl) and it will get its parameters from there. By
default, the file xptblite.cfg has the following content in it:

server=localhost
port=6667
nick=xptb_lite
ircname=eXtended Perl Trivia Bot [Lite] - http://www.tuxarena.com/intro/xptb.php
username=xptb
channel=#embryo

You can change all of these in a text editor. For example, to
run the bot in channel #trivia-players on Freenode, you would
edit it like this:

server=irc.freenode.org
port=6667
nick=xptb_lite
ircname=eXtended Perl Trivia Bot [Lite] - http://www.tuxarena.com/intro/xptb.php
username=xptb
channel=#trivia-players

So basically, run XPTB Lite with parameters specified at the
command line, or edit the configuration file and run it as:

./xptblite

See the configuration chapter below too.

CONFIGURATION
-------------
You can configure the trivia bot by manually editing by hand the
xptblite.cfg file. You will get to choose the server to connect
to, the nick to use and so on. DO NOT use comments or alter in
any other way the configuration file, since currently I didn't
implement any way of verifying its integrity.

You can also run xptblite.pl with arguments provided at the
command line:

	./xptblite.pl SERVER PORT NICK CHANNEL

E.g.
	./xptblite.pl irc.oftc.net 6667 TriviaBot #trivia4linux

OTHER NOTES
-----------
- make sure the questions.txt and the xptblite.cfg files are in
the same directory with the script, xptblite.pl
- the questions.txt file currently only has a few questions, but
you can add as many as you like
- you can add your own questions in the questions.txt file using
the form:

	QUESTION GOES HERE|ANSWER

Just separate the question from the answer using the '|' sign. Make
sure you don't put more than one | sign on a single line.

NOTICE
------
This is still alpha software, and it *is* buggy. However it does
what it is supposed to do, except for a few minor annoyances.

TODO list
---------
- implement a basic stats system (top points, time, cps)
- commands like !Ping, !Top, !Top CPS etc
- add hints
- detailed help/faq files

FILES
-----
xptblite.pl - Trivi Lite 0.2.3
questions.txt - Questions file version 0.2
xptblite.cfg - Configuration file for Trivi Lite
README - Help on running and configuring Trivi Lite
COPYING - License information (Trivi Lite uses GPLv3)
CHANGELOG - Trivi Lite changelog

CONTACT
-------
Please contact me regarding any bugs, feature requests, patches etc at
the following email address:

	floydian.embryo@yahoo.com

You can also use the forum or the bug tracker at the SourceForge.net
project page:

	https://sourceforge.net/projects/xptb/

Visit the homepage for latest releases and news:

	http://www.tuxarena.com/intro/xptb.php

Have a look at the online documentation:

	http://xptb.sourceforge.net/docs.html
