PISG

Perl IRC Statistics Generator (pisg) is a Perl script which takes IRC logfiles and turns them into nice looking stats, which can be amusing to show for the users of your channel.

The supported logfile formats is explained in the FORMATS file included with this distribution in the 'docs' directory.

QUICK START (NEW TO PISG?)

Run the guided setup. It finds the IRC logs already on your computer (eggdrop, ZNC, irssi, WeeChat, HexChat, mIRC, AdiIRC), asks a few questions, writes pisg.cfg, makes your first stats page and explains how to keep it up to date and host it for free:

$ perl setup.pl

It works on Linux, macOS and Windows (with Perl installed, for example Strawberry Perl). 'perl setup.pl --dry-run' shows what it would do without changing anything.

SETTING UP PISG

Full documentation for pisg is located in 'docs/pisg-doc.html' (one web page, with a complete example configuration at the end) and in 'docs/pisg-doc.xml'. A ready-to-copy configuration listing every option is in 'pisg.cfg.example'.

Quick usage instructions below:

It's quite simple to set up pisg. You have 2 choices:

• Set settings from commandline (try pisg --help)
• Configure pisg from the pisg.cfg file (more flexible and configurable)

If you look in the example pisg.cfg, you will see a small working sample where you can insert your own data.

The commandline version has the disadvantage that you can only set up one channel to be run.

WHAT'S NEW IN 1.0a

• A guided setup: 'perl setup.pl'.
• Modern light/dark themes, a menu down the left side on wide screens (a slim section bar on phones), and an interactive relation map ('who talks to whom'), plus overview, roles, time personalities and more.
• A landing page with the statistics of your statistics and a page per channel: copy 'site/index.html' next to your stats pages (pisg writes 'channels.json' for it).
• Several channels in one run: a channel that cannot be read is skipped and the others are still made.
• BadUrls (keep spam links out of the stats).
• Safer output: a page is only replaced once it is complete.
• Optional tools in 'scripts/': profiles people edit from IRC (eggdrop), automatic nick merging, and log converters. See 'docs/Changelog' for the full list.

RUNNING PISG

With ZNC, you might need to use this: /msg *status loadmod log -sanitize /home/YOURUSER/.znc/users/YOURUSER/moddata/log/$NETWORK/$WINDOW.log (edit YOURUSER) with your own info. This will enable logging in a clean way for PISG to read them

If you have setup everything inside the config file, then you just need to run it. If you're on a Linux/BSD/Unix system, this should do the work:

$ ./pisg

Running pisg like this will just use the settings in pisg.cfg.

If you want to specify things on commandline instead of in the config file, you could do:

$ ./pisg -ch \#channel -l logfile.log -f mIRC -o index.html

The syntax and options is explained when doing:

$ ./pisg --help

Setting settings on commandline, will override the relevant settings in pisg.cfg.

NOTES

There is some graphics in the gfx/ folder which pisg uses, you should put these in the same directory as your stats file(s) or use the 'PicLocation' configuration option.

The stats will look best with a logfile which is at least one day long. Some stats (like smilies, exclamation marks, etc) doesn't get counted before a special amount of time.

pisg supports multiple languages so the texts on the stats page will be in your own language; look in lang.txt to see the supported languages. The language can be changed from within the pisg.cfg file.

If you have any corrections to the language file, or you want to add a new translation, open a pull request at https://github.com/PISG/pisg.

CONTACT INFORMATION

If you have any issues with pisg, such as problems with installing or running pisg, then join us on Undernet: irc.undernet.org, channel #pisg.

Bugs, patches and feature requests: https://github.com/PISG/pisg/issues

The pisg homepage is located at https://pisg.github.io/.

Have fun :)