The manual page for the IrcBot configuration file format.
Name
ppbot.conf - configuration file for ppbot
Description
The ppbot.conf file specifies the configuration for ppbot. This file consists of server definitions, channel definitions and configuration parameters. To start ppbot, there needs to be at least one server defined in the configuration file.
Empty lines and lines starting with a hash character ('#') are ignored.
Server definition
A server is defined by the keyword 'server', following by an unique identifier. The configuration parameters for the server are specified between an opening brace and a closing brace.
Channel definition
A channel is defined by the keyword 'channel', followed by the channel name. The configuration parameters for the channel are specified between an opening brace and a closing brace.
A channel may only be defined inside a server section.
Parameters
The configuration parameters start with a keyword, then one or more space characters and the value for the keyword. Double quote characters can be used to specify strings with spaces or special characters in them.
Global parameters
The following parameters and arguments are recognized in the global section:
debug boolean
- Can be 'yes' or 'no'. If set to 'yes', debug messages will be enabled. These messages will be written to the logfile, so the logfile parameter must be configured as well.
logfile file
- Specify the file that will be used to put the log messages in. To enable logging, this parameter must be set to a valid path/file where ppbot can write to.
plugin file
- Add and enable an external plugin.
Server parameters
The following parameters and arguments are recognized in the server section:
address string
- Define the address or hostname for the server to connect to. This parameter is mandatory.
altnick string
- Define the alternate nickname, the nickname that will be used if the first nickname cannot be used for some reason.
ident string
- Define the user identification part. If this parameter is not set, the value of the nickname will be used.
nickname string
- Define the first nickname to use. This parameter is mandatory.
password string
- Define the password for the server.
port number
- Define the port for the server. If this parameter is not set, the default port 6667 will be used.
realname string
- Define the real name of the user. If this parameter is not set, the value of the nickname will be used.
Channel parameters
The following parameters and arguments are recognized in the channel section:
key string
- Define a key to use when joining the channel.
logfile file
- Define a log file to log events in the channel to. The format of the log file is compatible with the 'eggdrop' format.
Example
An example ppbot.conf file:
server pointless {
address pointless.nl
nickname ppbot
channel #foobar
channel #secret { key mysecretkey }
}
plugin plugins/google.so
plugin plugins/feed.so
logfile logs/ppbot.log