botnix.example.conf

// +-------------------------------------------------------------------------+
// | BOTNIX EXAMPLE CONFIGURATION FILE                                       |
// +-------------------------------------------------------------------------+
// |                                                                         |
// | PLEASE EDIT BEFORE USING!                                               |
// |                                                                         |
// | The botnix configuration is constructed of two                          |
// | components, networks and channels. Both can be considered 'containers', |
// | which must obey the structural rules laid out below:                    |
// |                                                                         |
// | * A network block may contain channel blocks, or network commands       |
// | * A channel block may contain channel options, but not network commands |
// |   or network blocks                                                     |
// | * A channel block may be outside of a network block, in which case it   |
// |   is considered to be global to all networks.                           |
// | * Certain commands global to the entire bot (such as modules) may be    |
// |   outside of both network AND channel blocks.                           |
// |                                                                         |
// +-------------------------------------------------------------------------+

// Please include this text with any bug reports
// $Id: botnix.example.conf 2311 2005-12-10 17:46:54Z brentd $

// A network block represents a network to connect to

network "ChatSpike" {

	// there may be multiple servers to try on a network.

	address "stitch.chatspike.net/6667"
	address "dexter.chatspike.net/6667"

	// Use ssl on this network?
	// if not defined, defaults to 'no'.

	// usessl "no"

	// To use a HTTP proxy for connecting your bot to IRC, define one or both of
	// these instructions. The proxyauth instruction is optional and not required
	// if you do not require authentication to use the proxy server.

	// proxyaddress "proxy.lan/8080"
	// proxyauth "student" "0penSeseme"

	// the bot will think of an alternate nickname itself if its primary nickname
	// is not available for use

	nickname "neuron_nix"
	ident "nix"
	fullname "botnix test bot"

        // If you want to use a vhost, put the IP of the vhost you want to use here.
        // Remember you cannot just make this up, the host has to be bound to
        // an IP on the machine. You can bind to both ipv4 and ipv6 IPs.

        // bind "1.2.3.4"

	// define the password for the server, if one is used, by using this
	// instruction. Remember passwords are usually case sensitive.

	// password "letmein"

	// Define a nickserv password if your bot's nickname is registered and
	// you have the modules/irc/nickserv.pm module loaded.

	// nickservpass "openseseme"

        // maximum number of modes we can queue and send at once on this network.
        // this value is optional, and if omitted defaults to the ircnet default
        // of three modes maximum per line.

        maxmodes "10"

	// Maximum amount of bytes that may be sent per second to this network.
	// This value is optional and if omitted the default is 256, or 0.25kb/sec.
	// This is an approximation and depending on traffic the maximum may
	// temporarily exceed this value or short amounts of time. If you randomly
	// get excess flood quits, lower this value. If your bot appears slow,
	// first try increasing this value.

	throttlebps "512"

	// This optional value indicates how many seconds to wait before reconnecting
	// to the network, if it becomes disconnected for some reason. Be aware that
	// setting this too low can cause IRC servers to ban you with klines or worse!

	reconnect "60"

	// A channel block inside a network block exists only on that network

	channel "#botnix" {

		// Rejoin on kick

		rejoin

		// Auto voice everybody who joins

		autovoice

		// Cycle the channel if there are no ops

		cycle

		// This command is implemented by the modules/log/file.pm
		// module. If you define a log file for a channel, then
		// this logfile captures all log output targetted at this
		// channel.

		logfile "../botnix.log"

		// Use this command if you want timestamps in your logs.
		// Applies only to the current channel/network context

		timestamps "yes"

	}

	// These commands are read by the ctcp module (modules/irc/ctcp.pm)
	// there are four usable configuration commands for this module, each
	// settable on a per-network basis:

	// This command indicates that ctcp ping should be answered on this
	// network. The default is not to answer ctcp ping, for security.

	ctcpping

	// This command indicates that ctcp time requests should be answered
	// on this network. The default is not to answer any time requests.

	ctcptime

	// This command indicates a change to the standard version reply.
	// Botnix will always return a version reply, however this instruction
	// allows you to change it however you wish.
	// If you do not want botnix to answer version requests, do not load
	// the ctcp module.

	versionreply "Got botnix?"

	// This command indicates a change to the standard finger reply.
	// Botnix will always return a finger reply, however this instruction
	// allows you to change it however you wish.
	// If you do not want botnix to answer finger requests, do not load
	// the ctcp module.

	fingerreply "Get your finger out of my socket."

	// Use this command to enable support for the ERRMSG ctcpreply.
	// this is not recommended as it can be used to flood the bot.

	// answererror
}

// A channel block outside of a network block is global to all networks
// this is an example of such a channel block.

channel "#logcabin" {

	// The nocommands token is implemented by the module
	// modules/irc/cli.pm, and if specified will disallow
	// commands being issued in the channel, even if the
	// global settings enable on-channel commands.
	nocommands
	rejoin
	autovoice

}

// This command is implemented by the modules/log/file.pm module. If
// you are using the file logger module you *must* define this logfile
// directive outside of all channels and networks, as this 'main' logfile
// will capture all log messages not directed at a channel or server
// which has its own log. If you define a logfile for a server, but do
// not put it within a channel, channel messages will NOT appear in that
// log, they will most likely appear here.

logfile "../servers.log"
timestamps "yes"

// This instruction defines the filename for the userfile. If you do not
// specify a name for your userfile, then the default 'botnix.uf' is used.

userfile "botnix.uf"

// This instruction defines the filename used for the storefile. If you
// do not specify a name for the storefile, then thedefault of 'botnix.store'
// is used. The storefile holds all persistent settings for the bot and any
// modules it loads, except for the user data, such as auto kicks, etc.

storefile "botnix.store"

// This command is implemented by the modules/irc/cli.pm module. If you do not
// load this module and define this instruction, you will not be able to give
// your bot ANY commands via message or on a channel. To specify where you can
// issue commands, put either or both of message and channel into the paremeter
// as shown below.
//
// NB: If you specify the 'channel' option here, the default is to reply to the
// channel with a public channel notice. If you'd rather the bot reply in person
// to you EVEN WHEN IT IS COMMANDED ON CHANNEL, then use the token channelprivate
// instead of channel. You may not use both channel and channelprivate at the same 
// time.

allowcommands "message,channel"

// You must load modules into your bot to make it function on more than
// just a primative level. The modules shown below should be self explainitory
// and will add support for various IRC features considered 'normal' for
// an IRC client.

// CTCP support

module "modules/irc/ctcp.pm"

// DCC support (not dependent on CTCP support)

module "modules/irc/dcc.pm"

// Speech (.ACT and .SAY commands)

module "modules/irc/speech.pm"

// File logger (for logging to text files)

module "modules/log/file.pm"

// Channel Operator actions

module "modules/irc/chanop.pm"

// Channel mode actions

module "modules/irc/chanmode.pm"

// Channel and private message command support

module "modules/irc/cli.pm"

// Public flood checking module

module "modules/irc/flood.pm"

// Channel relay block

// relay "FriendlyName" {
//      SourceInfo "SourceNetwork" "#SourceChannel"
//      DestInfo "DestinationNetwork" "#DestinationNetwork"
// 	[DestInfo "DestinationNetwork" "#DestinationNetwork"]
// 	[DestInfo "DestinationNetwork" "#DestinationNetwork"]
// 	[...]
// }

// Non relay'd Nicks. REGEX of the users not to relay.

// norelaynicks "nick!*\@*"

// module "modules/irc/relay.pm"

// Nickserv module (allows identifying to services)

module "modules/irc/nickserv.pm"