roompass 0.1 plugin README
--------------------------

roompass is a Palace server plugin that allows permitted users
to display the room's LOCKED password which was previously set
from the Room Info dialog window. It is useful if you forget
the password.



Installation
------------

The following installation instructions assume that the Palace server
has been installed in /usr/local/palace.

roompass is a standard Palace server plugin. It is installed by placing
the plugin file, roompass.so, in the Palace binary folder,
/usr/local/palace/bin, and adding the following line to the plugin
configuration file, /usr/local/palace/<palace-name>/psdata/plugin.conf:

../bin/roompass.so <switch setting>

The optional control switch "rank [0-4]" may be set using the
<switch setting> parameter.

For example:

../bin/roompass.so rank 2

will change the default rank for the `roompass command from God level (3)
to Wizard level (2). The possible ranks are listed below, with the default
rank noted in parenthesis.

0 = guest
1 = member
2 = wizard
3 = god (default)
4 = disabled



Command
-------

`roompass
Display the author password for the current room.