Lingresident 1.1

This is a set of scripts for those who want to appear a "resident" on Lingr.
If you have no idea what Lingr is for, please see http://www.lingr.com.


=== How to use Lingresident ===

At the very first time and/or when you want to tweak configuration for
rooms or plugins, you need to run this script with "--setup" option so
that you configure various parameters.

  $ ruby lingresident.rb --setup

You can set the password for protected rooms, specify the nickname for
each rooms, ignore 'radar' for paticular rooms, disable plugins, etc.

Once it's configured properly, it will connect to Lingr and automatically
start joininig the rooms on your Radar unless otherwise configured and
rooms marked as 'always'.  Then, you will lingr around there ;-)


=== Plugins ===

Adding your own bot script for Lingresient is very simple.  You write
a ruby script and place under 'plugins' directory.  Please note that
all plugins are disabled by default.  If you want to automatically enable
some of them, please do the 'setup' and and type 'enable' for desired ones.

If you want to enable some of them only when you want to use it, you can
enable them on Lingr.  Typing "!enable PluginName" will do.

  !enable irb

If you don't remember each plugin names, type "!list" to list all of them.

There are some of somewhat useful plugins included.  Please play with them
to see how they work.  If you know ruby, you can write a bot easily.  If
you don't know ruby, it's time to learn :-p


=== Commands ===

There are a series of online commands to control Lingresident.  All
system commands start with exclamation mark '!'.  For example, typing
"!help" shows what you can do with Lingresident.  Lingresident only
reacts to commands of masters, not others.  So, please make sure you have
logged in with the same account that runs Lingresident and you are in the
same room and in the group of masters, of course.

  !loglevel debug


=== Masters ===

Most of system commands can be invoked by masters only.  A master can
promote or demote others so if you have someone who you can trust, you
can give him or her privileage to act as a master.  Other ordinally
uses are allows only few commands such as !help, !list and !version.


=== Multiple Instances ===

If you are going to run more than one instances of Lingresident, you can
identify each of them by giving its instance id by command line option:

  $ ruby lingresident.rb -i hawaii

and you can add '@id' to each command to distinguish each instance like:

  !version@hawaii


=== Disclaimer ===

Lingresident is a free software with ABSOLUTELY NO WARRANTY under the terms
of Ruby's license.


=== Lingr rules ===

If you have a question or a suggestion or whatever you need to tell me,
please find me at http://www.lingr.com/room/lingresident.

Happy Lingr around! :-)


