.. _readme:

GOZERBOT 0.99.x README
======================

welcome to GOZERBOT ;] see http://gozerbot.googlecode.com

These are the 99 series, which means that i am heading for a 1.0 release.
This also means that GOZERBOT is going into feature freeze etc. etc.

If you find any bugs please report them on:

http://code.google.com/p/gozerbot/issues/list

or join us on #dunkbots irc.freenode.net ;]

0.99.x Requirements 
~~~~~~~~~~~~~~~~~~~

    * a shell
    * python 2.5 or higher
    * sqlite3 (already in 2.7)
    * optional is SQLAlchemy support - enable this in gozerdata/mainconfig
      (set db_driver to "alchemy")

quick run
~~~~~~~~~

    !! make a separate user and group for the bot !!

    * wget the latest code from http://gozerbot.googlecode.com/
    * untar it
    * cd into the bot dir and run the following:

      * IRC

      ::

        ./bin/gozerbot -o <userhost of the owner> -s <server> -c <\#channel>

      notice the \ thats for escaping the # in the channel name

      * Jabber / XMPP

      ::

        ./bin/gozerbot -t xmpp -o <JID of the owner> -u <bot JID> -p <pass>

    * this creates the necesary directories and config files .. after
      checking if the bot runs fine you can run the bot in daemon mode with
      ::

        ./bin/gozerbot >> logfile 2>&1 &

      gozerbot-start is for globally installed bots running from ~/.gozerbot (debian and freebsd)

    * you can also edit the gozerdata/mainconfig and gozerdata/fleet/default/config files


next
~~~~

    * you can /msg the bot !join #channel to let the bot join channels, the 
      bot wil remember channels it has joined
    * you can use the "meet <nick>" command to add other users to the bot, if 
      you are not in a channel or conference use:
      ::

          !user-add <username> <host or JID>

    * gozerplugs plugins will not be loaded on default. use !reload <plugin> 
      to enable a plugin. see the !available command to see what plugins can 
      be reloaded
    * when using commands in a /msg use --chan <channel> to let the command
      operate on a channel .. default channel in a /msg is the users nick
    
plugin configuration
~~~~~~~~~~~~~~~~~~~~

    * plugin config can be done with the <plugname>-cfg command
      usage:
      ::

        !<plugname>-cfg                   ->      shows list of all config
        !<plugname>-cfg key value         ->      sets value to key
        !<plugname>-cfg key               ->      shows value of key
        !<plugname>-cfg key add value     ->      adds value to list
        !<plugname>-cfg key remove value  ->      removes value from list
        !<plugname>-cfg key clear         ->      clears entire list
        !<plugname>-cfgsave               ->      save configuration to disk

    * or edit gozerdata/plugs/<plugname>/config

notes
~~~~~

    * we are on #dunkbots Freenode

    * MAKE REGULAR BACKUPS OF YOUR BOT DIRECTORY

    * see http://gozerbot.googlecode.com for the bot's documentation

    * if you want to email me use bthate@gmail.com

links
~~~~~
::

    main site - http://gozerbot.googlecode.com
    blog - http://botfather.blogspot.com
    docs - http://gozerbot.googlecode.com
    source - http://gozerbot.googlecode.com/hg
    twitter - @botfather
