
#########################################
# ATTENTION                             #
# Rename bitch.conf when done editing.  #
#########################################

# You will NEED to READ THROUGH THIS ENTIRE FILE
# and FILL IN sections that are relevant. Or the
# bot will NOT WORK. Simple isn't it.

#---------------
#x 'is' y, x 'was' y, etc, add more here if you need to.
#be sure to keep the space either side.
#---------------
@splitwords = (" is ", " was ", " are ", " sucks ", " owns ", " 0wns ", " has ", " wants ");

#--------------------------
#auto-check for new version on startup?
# ONLY TURN THIS ON IF YOU WATCH THE BOT START UP SUCCESSFULLY
# I've had to firewall a number of users from my server because they set
# auto update on, but didn't configure the bot at all, meaning the auto
# restart script spammed my webserver with (in one case) over a 100,000
# requests.
#--------------------------
$autoupdate = 0;

#---------------
#allow use of eval
#---------------
#this is a HUGE SECURITY RISK if enabled, as someone faking admin hostmask
#could essentitally destroy your computer (win32) or mess up your user account (*nix)
#the only time it should be 0 is for debugging purposes
#---------------
$noeval = 1;

#---------------
#allow shortcuts like !kick nick, !ban nick, !voice nick, etc.
#set to 0 if you already have bots that do those sorta things
#---------------
$enableshortcuts = 1;

#------------
#set this to 1 to disallow 'command??' addressing
#------------
$noqq = 0;

#---------------
#default user modes if not on access list (need space either side eg " ADDFACTS ");
#---------------
$defaultmode = "";

#---------------
#time zone to display times in
#---------------
$timezone = "GMT";

#---------------
#regex for admin hostmask. this is a regular expression, not wildcards
#---------------
#generally, .* means 'anything', \. means '.', and \@ means '@'
#address is in the format nickname!ident@host.domain.com

#to find your user mask, enter /WHOIS yourname when on IRC. well if 
#you can't figure this out I guess you don't deserve the bot :)

#example1, to add *!r1ch@*.screaming.net, I would use
#  $admin = ".*!r1ch\@.*\.screaming\.net";

#example2, to add MyNick!*@212.188.*.*
#  $admin = "MyNick!.*\@212\.188\..*\..*";

#example3, to add *!*@my.static.ip.address
#  $admin = ".*!.*\@my\.static\.ip\.address";

# OR you could leave this blank if you really can't figure out
# how to enter your hostmask .
#---------------
$admin = "";

#---------------
#server name/IP and port
# (NOTICE YOU NEED TO FILL BOTH OF THESE IN)
#---------------
$server = ""; 	      
$serverport = "";

#---------------
#debug info? set to 'medium' to have the bot console display irc-like chat
#---------------
$verbose = "off";

#---------------------
#for ircops only (THIS MEANS IRCOPS ONLY)
#---------------------
$opername = "";       #oper username      /   this will allow bot to oper
$operpass = "";       #oper password      |-- for people with o:lines only.
$autooper = "0";      #oper on connect?   \   bypasses flood control
 
#---------------
#directory to store files. default is fine unless you want to run
#multiple bots with one .pl file.
#---------------
$datadir = "data";

#---------------
#channel to join, eg "#bitchbot".
# NOTICE YOU NEED TO FILL THIS IN!
#---------------
$channel = "";

#------------
#key for above channel (only if you know you need it!)
#------------
$key = "";
      
#---------------
#name of bot
# NOTICE YOU NEED TO FILL THIS IN!
#---------------
$botname = "";

#---------------
#bot password for nickserv (blank to disable id)
#---------------
$botpass = "";

#---------------
#botname [symbols] to respond to (eg bitch, stuff or bitch: stuff etc)
#different values separated by a |. be careful, this is a regular expression
#and some characters such as \, /, ^, $, [, ], ? need to be written with \ in front
#---------------
$botanswer = ":|,";   

#---------------
#no purpose yet. don't bother changing it.
#---------------
$botemail = "bitch\@host.com";

#---------------
#your nick (for occasional admin notices, eg "someone is pinging me" etc
#leave blank to not send such messages
#---------------
$adminnick = "";

#---------------
#your nickserv password (leave blank to disable protection, it
#basically ghosts anyone pretending to be you who isn't in the admin mask)
#---------------
$adminnickservpass = "";

#-------------
#no playerlist command for qstat?
#-------------
#unless the bot has an o:line the playerlist on populated
#servers will most likely flood the bot off. so this option
#defaults off unless you explicitly turn it on (by intuitively setting it to 0)
#-------------
$noplayerlist = 1;

