The Natasha Project README
~~~~~~~~~~~~~
 Natasha Copyright (c) 2004 Peter Salanki.

 This program is released under the GPL.
 See file COPYING for details.


What is it?
~~~~~~~~~~~
 The Natasha Project is an automated IRC client, a bot.
 It is aimed to be efficient, resource light, admin and user friendly.
 The intention is that you should run a lot of bots in a so called bothouse.
 The goal is that Natasha should be able to handle botnets with around 200-400 bots.

Requirements:
~~~~~~~~~~~~~
 * libmysqlclient - The MySQL database client library
 * PCRE - Perl Compatible Regular Expressions (this is available at http://www.pcre.org).
 
 Natasha is known to work on, at least:
	
	* Linux
	* FreeBSD
	* OpenBSD
	* NetBSD

Function summary:
~~~~~~~~~~~~~~~~~
 * All bots in a service runs under one process. This enables load balancing and heavily decreased memory usage.
 * Everything is stored in a MySQL database, this makes the integration of your own website and services much easier.
 * No eggdrop like userfile transfers, everything is handled in memory with support of the main MySQL database
 * Usage of POSIX-threads makes the response times short, even in a large services.
 * Home channel protecion option, with rotating keys and "hunting" of unauthorized people
 * Web based request and request handling system. With predefinable filters in the auto-check part.
 * Fun public commands as !vote, !peak, !quote, !google, !tv (Sweden only)
 * All standard bot features: welcome message, channel friends/voices/ops/masters/owners and so on.
 * Anti advertise and anti flood with warnings.
 * Time limited bans, with reason.
 * Topic enforcement (like the topic enforcement option in the QuakeNet CServe)
 * Greet functions, that will welcome a user in the channel with a custom message on join.
 * Bitch mode, that will protect ops from being deopped by lower then masters, and vice versa. Bitchmode will not allow setting of channel key/invite if the user is not a master or highter.
 * Fully automatic channel statistic generation. Support for location of statsbox totally off-site.
 * Loadable module support, for upgrade without needing to restart the service and for scalability.
 * Channel suspends
 * Personal reminders "notes" which sends you a message on a scheduled date/time.
 * Support for the QuakeNet services Q, L and S
 * And lots of more functions that are to small to be in this list

Installation:                                                               
~~~~~~~~~~~~~   
 These are the basic installation steps, the steps and configuration files are explained in the web-based documentation.

 1. Edit src/settings.h
 2. make clean
 3. make
 4. make modules_all
 5. Edit modules.conf, make the paths correct. If you get errors, try to remove the graph and request modules.
 6. cd tools/setup/
 7. make
 8. ./setup
 9. cd ../../
 10. ./natasha
 11. On IRC /msg <bot> IDENT. You should see a message in HOMECHAN confirming your login.
 12. Done. 

Upgrade:
~~~~~~~~
To upgrade, run upgrade.sql on your natasha database.

Contact:                         
~~~~~~~~
 * E-Mail: peter@ssp.st
 * Web: http://www.sorcer.cc/projects/natasha/
 * IRC: #bots.se.dev @ Quakenet