/*======================================================================*\
|| #################################################################### ||
|| # vBShout: AJAX-enabled Shoutbox for your forum users!      	      # ||
|| # ---------------------------------------------------------------- # ||
|| # Copyright 2010 DragonByte Technologies 			      # ||
|| # http://www.dragonbyte-tech.com - http://www.dragonbyte-tech.net  # ||
|| # All Rights Reserved.                                             # ||
|| # This file may not be redistributed in whole or significant part. # ||
|| # ---------------------------------------------------------------- # ||
|| # http://www.vbulletin.org/forum/showthread.php?t=                 # ||
|| #################################################################### ||
\*======================================================================*/

/*======================================================================*\
|| Table of contents                                                    ||
||  1. License                                                          ||
||  2. Requirements                                                     ||
||  3. First Time Installation / Upgrade 	                        	||
||  4. Available Commands		 	                        			||
\*======================================================================*/


/*======================================================================*\
|| 1. License                                                           ||
\*======================================================================*/

vBShout is released under the All Rights Reserved licence.
You may not redistribute the package in whole or significant part.
All copyright notices must remain unchanged and visible.
You may provide phrase .xml files for other languages on any site,
but you may not provide the full product .xml file - only the phrases.


/*======================================================================*\
|| 2. Requirements                                                      ||
\*======================================================================*/

vBShout requires at least vBulletin 5.0.0
It will not function correctly in vBulletin 4.x.x because this is a
vBulletin 5 mod.


/*======================================================================*\
|| 3. First Time Installation / Upgrade                                 ||
\*======================================================================*/

1. Upload all files from the "upload" folder to your forums directory.

2. CHMOD the /core/packages/dbtechvbshout/aop folder to 0777

3. In AdminCP -> Plugins & Products -> Manage Products -> Add/Import Product
in the "OR import the XML file from your server" put

./packages/dbtechvbshout/xml/product_dbtechvbshout.xml

4. That's it! You can enable the Site Builder and drop the widget wherever you want.


/*======================================================================*\
||  4. Available Commands		 	                        			||
\*======================================================================*/

/pm Username; Text
	Sends a PM to Username, saying Text

/prune
	Removes all shouts in the Shoutbox

/editsticky
	Allows you to edit the Sticky Note

/removenotice
/removesticky
/sticky
	Deletes the Sticky Note

/me Text
	Shows *Username Text*

/ignore Username
	Ignores a specified user

/unignore Username
	Removes ignore from a specified user

/notice Text
/setnotice Text
/sticky Text
/setsticky Text
	Sets the Sticky Note to Text

/ban Username
	Bans a specified user

/unban Username
	Unbans a specified user

/invite username
/chatinvite username
	Invites an user to the chat room you're currently viewing