ircPasswd docs

[infobot.git] / files / sample / blootbot.config

# blootbot configuration file, modify it to your own taste.  blootbot reads
# this file from files/blootbot.config so it should be moved there.

#####
# Basic IRC info
#####
set ircNick             blootbot
set ircUser             blootbot
set ircName             blootbot experimental bot
# if your irc network requires a password to get on the servers
#set ircPasswd          SomePassword
set ircUMode            +iw
###set ircHost          vh.virtualhost.org
# if not using a virtualhost set to 0.0.0.0
# otherwise IRC::Connection might try localhost which will NOT work
set ircHost             0.0.0.0

set owner               OWNER

# nickserv/chanserv support.
###set nickServ_pass    PASSWORD
###set chanServ_ops     #chan1 #chan2

# default quit message.
set quitMsg             adios amigos

# path to a temporary directory which blootbot can use.
set tempDir             /home/blootbot/Temp

#####
# Factoid database configuration
#####

# [str] Ability to remember/tell factoids
#       none    -- disable.
#       mysql   -- ...
#       SQLite  -- SQLite (libdbd-sqlite-perl)
#       pgsql   -- postgresql (NOT SUPPORTED)
### REQUIRED by factoids,freshmeat,karma,seen,...
set DBType              mysql

# [str] SQLite filename prefix // MYSQL/PGSQL database.
#       eg: blootbot-factoids, blootbot-seen
#       eg: /var/db/mysql/blootbot/factoids.*
set DBName              blootbot

# [str] Hostname of database server (unset for SQLite)
set SQLHost             localhost

# [str] SQL user allowed to insert,update,delete stuff from tables. (unset for SQLite)
set SQLUser             blootbot

# [str] SQL password. (unset for SQLite)
set SQLPass             PASSWORD

# [str] SQL debug file.
###set SQLDebug         SQL_debug.log

#####
# Logfile configuration
#####

# [file] where to put logging info. comment out to disable.
set logfile             log/$ircUser.log

# [str] Type of logging.
#   DAILY       -- Create a new log each day.
#   DEFAULT     -- One continuous log file.
set logType             DAILY

# [int] Maximum log size, if logfile is defined, in bytes.
set maxLogSize          10000000

#####
# Factoid-related configuration
#####

# [bool] Factoid support.
set factoids            true

# [days] if not 0, number of days until factoid is deleted for good.
set factoidDeleteDelay  0

# [int] maximum length of factoid key.
set maxKeySize          32

# [int] maximum length of factoid value.
set maxDataSize         450

# [int] minimum length of unaddressed (message) question without question
#       before it is answered involuntarily.
#       This ignores the 'addressing' setting.
#       0 to disable.
set minVolunteerLength  0

# [str] when should the bot bother learning new factoids.
#   ADDRESSED   -- only learn when addressed.
#   HUNGRY      -- learn irrelevent of addressing. this will catch
#                  _everything_, use at your own risk. I tried this ages
#                  ago and it caught quite funny responses but who knows
#                  if my modifications will prevent this or not, perhaps
#                  IsInvalid must be disabled?
set learn               ADDRESSED

# [str] different behaviour with URLs.
#   REQUIRE     -- means it will need to be a url type (e.g. file:, http:)
#   OPTIONAL    -- will take anything
#   REJECT      -- will not accept any urls.  this makes it easy to
#                  run 2 with different nicks and styles.
#                  ^^^ what's the point of this???
set acceptUrl           OPTIONAL

# [bool] profanity checking.
set profanityCheck      false

# [0/1] tell so-and-so about such-and-such of a factoid.
set allowTelling        1

# [str] other bots to ask for factoids which they may have.
#set friendlyBots       url purl script mrapi

#####
# Factoid related and unrelated features, mainly Extras.
#####

# [str] addressing is when you name the bot. FIXME:
#   REQUIRE     -- the bot only does something if addressed.
#   OPTIONAL    -- the bot responds (does not learn) irrelevent of
#                  addressing.
set addressing          REQUIRE

# [char] One-character easy recognition.
set addressCharacter    ~

# [str] how the bot should send messages.
#   PRIVATE     -- reply to private messages only, rejecting public msgs.
#   DEFAULT     -- reply to public _and_ private queries.
set talkMethod          DEFAULT

