# you guessed it, comments start with '#'.
# here are most the options and modules, it's normal that a bot doesn't use
# all of them. read the documentation for each module.

### PLEASE READ ALL THE OPTIONS CAREFULLY !
### ALSO READ EACH MODULE'S HEADER FOR A DESCRIPTION ! (mod/modname.cpp)
### DON'T ASK QUESTIONS THAT ARE EXPLAINED THERE, FOR I WILL NOT ANSWER THEM.
### (this may seem a bit harsh but you'd be surprised how many trivial
### questions i've been asked that are explained there)

### file with the bot's pid, useful if there are 2 or more processes running
pid example.pid
### same as -q in command line
#quiet
### same as -d in command line
#debug
### file to write errors and important events. note that if you use this,
### errors will not be displayed on console, so if the bots dies and nothing
### is printed, don't forget to look here!
botlog mbot.log

### modules to use, not necessarily on all bots. for information about
### them, read their header in the file mod/[name].cpp
# module mod/extra.so
module mod/seen.so
module mod/invite.so
# module mod/log.so
module mod/word.so
# module mod/ircop.so
module mod/flood.so
# module mod/chanstat.so
# module mod/joinmsg.so
# module mod/alice.so
# module mod/watch.so
module mod/whois.so
module mod/calc.so

### logcreate loghandle flushmode timemode filename oldfilename
### by default, <filename> is moved to <oldfilename> at 6 a.m. everyday.
### if <oldfilename> is ommited, don't rotate log file
### if timemode is 0, logs with hour:minute. if it's 1, log with full date
#logcreate tvi 1 0 tvi.log tvi.old.log
#logcreate somenick 1 1 somenick.log
logcreate pvt 1 1 pvt.log
#logcreate alice 1 1 alice.log
#logcreate watch 1 1 watch.log
### logmail loghandle email
### sends the log to <email>, can only be used in rotating logs
#logmail tvi root@darksun

### each bot must start with the line "bot". it's each bot's configuration
### delimiter, and at least one must be declared (obviously).
### for example, if you want to run another bot besides the one that's
### configured here, then copy all lines below this (including this "bot"
### line) and paste them at the end, then configure it as an entirely new bot
### (which is what it is, actually).

bot

### many irc servers can be specified, if one fails tries the next
host irc.ptlink.net 6667
host matrix.ptlink.net 6667

### use this virtual hostname, if possible.
### if you don't know what it is, ignore! *this is NOT for spoofing*
#vhost other.localhostname.org

### basic stuff
nick example
user BotsUser
name Bot's irc name
# comment the away to turn it off
away i'm away, don't bother..
quit This is the default quit message.

### channel(s) where the bot stays
### -> channel channel channelkey
channel #rtp1
channel #tvi this-is-the-chan-key

### use this if the bot is running in a machine with a different timezone
### than the irc server where it's connected. time in minutes, both positive
### and negative values can be specified. this affects everything except what
### is not per-bot dependant, like a log of invalid parameter in command line.
#changetime -60
#changetime 120

### irc services configuration, ignore if the network doesn't use them
### bot nickserv's password, if used, else comment out
nickserv_pass nick_password
### nickserv's mask, depends on the irc network
# mask for ptlink
nickserv_mask NickServ!Services@PTlink.net
# mask for ptnet
#nickserv_mask NickServ!suporte@PTnet.org
### start of string asking to identify
# in ptlink:
nickserv_auth This nickname
# in ptnet:
#nickserv_auth Nick registado
### uncomment this parameter if the services still use privmsg
#servicesmsg

### change the default ctcp version reply
set ctcp_version If you version me, you'll read this!

### DCC configuration
### !get's definitions
#dccget example.get
### port to use for dccs, 0 for any free one (default)
### useful when the bot is behind a firewall
#dccport 56789
### file to show to who joins the partyline
dccmotd example.motd

### user's file
users example.users

################  ircop module  #####################
###ircop password, for the ircop module
#ircop keep_dreaming

################  invite module  ####################
### parameter for the invite module - only one invite per bot can be used
#set invite_channel #rtp1

################  log module  #######################
### -> log loghandle what
### log a channel
#log tvi #tvi
### log nick's pvts with the bot
#log somenick nick
### log all pvts with the bot
log pvt <privmsg>

################  flood module  #####################
### number of equal msgs to be considered flood (0 to turn off)
set flood_maxmsg 4
### number of msgs (may be different ones) with the same mask (0 to turn off)
set flood_maxmask 7
### number of msgs beyond the 2 defined before, to kick. If not 0, sends in
### pvt the floodkickmsg when flood is detected. Default is 0.
set flood_maxwarn 1
### reason of the flood warn/kick
set flood_kickmsg Please don't flood.

################  word module  ######################
### -> word file
words example.words
### use this to send the ??'s replies with notice instead of privmsg
#wordnotice
### to change the default message when words are not defined
### -> wordnotdef text
#wordnotdef That word is not defined!

################  seen module  ######################
### -> seen file
seen example.seen

################  chanstat module  ##################
### -> chanstat module option
### the number at the end (0/1) is whether you want users' address to be shown
#chanstat #rtp1 rtp1.html rtp1.stat 1
### in how many seconds are the stats refreshed, default 60
#set chanstat_refresh 60

################  joinmsg module  ###################
### show example.msg to all users when they enter #rtp1
### -> joinmsg channel msgfile
#joinmsg #rtp1 example.msg

################  alice module  #####################
### initialize alice, you should read mod/alice.cpp for *important* details
### -> alice initfile userfile [loghandle]
#alice alice/data/alice.ini alice/log/localuser.txt alice

################  watch module  #####################
### log a nick's login/logout from irc
### -> watch loghandle nick
# watch watch mirage

### use this to remove any !command(s) from this bot.
### note that a command cannot be removed before its activation, ie, you
### cannot remove !seen before defining a seen file.
#unbind !rose

