Welcome to FBFBOT
=================

the fbf pakage contains the following programs:

::

    * fbf - console bot
    * fbf-fleet - mix IRC and XMPP bots
    * fbf-irc - IRC bot
    * fbf-tornado - a shell web server based on tornado
    * fbf-sleek - XMPP bot

note: FBFBOT is in very early stage of development right now and still subject to change of protocols and API.

see https://github.com/feedbackflow/fbfbot

license
~~~~~~~

FBFBOT is free code (MIT) and can be cloned where needed.

contact the developer
~~~~~~~~~~~~~~~~~~~~~

::

    * email: feedbackflow@gmail.com
    * jabber/xmpp: feedbackflow@gmail.com
    * IRC: feedbackflow on #fbf irc.freenode.net
    * twitter: http://twitter.com/feedbackflow


running a development version of the bot
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

first checkout the main bot from the mercurial repository

::

    git clone https://github.com/feedbackflow/fbfbot.git

now you can run the programs in the bin directory with the
./bin/<program>  command. try ./bin/fbf for the console app


HANDBOOK
========

.. toctree::
    :maxdepth: 1
    :glob:
                
    handbook/*

PLUGINS
=======

core
~~~~

.. toctree::        
    :maxdepth: 2

    plugins/core/index

extra
~~~~~

.. toctree::        
    :maxdepth: 2

    plugins/extra/index

db
~~

.. toctree::        
    :maxdepth: 2

    plugins/db/index

CODE
====

fbf package
~~~~~~~~~~~

.. toctree::
    :maxdepth: 1
    :glob:

    fbf/*

fbf.api
~~~~~~~

.. toctree::
    :maxdepth: 2

    fbf/api/index

fbf.db
~~~~~~

.. toctree::
    :maxdepth: 2

    fbf/db/index

fbf.drivers
~~~~~~~~~~~

.. toctree::
    :maxdepth: 3

    fbf/drivers/index

fbf.lib
~~~~~~~

.. toctree::
    :maxdepth: 2

    fbf/lib/index


fbf.tornado
~~~~~~~~~~~

.. toctree::
    :maxdepth: 2

    fbf/tornado/index

fbf.utils
~~~~~~~~~

.. toctree::
    :maxdepth: 2

    fbf/utils/index

PLUGIN CODE
===========

core plugins
~~~~~~~~~~~~

.. toctree::
    :maxdepth: 2

    fbf/plugs/core/index

db plugins
~~~~~~~~~~

.. toctree::
    :maxdepth: 2

    fbf/plugs/db/index

extra plugins
~~~~~~~~~~~~~

.. toctree::
    :maxdepth: 2

    fbf/plugs/extra/index