MGC Chatbox Evo by MtoR
Copyright 2008-forever

------------------------------------------------------------------------------------------
This Hack can't be redistributed without the author right on another website than :
http://www.vb-hacks.org/
http://www.vbulletin-ressources.com/
http://www.vbulletin.org/
------------------------------------------------------------------------------------------

WARNING :

For users which possess:
- a vBulletin 3.6 version < 3.6.10
- or, a vBulletin 3.7 version < 3.7.0 RC4

There will be a javascript error due to Jelsoft major changes ...

To make the mod work with this vBulletin version, edit the mgc_cb_evo.js file and add at the top : var SECURITYTOKEN = "0";

This is not very clean but this is the only way to make it compatible with both versions of vBulletin. DON'T DO IT IF YOU HAVE THE GOOD VERSIONS OF VBULLETIN.

------------------------------------------
Update instructions (version > 0.3.0) :
------------------------------------------

1/ Upload the files from the "Files" directory in your forum root
2/ Upload the content of the "Images" directory in each of your forum styles directories
3/ Import the MGC Chatbox Evo product
4/ Go in your admincp, in the Language manager > Download/Upload language file and then :
     - Select the language file from the "Lang" directory
     - Select the forum language to overwrite
     - Set the ignore language verison to Yes
     - Launch upload
5/ Follow the install instructions of the commands for each command that has changed in this new version (see Readme in the "Commands" folder)
6/ You have successfully completed the chatbox upgrade

------------------------------------------
Update instructions (version < 0.3.0) :
------------------------------------------

WARNING NOTICE :
In the 0.3.0 version, I have included a mean to fix the problem of having to upload again all command xml upon each chatbox update.
However, this fix needs you to remove all installed command (yes... Sorry !)

1/ Remove all installed commands
2/ Upload the files from the "Files" directory in your forum root
3/ Upload the content of the "Images" directory in each of your forum styles directories
4/ Import the MGC Chatbox Evo product
5/ Go in your admincp, in the Language manager > Download/Upload language file and then :
     - Select the language file from the "Lang" directory
     - Select the forum language to overwrite
     - Set the ignore language verison to Yes
     - Launch upload
6/ Follow the install instructions of the commands (see Readme in the "Commands" folder)
7/ You have successfully completed the chatbox upgrade

-------------------------------
Install instructions :
-------------------------------

* Step 1 : If you hadn't previously installed the chatbox, skip this step
1/ If you want to keep an archive of the chats from the previous version, download them from the archives page of the chatbox as we unfortunately have to remove them due to the incompatibility of the new version and the lack of time to write an import script.
2/ Remove all chatbox files from your forum directories
3/ Uninstall the MGC custom bitfields and MGC Chatbox products from your products page

* Step 2 :
1/ Upload the files from the "Files" directory in your forum root
2/ Upload the content of the "Images" directory in each of your forum styles directories
3/ Import the MGC Chatbox Evo product
4/ Go in your admincp, in the Language manager > Download/Upload language file and then :
     - Select the language file from the "Lang" directory
     - Select the forum language to overwrite
     - Set the ignore language verison to Yes
     - Launch upload
5/ If you plan adding the stats on the forumhome, go in your admincp and in the template manager and edit the FORUMHOME template and add the $mgc_cb_evo_stats where you want the stats to appear on your forum home.
6/ You are done with the chatbox install, you can now edit your usergroups permissions or proceed with adding commands


-------------------------------
Uninstall instructions :
-------------------------------

You must carefully follow these steps if you don't want to screw up your forum when uninstalling the chatbox.

1/ Uninstall all the commands you had installed on the forum
2/ Remove the chatbox files from your forum directories
3/ Uninstall the MGC Chatbox Evo product
4/ You're done with the uninstall


-------------------------------
Integration in IBProarcade
-------------------------------

The integration in the arcade can only be done by activating the display chatbox on defined pages in a variable (not the one under the navbar).
Here is the process you must follow to achieve this integration :
     - Go in the admincp in the "Display and Position" options
     - Activate the option "Display the chatbox on defined pages of the forum in a variable" or the "Display the chatbox on defined pages under the navbar"
     - In the pages list, add "arcade" and then validate
     - Open the arcade/functions/functions.php et search for "function do_output($output_array)"
     - After "// add additional needed variables" here, add : global $mgc_cb_evo,$mgc_cb_evo_var;
     - Finally, if you are using the "Display the chatbox on defined pages of the forum in a variable", edit the ARCADE template and add $mgc_cb_evo_var where you want the chatbox to appear


-------------------------------
Display problem in some styles
-------------------------------

On some styles, it's possible that the chatbox won't show as the automatic insertion in the templates is based on precise variables which might not be present in your style.
If you encounter this problem, follow these steps (I will take the display at the bottom of the forum home as an example but you can easily adapt it for another location causing a problem) :

     - Go in the Plugin manager of your admincp
     - Edit the "Chatbox display on forumhome" plugin
     - Replace : $search_text = '$forumhome_markread_script';
     - By : $search_text = '$chatbox_forumhome';
     - Then, go into the Style manager and edit the FORUMHOME template
     - Put the $chatbox_forumhome var before the $footer var

------------------------------------------
vBSEO custom rewrite rules
------------------------------------------

'mgc_cb_evo\.php$' => 'chatbox.html'
'mgc_cb_evo\.php\?do=view_chatbox$' => 'chatbox.html'
'mgc_cb_evo\.php\?do=view_archives&page=(\d+)' => 'chatbox/archiv/page-$1.html'
'mgc_cb_evo\.php\?do=view_archives$' => 'chatbox/archiv/page-1/'