===================================
mIRC Stats (mStats) v0.00000000001
===================================

This is a basic documentation of how to install, configure, and operate mStats.
Very little time was spent on this doc, so experimentation on the script will 
probley help more than this ever will.


--- INSTALLATION ---
Unzip the mstats.zip file in your mIRC directory.
It should appear in a directory something like: C:\path\to\mirc\mstats\
in mIRC, type: /load -rs "C:\path\to\mirc\mstats"
Replace the C:\path\to\mirc\mstats with the directory to the mstats.mrc file

--- CONFIGURATION ---
To configure the main ini file, type: /mstats.ini general.ini
This will open the INI file in notepad (assuming the INI is in the same directory as the script)
Edit this file to your liking, there should be different descriptions for each value

Next, you need to open the stats.html file (located in the dir where mstats.mrc is) 
and configure the layout to your liking.  To import values in your html code, use 
the value chart below.

--- mStats HTML VALUE CHART ---
%chantitle% - Title of chatroom
%ops% - Total number of OPs given on the channel
%voices% - Total number of Voices given on the channel
%bans% - Total number of bans ever set on the channel
%kicks% - Total number of kicks on the channel
%joins% - Total number of joins to date
%topic% - Current topic
%users% - Current amount of online users
%modes% - Current channel modes set
More to come...

Now, each of these values can be used in your stats.html file.  Here is an example:
<html>
<title>%topic%</title>
There are currently %users% on the chatroom
</html>

--- GETTING STARTED ---
From the moment you load and configure mStats, it's launched in the background 
and recording channel stats (when you're actually in the channel).  Stats are 
recorded into INI files, and can be displayed through the HTTPd server you can 
start.

--- USING mStats HTTPd ---
This HTTPd server is VERY limited, and can do one basic thing:  Display the stats.html 
file.  No matter what file you request, the stats.html file will always be displayed.
For example, all of the following will display stats.html:
http://localhost:port/
http://localhost:port/blahblah.html
http://localhost:port/mstats/ownz/j00
Anything basicly will display stats.html (told ya it was limited).
Also, the HTTPd Server uses while events to send to sockets, and can be very 
slow sometimes.  Therefore, this server was not made to handle a bunch of 
requests.  I advise against using the HTTPd server if you plan on getting more 
than 10 to 20 requests a minute for it (or else your mIRC will be quite laggy).

--- BASIC mStats COMMANDS ---
/mstats.start [port] - Starts HTTPd Server (default port is 1337)
/mstats.stop - Stops HTTPd Server
/mstats.ini <ini file> - Runs the specified INI file from mStats directory
Identifiers:
$mstats.stats - Status of HTTPd Server.  Returns "active" or "disabled"
$mstats.ini(file,section,item) - Reads from specified INI in mStats directory

--- IN THE FUTURE ---
This version of mStats took me about an hour to code most of the basics, therefore 
it is seriously lacking in features, but does its job.  This is what to expect in future:
- Faster HTTPd server (not relying on while events)
- Multiple channel support
- More recording of users actions (activity, speech, etc..)
- Improvements in layout
- Better documentation
- Possible SockBot background base system (probabley not.. too time consuming)

--- KNOWN BUGS ---
None

--- CREDITS & CONTACT ---
Scripting:
 Teenman - webmaster@divinehost.net
Stats.html Layout:
 Pamela - http://complex.divinehost.net
Inspiration:
 Inspired by psig stats system.  Psig is for unix-based systems, and I wanted 
 something for mIRC.  Psig is still alot more powerful and neater than mStats, 
 so if you want to check it out: http://pisg.sourceforge.net/