# README
#
#

welcome to GOZERBOT ;] see http://code.google.com/p/gozerbot

- you need python 2.4 or higher

- as of version 0.6.4.3 you'll need gnupg installed to be able to install 
  remote plugins.

- if you want jabber support install:

  xmpppy .. see http://xmpppy.sourceforge.net/

  debian: apt-get install python-xmpp

these steps will start you with the bot:

0) best is to make a separate user for the bot

from tar or mercurial/svn

cd into the gozerbot dir.

1) run "bin/gozerinit" .. this will make a gozerdata dir and config file
2) edit gozerdata/config .. make sure you set owneruserhost properly
3) start the bot with "bin/gozerbot"
4) if you want to run the bot as a daemon do "bin/gozerbot >> log 2>&1 &"

on debian (testing and unstable):

1) apt-get install gozerbot
2) run "gozerbot-start" .. this will run a bot in ~/.gozerbot .. you
   can provide a directory argument if you want to run the bot in another
   directory

next:

  - on first startup the bot doesn't join any channels, you will have to
    /msg thebot join #channel .. the bot wil remember channels it has joined
  - you can use the "meet <nick>" command to add other users to the bot

notes:

  - we are on #dunkbots IRCnet

  - MAKE REGULAR BACKUPS OF YOUR BOT DIRECTORY

  - see doc/BASIC for basics of the bot and doc/OPER for maintenance

database support:

- if you want mysql support install:

  MySQLdb .. see http://sourceforge.net/projects/mysql-python/

  since we use utf-8 now mysql version 5 is required for non ascii users
  
  1) create the bot database in mysql:
     CREATE DATABASE gb_db;
  2) once you've done that add mysql access rules for the bot user:
     GRANT ALL PRIVILEGES ON gb_db.* TO user@host IDENTIFIED by 'pass';
     FLUSH PRIVILEGES;
  3) init the database:
     mysql -p gb_db <  files/gb_db

- if you want sqlite support install:

  pysqlite .. see http://initd.org/tracker/pysqlite

  1) sqlite botdir/gozerdata/dbname < files/sqlite_db .. if you run sqlite 
     version2 .. use sqlite3 client if you use version3

links:

  main site - http://gozerbot.org
  blog - http://blog.gozerbot.org
  wiki - http://wiki.gozerbot.org
  plugins - http://plugins.gozerbot.org
  docs - http://gozerbot.org/newsite/docs
  development - http://dev.gozerbot.org

LAST NOTE:

check http://blog.gozerbot.org for security "need to upgrade" notices.
put a rss watcher on it ;] .. see help rss