- CONFIGURATION FILE LOCATIONS
- COPYRIGHT AND LICENSE
Bot::Net::Config - the configuration for your bot net
my $config = Bot::Net->config; my $bot_config = $config->bot('CopyBot'); my $server_config = $config->server('MasterHost');
This module loads and stores the configuration for your bot net. The bot net configuration is typically stored in etc/config.yml of your bot net application directory. However, you can have multiple configurations, which can be specified to the spawn command using the
You should not need to call this method directory. Instead:
my $config = Bot::Net->config;
will call the constructor as needed.
The main configuration file for your Bot::Net application is stored in etc/net.yml. This returns a single value from that file if a
KEY is specified or returns the entire configuration if no key is given.
Returns the path to the main configuration file for your Bot::Net application, which is stored in etc/net.yml.
Reloads one of the configuration files. You normally won't need to call this method, it will be called automatically.
Saves a configuration file. This can be useful when making changes to the configuration from within a bot that you would liked saved for future use.
Returns the location of the configuration for the server named
Returns the configuration for the named server.
Returns the location of the bot configuration file for the named bot.
Returns teh configuration for the named bot. This will include the default configuration and bot-specific overrides.
Bot::Net will search for configuration files in the following places (and in the following order). The first file found according to this order will be used.
If the environment variable
BOT_NET_CONFIG_PATHis set. It is assumed to be a list of one or more paths (separated by colons) containing the names of the directories to search for configuration files. The directories will be searched in the order given in the variable.
The program will look for the binary file (using FindBin) that was executed (probably bin/botnet) and find the etc directory one level above the directory containing the script. For example, if you're running your bot net from /home/sterling/MyNet/bin/botnet, it would look in /home/sterling/MyNet/etc for your configuration files.
Within the directory found, the files will be named as follows:
The net.yml file must be found in this directory.
Server config files will be found in a subdirectory named server and then subdirectories based upon the name of the server.
For example, a server package named
MyNet::Server::Foo::Bar::Master would find it's configuration file under server/Foo/Bar/Master.yml.
Bot configuration files are in the subdirectory named bot and then subdirectories based upon the name of the bot.
For example, a bot package named
MyNet::Bot::Foo::Bar::ChanOp would find it's configuration file under bot/Foo/Bar/ChanOp.yml.
Andrew Sterling Hanenkamp
Copyright 2007 Boomer Consulting, Inc. All Rights Reserved.
This program is free software and may be modified and distributed under the same terms as Perl itself.