Shoutbox

code:

---

.----------------------------------------.
|Audiator 3 plugin by optimism_          |
'----------------------------------------'


1. Installing
  1-1. How to install this plugin
  1-2. How to uninstall this plugin

2. Using
  2-1. What this plugin is useful for
  2-2. How to use this plugin
  2-3. How to send a sound to a contact by command

3. Advanced configuration
  3-1. How to configure this plugin
  3-2. Blocklist
    3-2-1. How to block/unblock a contact

4. Further Help
  4-1. Where you can fing more help using this plugin

5. Legal
  5-1. Copyright


Section 1 - Installing
----------------------

[1-1] How to install this plugin

This plugin comes with a nice installer to make it as
easy as possible to install. To install audiator, just
double click on the file you downloaded, and keep
clicking next until the dialog closes.
Then, restart messenger (or use a plugin reloader tool)
to activate the plugin.

[N.B.]
If you use a plugin reloader tool, such as PluginReloader
you will need to reopen the conversation window to make
the Audiator 3 menu items appear in the Plus! menu.



[1-2] How to uninstall this plugin

Should you decide that you no longer want this plugin
[and I hope that is never the case ], just complete
the following steps

1) Completely exit messenger, right click the tray icon
and click Exit to achieve this.
2) open control panel, and the add/remove programs applet
3) Find Audiator 3 in the list, and choose remove.
4) Follow the instructions, and when finished, reopen
messenger

Section 2 - Using
-----------------

[2-1] What this plugin is useful for

Using this plugin you can add your own sounds to messenger
plus! without needing to know a programming language and
create a sounds plugin yourself, which has been the case
up until now.



[2-2] How to use this plugin

The main command for Audiator3 is the
/xauconfig
command. This will open up the main dialog from which
you can control the plugin, and send sounds to your
contacts.

To send a sound, just double click the text in the first
column of the sounds list.

To preview a sound before sending it, highlight it, and
click the musical note button.


[2-3] How to send a sound to a contact by command

If you know the command for the sound you want to send, you
can send it without using the config dialog. Simply
send this:
/xau<command>
For example, to send the default sound with the command "yes"
you would do
/xauyes

You can also specify your own message to send along with the
sound, using the form
/xau<command> <message>

For example, to send the message "I agree!" and play the yes
sound, you would do
/xauyes I Agree



Section 3 - Advanced Configuration
----------------------------------

[3-1] How to configure this plugin

There are several advanced options you can configure
including whether to show error toasts or not.
To access the options pannel, you can use the command
/xAUOptions
Or you can use the Options... button on the main config
dialog. Here you can Enable or disable error toasts, or
configure the Blocklist.



[3-2] Blocklist

The Audiator Blocklist allows you to stop sounds from
certain people being played. Alternatively, you can make
Audiator allow sounds ONLY from specific people.

To open the blocklist, you can use the Blocklist...button
in the Options dialog, or use the command
/xAUBlocklist

The first option  is whether to enable or disable the plugin.
If this box is unchecked, ALL sounds will be played. If it
is checked, then the list will be checked each time.

The next option is whether to play sounds from people not on
the sounds list.
If this is checked, all sounds will be played, unless the sender
is blocked.
If this box is cleared, no sounds will be played, unless the
sender is specifically allowed.

The last option on this dialog is whether to have a prompt the
first time a new user sends you a sound.
Each time a new user sends you a sound, a dialog will pop up
asking you whether you want to allow or block this person.

[3-2-1] How to block/unblock a contact

If you want to block/unblock a contact, and prevent or allow them to
send you sounds, you can do this in 3 different ways.

1) If you know the email address of the contact, you can send the
command
/xaublock <email>
/xauunblock <email>
For example, to block/unblock the person with email address me@domaincom
you would send the command
/xaublock me@domain.com
/xauunblock me@domain.com

2) If you know the email address of the contact, you can block them
via the blocklist dialog. Either send the command
/xaublocklist
or open the config dialog, click options, and then blocklist

Here, type the email address of the contact into the textbox and click
the Add button. Then highlight them in the list, and select the
"Do not allow this user to send me sounds" option to block them
or the "Allow this user to send me sounds" option, to allow them.

3) To block/unblock all users in a conversation, simply use the command
/xaublock
/xauunblock


Section 4 - Further Help
-------------

[4-1] Where you can fing more help using this plugin

If you still require help, you can ask at:

The official osNetwork forums:
http://forums.osnetwork.sytes.net

The Messenger Plus! forums:
http://shoutbox.menthix.net/forumdisplay.php?fid=28

The official osNetwork IRC channel
irc://osnetwork.sytes.net:6667/osNetwork

The Messenger Plus! Help and Support IRC Channel
irc://irc.msgplus.net:6667/MsgPlus


Section 5 - Legal
-----------------

[5-1] Copyright

This plugin was designed and written by optimism_, of
osNetwork. You may redistribute this plugin as long as
it is packaged in the original installer file, with this
readme file unchanged.

This plugin and its source code remain the copyright of
optimism_ under the berne convention for literary and artistic works.
©2004 optimism_, optimism_ software. All Rights Reserved.

---