------------------------------------------------------------------------- -- mIRCStats v1.22, released 3rd of February 2007 -- -- by Mikko 'Ave' Auvinen -- -- -- -- Email: mircstats (o) nic.fi -- -- (When emailing me, include word 'mircstats' in subject line -- -- to make it pass my spam filter easier.) -- -- -- -- homepage: http://www.mircstats.net/ -- -- or http://www.nic.fi/~mauvinen/mircstats/ -- ------------------------------------------------------------------------- FTP and HTTP-Components are programmed by Francois Piette ( http://www.overbyte.be/frame_index.html ). - mIRCStats occasinally checks for a "New version" message from www.nic.fi web server. This uses HTTP GET method, and doesn't send any information out. If a new mIRCStats version is available, a message window pops up. TPNGImage component used by mIRCStats Pipe Lab was done by Gustavo Daud. ( http://pngdelphi.sourceforge.net/ ) ------------------------------------------------------------------------- mIRCStats is an easy-to-use IRC channel log analyzer, which analyzes IRC channel log-files produced by your IRC-client and creates a nice looking HTML-page consisting of channel activity statistics, user reports, tables about changed channel topics and all kinds of miscellaneous information collected from the log file. All texts in mIRCStats-generated stats pages are fully configurable through language files (located in Language sub-directory). mIRCStats can also read nearly every possible log file format because the log parser can be configured with parser configuration files (located in Parser sub-directory). See file versionhistory.txt for full list of features Some guidelines: ---------------- Getting help: Pressing F1 while running mIRCStats opens the On-line help. Use index and search to find the subject you're looking for. Or visit mIRCStats Forums at http://forum.mircstats.net/ How to configure your mIRC to log your channels: * Make sure you have a mIRC client program (version 5.31 or higher). (download: http://www.mirc.co.uk) * In mIRC Options/IRC/Logging settings page: - Turn on "Automatically log channels" - Check (=turn on) "Strip codes" - Check "Timestamp logs" (Adds timestamp to logs even if you don't use them in channel windows) - Uncheck "Lock log files" (This lets mIRCStats analyze logs while mIRC is active) - Uncheck "Show mode prefix" at Options/Irc page After doing this your mIRC is making .log-files of all channel activities on those channels you are on. How to use mIRCStats with other IRC clients or scripts that modify the logging format: There's hundreds of IRC clients and scripts out there, so it's not possible to give detailed info how you can log your channels. However, every IRC client should have the logging feature so check your IRC client help files for more info about this. If the logging format is not the standard mIRC-format, you need to adjust the mIRCStats log parser to understand that format. This can be done by selecting a proper Parser Configuration File (At "Log parser" settings page in mIRCStats). Parser Configuration Files done by other users can be downloaded from Parser Configuration File download site: http://www.mircstats.net/parser/ If you cannot find a Parser Configuration File that matches your logging format, you can easily create one by yourself. Check Config/mIRC_parser.txt for an example how default parser rules were defined. You can find more info from mIRCStats help file ("Setting options -> Log parser"). Generating your first stats page from your logs. You can generate statistics by running mIRCStats and selecting the log file that you want to analyze. Selection of multiple log files can be done by defining a filter like "c:\logs\mychannel_*.log" . User interface should be easy to understand, but in case you need assistance, press F1 to open the help file where you find information for most problems. Basic information how to publish your stats in the internet: * Stats pages are created by default to /html directory under your mircstats dir. * You can configure the built-in ftp client to upload stats files to your web server (See File Transfer page in mIRCStats, press F1 on that page for help). * or use any ftp client (WS_FTP for example) to upload the generated files (html, css, gif and jpg) to some directory ("stats" for example) at your web server. * Advertise your stats page URL at your irc channel to your friends (e.g. http://www.yourserver.com/~yourname/stats/yourchannel.html) Automating your stats updates: There's several ways to automate mIRCStats. Open the help file -> Inside mIRCStats -> Ways to automate your stats updates mIRCStats accepts following command line parameters: mircstats.exe [-l logfile] [-h htmlfile] [-c configfile] [-req request_name] [ ] means the parameter is optional, you shouldn't write []-characters around parameters. If your filenames or paths include spaces, surround names with "quotes". You can load multiple config files by specifying more "-c configfile" parameters. Always load the most generic config file first, and after those more specific ones. (Like this: -cfg mysettings.cfg -cfg mycustomstats.cust.cfg -cfg chinese.lang.cfg) mIRCStats is a SHAREWARE program If you like to use mIRCStats, please register it. By doing that you also support development of new features, which you can take full advantage of when registered! Take a look at http://www.mircstats.net/register.html or register.txt for further info. Version info See file versionhistory.txt for full list of features Limitations: - Maximum number of days to be analyzed with a single scan...........NO LIMIT - Maximum number of lines per day to be saved to channel history...... 262140 - Maximum number of days in channel history......................... NO LIMIT - Maximum number of nicks in one scan............................... NO LIMIT - Maximum number of words in word stats............................. NO LIMIT - Most variables are limited by range of signed 32-bit integer.... 2147483647 Parser-limitations: - Every log has to have some line with date (in some format). No lines are analyzed before that line. - Nicknames can't contain spaces. Thanks to: * All registered users who believe that it can still be developed further * mIRCStats beta tester group * Matt of thehottub.net for support forums (see mIRCStats homepage for a link) * Language and Parser Configuration File writers from countries all around the world. * Everyone who has sent me mail and suggestions about mIRCStats. Please send bug reports and feature suggestions to mircstats (a) nic.fi DISCLAIMER ========== mIRCStats is supplied as is. The author disclaims all warranties, expressed or implied, including, without limitation, the warranties of merchantability and of fitness for any purpose. The author assumes no liability for damages, direct or consequential, which may result from the use of mIRCStats. Copyright of mIRCStats is owned by Mikko Auvinen