Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

personal distributed reactive automation

README
This project is still in the alpha stage of development!  Data
handling is reliable, but the user interface is still rough.

Please see:

  - http://search.cpan.org/perldoc?App::Wubot::Guide::Overview

  - http://search.cpan.org/perldoc?App::Wubot::Guide::GettingStarted

  - http://search.cpan.org/perldoc?App::Wubot::Guide

  - http://search.cpan.org/dist/App-Wubot/

  - http://metacpan.org/module/App::Wubot

  - https://github.com/wu/wubot

Diagrams:

  - http://github.com/wu/wubot/raw/master/docs/img/wubot.png

  - http://github.com/wu/wubot/raw/master/docs/img/multibot.png

Screenshots:

  - https://github.com/wu/wubot/raw/master/docs/img/notification_webui.png

  - http://github.com/wu/wubot/raw/master/docs/img/OsxIdle-navi-weekly.png

  - https://github.com/wu/wubot/raw/master/docs/img/WorkHours-navi-weekly.png


INSTALLATION

To install wubot, use the standard CPAN installation methods:

   perl Makefile.PL
   make
   make test
   make install

Or simply:

  cpan App::Wubot

You will probably have to create a ~/wubot and ~/logs directory.  In
the future these directories will be configurable.

Also will also need to create ~/wubot/schemas, and copy the files from
the 'config/schemas' directory into that directory.

This will really just get you up and going with the wubot core.  Most
of the plugins have been moved out of the core, and are temporarily
located in a project called 'WubotX'.  To enable them, check out the
project into ~/wubot/WubotX

  cd ~/wubot
  git clone git://github.com/wu/WubotX.git

Alternately you could check out WUbotX to another directory and
symlink to ~/wubot/WubotX.

When starting one of the wubot processes, the libraries in these
extensions directories have their library paths added to @INC.  The
libraries will only really be used if your monitor or reactor config
references one of the libraries in one of the extensions.  That being
said, if you wanted to selectively disable/remove some of the WubotX
extensions, then you could remove directories you do not want from the
WubotX directory.  Alternately you could make the directory
~/wubot/WubotX, then check out WUbotX to some other location, and then
selectively symlink just the WubotX subdirectories that you want to
enable into ~/wubot/WubotX.
  
In addition, you may need to copy schemas from the WubotX directories:

  cp -Rv ~/wubot/WubotX/*/schemas/ ~/wubot/schemas/

Eventually the WubotX plugins will be broken out into separate modules
and available on CPAN, but for the near future they will be available
on github.  Sorry for the difficulty--this is still a work in
progress.

To get the web interface up and going, see here:

  - http://search.cpan.org/perldoc?App::Wubot::Guide::WebUI

Most of the paths in wubot have not been configurable, e.g. ~/wubot.
In version 0.5.0, ~/.wubotrc has been introduced to allow the paths to
be configured.  If the file does not exist, it will automatically be
created and populated with default values and comments.  Note that
most of the WubotX extensions don't make use of this yet, so please do
not change any of the default values yet.  More is coming soon.

=head1 LICENSE AND COPYRIGHT

Copyright (c) 2011, VVu@geekfarm.org
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

- Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Something went wrong with that request. Please try again.