WordReplace 1.3 README
----------------------

WordReplace is a Palace server plugin that replaces strings specified
in the configuration files. It is applied to chat messages and screen
names.

It was developed primarily by Martyn Gilbertson.

Questions about this plugin? Write to Martyn at plugins@palacebox.com
or Joseph Rock at joe@avatarpalace.net.

Copyright (c) 2003 Martyn Gilbertson. All Rights Reserved Worldwide.



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

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

WordReplace is a standard Palace server plugin. It is installed by
placing the plugin file, wordreplace.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/wordreplace.so psdata/wordreplace.txt

The parameter file is placed in /usr/local/palace/<palace-name>/psdata.

Note that WordReplace only reads this file. Therefore, it can be edited
while the server is running and reloaded with the `wordreplace reload
command to WordReplace.

The namereplace.txt and speechreplace.txt configuration files are loaded
from the main wordreplace.txt configuration file. They also can be
edited offline and reloaded using `wordreplace reload.

namereplace.txt contains the list of strings that are not permitted
in screen names. One word per line, separated by a delimiter, to
determine with what something should be replaced. speechreplace.txt
works the same way, but applies to chat messages and member created
room names.



The Parameter File
------------------

The parameters and their function:


delimiter [<character>]

"delimiter" is a parameter which can be set to any character, which is
used as a delimiter to allow the plugin to distinguish when to replace
a prohibited string.


log [on|off]

"log" is a parameter which can be set to 'on' or 'off' to provide additional
information in the PServer.log file when a string is replaced.


mroomenforce [on|off]

"mroomenforce" is a parameter which can be set to 'on,' which blocks
prohibited strings in member created rooms. Setting it to 'off' will
permit prohibited strings.


namereplace [<path to namereplace.txt configuration file>]

"namereplace" is a parameter which is used to set the path to the configuration
file. This file can be anywhere provided it is readable. If the file is not found,
WordReplace will try and read a file in the psdata folder called namereplace.txt


page [on|off]

"page" is a parameter which can be set to 'on' or 'off' to page an operator
when a string is replaced.


rank [number]

"rank" is an optional parameter that can be be set to 0-3.
0  = every one can use wordreplace commands
1  = only members wizards and gods can use wordreplace commands
2  = only wizards and gods can use wordreplace commands
3  = only gods can use wordreplace commands


speechreplace [<path to namereplace.txt configuration file>]

"speechreplace" is a parameter which is used to set the path to the configuration
file. This file can be anywhere provided it is readable. If the file is not found,
WordReplace will try and read a file in the psdata folder called speechreplace.txt



God Commands
------------

In addition to the controls provided by use of the parameter file,
WordReplace adds the following god commands to the Palace server.

`wordreplace about - display info about wordreplace.
`wordreplace help - display this message.
`wordreplace list - list wordreplace configuration.
`wordreplace list namereplace - list namereplace chars.
`wordreplace list speechreplace - list speechreplace chars.
`wordreplace reload - reload all wordreplace files.