Elfbot README by nslay 4/2/07

- Configuration
For basic configuration, see bot.conf.example, access.lst.example and shit.lst.example

If you have elfbot in source form, be aware of the various #defines
These include:
- bot.h
/* Hardcoded send queue delay (ms) */
#define BOT_SENDQ_TIMER 2500
/* Hardcoded channel /join delay (ms) */
#define BOT_CHANNEL_TIMER       5000
/* Hardcoded login expire time (s) */
#define BOT_AUTH_EXPIRE 60

- main.c
#define BOT_DEFAULT_CONF        "bot.conf"
#define BOT_DEFAULT_ACCESS      "access.lst"
#define BOT_DEFAULT_SHIT        "shit.lst"
#define BOT_DEFAULT_PORT        "6112"
#define BOT_DEFAULT_RECON       5000
#define BOT_DEFAULT_IDLE        30000
#define BOT_DEFAULT_TIMEOUT     10000
#define BOT_DEFAULT_TRIGGER     '!'

You should NOT touch anything else! 

- Usage
Usage: elfbot [-D] [-c config file]

-D - debug mode, print out EVERYTHING
-c - specify an alternative configuration file to use

- Accessing
The bot's access system is login based, the login username is your server name
the login password is specified in access.lst
You may login by either talking or whispering (RECOMMENDED!) 'login <pass>'
Your login is renewed every time you issue a command, otherwise it expires for
security reasons. The bot works in 5 levels, 0-4

NOTE: [] denotes OPTIONAL arguments while <> denotes REQUIRED arguments

Level 0 - The base privileges

login <pass> - Login to access the bot
logout - Logout, you may no longer access the bot
unban - Unban yourself
version - Bot's version
trigger - Bot's trigger
where - Bot's current channel
passwd <pass> - Set new password *unimplemented*

Level 1 - basic privileges
kick <user|pattern> [reason] - Kick a user or a wildcard for a reason

Level 2 - elevated privileges 
ban <user|pattern> [reason] - Ban a user or a wildcard for a reason
unban <user> - Unban a user

Level 3 - higher privileges
designate [user] - designate yourself if you do not provide a user, or another user
shitadd <pattern> [reason] - add a pattern to shitlist *unimplemented*
shitdel <pattern> [reason] - delete a pattern from shitlist *unimplemented*

Level 4 - root privileges
say <text> - echo text *dangerous*
join <channel> - set new home channel
rejoin - rejoin the channel
halt - clear send queue
reconnect - reconnect that specific bot
disconnect - kill the specific bot
shutdown - kill elfbot 
useradd <user> <password> <level> - Add a user to access list *unimplemented*
userdel <user> - Delete user from access list *unimplemented*