# [str] how long the output string should be before it is changed from
#       public to private.
#       "+" before bot commands overrides this option temporarily.
###set minLengthBeforePrivate 192

# [int] maximum length of reply for Extras function before popping list to
#       reduce number of elements.
set maxListReplyLength  450

# [int] maximum number of elements in list allowed for Extras function
#       before popping elements to reduce total count.
set maxListReplyCount   15

# [0/1] allow people outside any channels the bot is on to use the bot
#       for factoids and commands.
set disallowOutsiders   1

# [int] Amount of time for auto-ignore (flooding) to expire.
set ignoreAutoExpire    5

# [int] Amount of time for forced-online ignore to expire. minutes.
set ignoreTempExpire    60

#####
# Internal (simple) bot commands
#####

# [0/1] irc-cli calculator.
set perlMath            1

# [0/1] ord/chr etc
set allowConv           1

# [0/1] do you want to allow DNS lookup
set allowDNS            1

# [0/1] Forking... disable for non-nix OS or to reduce mem usage.
#       Disabling should make the bot work on Win32 and MacOS.
set forking             1

# [int] Backlog... ideal to see what happened to the bot on console.
#       maximum number of lines to backlog.
set backlog             24

#####
# Extra features
#####

# [str] anything which requires LWP + http proxy.
###set httpProxy                http://HOSTNAME:PORT/

# [0/1] babelfish translator.  jdf++.
set babelfish           true

# [0/1] offer free factoid cookies
set cookie              true

# [0/1] Countdown to specific dates
set countdown           true

# [0/1] Debian file and package search.
set debian              false
# [int] how often to update the debian table, in days.
set debianRefreshInterval 1
# [0/1] extra stuff...
set debianExtra         true

# [0/1] Frontend to dict.org's wordnet.
set dict                false

# [0/1] Freshmeat
set freshmeat           false
# [int] how often to update the freshmeat table, in hours.
set freshmeatRefreshInterval 24

# [bool] if factoid does not exist, check freshmeat for it.
set freshmeatForFactoid         false

# [0/1] insult server
set insult              false

# [0/1] karma
set karma               true

# [0/1] Frontend to kernel.org
set kernel              false

# [0/1] LART.
set lart                true

# [0/1] nickometer
set nickometer          true

# [0/1] Frontend to the stock market.
set quote               false

# [0/1] Display random text in the channel.
set randomQuote         true

# [0/1] Display random text in the channel.
set randomFactoid       true

# [0/1] Warn users about root.
set rootWarn            false
#   passive     -- be polite plus stuff, compliant to OPN, heh.
#   aggressive  -- ...
set rootWarnMode        passive

# [0/1] Factoid search.
set search              false

# [0/1] keeps stats on individual commands
set stats               true

# [0/1] slashdot headlines.
set slashdot            false

# [0/1] frontend to ispell.
set spell               false

# [0/1] Advanced topic management.
set topic               true

# [0/1] User Information Services.
set userinfo            true

# [0/1] Uptime daemon
set uptime              true

# [0/1] Wingate checking and banning mechanism. FIXME:
###set wingate          false
# [int] seconds. minimum time to check.
set wingateInterval     60
# [str] Wingate.
set wingateBan          true
# [str] Wingate.
set wingateKick         Please don't use wingate

# [0/1] google search.. simon++. requires libwww-search-perl + 5lines of
#       modifications.
set wwwsearch           false

# [0/1] Unit conversion tool.
set units               true

#####
# Miscellaneous configuration options
#####

# [int] Display a bit too much info about stuff.
#   0   -- disable.
#   1   -- standard.
#   2   -- extra.
set VERBOSITY           1

# [0/1] Warn messages.
set WARN                1

# [0/1] Debugging messages.
set DEBUG               0

# [0/1] Work In Progress...
set WIP                 0

# strict perl?
set useStrict           1

# debugging...
###set dumpvars         1
###set dumpvarsAtExit   1
# log to specific file or global log file.
###set dumpvarsLogFile  dumpvars.log

# [str] Interface: [IRC/CLI]
#   IRC         -- Internet Relay Chat
#   CLI         -- Command Line Interface
set Interface           IRC

####
# Now modify blootbot.chan for per-channel specific configuration see
# sample.chans for info.
####