#---------------
#allow votes / polls ?
#---------------
#if for some reason you want to turn off
#voting or polling set to 1.
#----------------
$nopoll = 0;
$novote = 0;

#--------------
#allow cyborg/tech toys?
#--------------
#slow links or if the remote server goes down
#might cause the bot to lock up or crash while
#trying to connect. so you can disable these toys with 1.
#--------------
$notoys = 0;

#---------------
#max options in a poll
#---------------
#since each option takes its own line
#more options increase the chance of the bot
#flooding off if it doesn't have an o:line
#---------------
$maxpolloptions = 6;

#---------------
#where is the chanstats IRC log file saved to?
#-------------
#shouldn't need to change this unless you really have to.
#the default is the name of the bot.chat.log (eg bitch.chat.log) in the dir with bitch.pl
#---------------
$logfile = "./${botname}.chat.log";        

#-------------------
#maximum number of pending bitchmsgs a user can have
#-------------------
#this should be a reasonable limit so that bitchmsgs are useful
#but low enough to prevent spamming or other abuse.
#-------------------
$maxpending = 5;

#---------------
#allow channel stats?
#---------------
#channel stats can consume massive amounts of processing power and RAM with large log files,
#so you may wish to disable them perhaps if you have limited disk space or a 486 etc.
#general RAM usage is approx. log size. by default they are disabled in case you don't set
#the options below, the bot would crash if someone did updatestats. set this to 1 if you want
#the stats and don't forget to fill in the other options below.
#---------------
$allowstats = 0;

#---------------
#where do you want to save the stats file today? (TM)
#---------------
#on linux etc, set to /wherever/you/want/stats.html
#for win32, set to c:/where/you/want/stats.html
#
#the directory must exist and be writable by the user
#running the bot or it will get confused and exit.
#---------------
$outfile = '/home/me/public_html/logfiles.html';

#---------------
#output of the HTML (displayed as "check chanstats at [url]") so only use if you upload/host stats
#---------------
$outurl = 'http://my.hoster.com/~me/logfiles.html';

#------------
#max number of nicks on chanstats page
#------------
$maxstats = 100;

#---------------
#average the stats or include EVERYONE (1 or 0)
#---------------
#generally this *might* speed up chanstats on huge log files
#if set to 1, but the new $maxstats should put a good limit.
#use that instead.
#---------------
$statsaverage = 0;

#---------------
#list of swear words to search for (for rudest section), eg @swearwords = qw(bitch ass shit);
#---------------
@swearwords = qw();

#---------------
#nicknames to exclude from stats (space separated), eg @exclude = qw(some_llama spammerBot Chanbot1);
#---------------
@exclude = qw();

#-----------------------
#stats uploading (experimental)
#-----------------------
#ok so not all of you have bitchbot running on a computer with a web server
#and you want to upload your channel stats to your ISP's webspace or whatever.
#well now you can (EXPERIMENTAL) with Net::FTP. You must have this perl module
#installed or the bot will die on you as it tries to upload the stats. If in
#doubt do the standard perl -MCPAN -e shell; followed by install Net::FTP.
#or ask your system administrator if you don't have r00t. Windows users, you'll
#probably want to grab the precompiled version from the bitchbot website.
#----------------------
#be aware though, if you are on a slow link the time it takes the bot to generate
#the stats AND upload them might cause it to time out. your call. on windows this
#is a particularly nasty problem since the bot can't tell when stats are finished
#and ends up locking up until they are finished. if you then have to wait for them
#to be uploaded as well you do risk having the bot time out (but with an auto restart
#script it should come right back).
#-----------------------
#note when i say 'experimental' i mean I've tested it locally over my LAN under
#various situations and it works fine - the problem is I don't have net access
#as I'm coding this, so I can't do a "real" test. but it's quite likely to work.
#-----------------------

#--------
#use passive transfer mode?
#--------
#if you get errors, are using some kind of internet sharing or firewall
#or the file doesn't seem to upload properly try setting this to 1.
#--------
$uploadpasv = 0;

#--------
#host name or IP of your FTP server (eg '10.0.0.128' or 'ftp.myisp.com')
#--------
$uploadhost = '';

#--------
#username and password to log in as
#--------
$uploaduser = 'yourISPusername';
$uploadpass = 'yourISPpassword';

#--------
#directory to change to before uploading (eg 'chanstats/', directory
#must exist on the FTP server or bad stuff (Tm) happens).
#leave this blank to attempt upload to whatever directory your ftp
#server places you in when you first connect (blank meaning '')
#--------
$uploadpath = 'stats/';

#--------
#filename to call the stats HTML page on the remote server (eg 'index.html')
#--------
$uploadname = 'index.html';

1;
