Chat Modifications - FlashChat Combo-Module v1.2 for vBadvanced

FLASHCHAT COMBO-MODULE FOR vBADVANCED
WITH CHAT ROOMS DISPLAYED!
Version-1.2
Tweaked by Yotsume

Last Updated: March, 2nd 2008
(Works on 3.7x and 3.6x)

###################################
# FLASHCHAT COMBO-MODULE 1.1 Changelog #
###################################
- Some minor code clean up.
- Added clear code labels to each section of the code. (for future developments)

###################################
# FLASHCHAT COMBO-MODULE 1.2 Changelog #
###################################
- Added instructions on how to include a link to FlashChat Admin in Quick Moderation block.
- Added new zip with a tweaked version of whochat.php which has be reported to address some issues when trying to install my mod on vBulletin 3.6x

Flashchat 5x: Not Compatible Yet
My mod currently does not work with Flashchat 5x. My mod uses Paul M's whochat.php. I have asked for his help in upgrading my mod to be compatible. My mod works with all versions of Flashchat 4x.

DESCRIPTION:
This is a module that contains a combination of code from several hacks all in one place to make a more complete FlashChat module for vbAdvanced. It works with the latest versions of FlashChat, vBulletin and vBadvanced. Also, optionally there are instructions for adding a module with link to your FlashChat Admin page in the zip file.

INSTALL TIME: (2-5 Minutes Max)
The install is very easy and takes 2-5 minutes max. Follow the simple instructions step by step to insure you input your information correctly.

REQUIREMENTS:
You must have: vBulletin, vBadvanced, and FlashChat installed.


FLASHCHAT COMBO-MODULE WILL DISPLAY: (see included screenshot)

1. Total number of how many people are in the chat.
2. List of usernames of the people in chat with links to their profiles.
3. The names of your chat rooms with a head count per room.
4. The names of the people in chat listed under each chat room.
5. A link to join the chat.
6. If no one is in the chat a customizable message is displayed.

INSTALLATION INSTRUCTIONS:

1. Upload the whochat.php file into your modules directory.
2. Next, you must create a new template.
3. Go to: >Admin >Styles & Templates >Style Manager >Add New Template
4. Title of the new template needs to be: adv_portal_whochat
5. You must replace the url in the code below to point to your flashchat.php file.
6. Copy the below code into the template area:
7. Next, add a new PHP file module in your vBa CMPS with the following settings:

Title: Who's Chatting!
File to include: whochat.php
Identifier: whochat
Templates used: whochat

....8. Tweak the module's permissions and click save. Your module should be active now!

<!-- flashchat userlist -->
<tr><td class="thead"><span class="smallfont">Members In Chat: $totalchatters</span></td></tr>
<tr><td class="$bgclass"><span class="smallfont">$chatters</span></td></tr>
<!-- end flashchat userlist -->

<!-- flashchat rooms and users -->
<tbody><tr>
<td class="alt2" colspan="2">
<iframe frameborder="0" height="180" src="http://www.your_domain_here.com/chat/info_embedded.php" style="width: 100%; margin: 0; padding: 0; border: 0; overflow: hidden;" scrolling="no" border="0" allowtransparency="true"></iframe></td></tr>
</tbody>
<!-- end flashchat rooms and users -->

<!-- chat link -->
<tr><td class="alt2">
<span class="smallfont"> <a href="http://www.your_domain_here.com/chat/flashchat.php" target="_blank" rel="nofollow" linkindex="51" set="yes"><u>Join the Chat!</u></a></span></td></tr>
<!-- end chat link -->

HEIGHT ADJUSTMENT NOTE:
You can adjust the height of the block by changing the value of: height="180" in the above code. Be aware that vbAdvanced blocks are fixed dimensions. So if you have many room names or many users in chat the text will run out the bottom of the block and not be visible. This is why I have the height set at "180" as a default. Adjust this value to fit the needs of your site.

############
# Future Plans #
############
- For version 2.0 of this module I plan to implement some kind of chat invitation system that will immediately notify other chosen members that you wish for them to enter the chat. A invitation window of some kind will appear containing the chat link. It would be nice if a sound would play to help alert them as well.
- In version 1x the module does not collapse fully. Rather just the members list collapses which is either a code mistake or a cool feature depending on your perspective. If you have many users in the chat having just the members list collapse might be a cool feature to leave in.
- I plan to combine into this module a link to the FlashChat Admin page and eliminate the need for a second module for that link. It needs to be coded so that only Admins can see that link.

FlashChat Admin Link in Quick Moderation Block
Here is a simple way to include a link to FlashChats Admin page inside the Quick Moderation block. I decided to put a link to the chat admin there because I have that block set so only Admins can see it. So it helps to keep the link to the chat admin secure.

Instructions:
How to add FlashChat Admin Link to Quick Moderation Block:

1. Go to >admincp >Styles & Templates >Edit Templates
2. Click on vBadvanced CMPS Templates >adv_portal_moderation
3. Find the last instance of: </td> </tr> and before it add the below link code: <a href="/forum/chat/admin/index.php" TARGET=_BLANK>Chat Admin</a></td>
4. Be sure to replace the correct path to your chat's index.php in the above link.
5. Save the template and your done!
6. See attached screenshot of the Quick Moderation block with chat admin link.

[yotsume]

My mod works on 3.7x so I decided to post it in the 3.7x Add-ons forum. If you install my mod remember to mark it as installed and vote! Post some feedback here on how the mod works for you.

[Dr. Bantham]

For me, the room text is in black and thus illegible or even invisible with some of my styles. Am I doing something wrong, or should it not adhere to a style CSS variable? This would allow it to adapt to all styles.

Also, how can I reduce the space trailing the room listing? There is a considerable amount of blank space that needlessly extends the module height.

Thanks for the work!

[yotsume]

Originally Posted by Dr. Bantham

For me, the room text is in black and thus illegible or even invisible with some of my styles. Am I doing something wrong, or should it not adhere to a style CSS variable? This would allow it to adapt to all styles.

Also, how can I reduce the space trailing the room listing? There is a considerable amount of blank space that needlessly extends the module height.

Thanks for the work!

So I have simple and not so simple answers for you.

First the simple, to adjust the height of the block is easy. You can adjust the height of the block by changing the value of: height="180" in the above code. Be aware that vbAdvanced blocks are fixed dimensions. So if you have many room names or many users in chat the text will run out the bottom of the block and not be visible. This is why I have the height set at "180" as a default. Adjust this value to fit the needs of your site.

I updated the mod instructions with these instructions.

Second not so simple answer... The color of the text is called from your default style. I believe that we would have to get PaulM involved here to solve this since he is the author of the whochat.php which is included in my mod. I will ask him for help on how the text can be altered for each style installed. I am not sure it will be possible but I will look into it and post my findings.

[LorraineMc]

This mod is great....I am what you would still call a newbie....and I followed the instructions....(which by the way...were so clearly and easily written) and it worked like a charm....WOW....something that even a non-coder could do and use....thanks
I clicked installed...

would love to see the "invite" added with a sound that would be way cool....looking forward to version 2


Thanks again yotsume for this mod and all your hard work....

I also click to nominate for mod of the month....wish more mods were done and written this asily...thanks again

[Tolas]

This is a wonderful mod, Thank you!

*Installed*

[yotsume]

Originally Posted by LorraineMc

This mod is great....I am what you would still call a newbie....and I followed the instructions....(which by the way...were so clearly and easily written) and it worked like a charm....WOW....something that even a non-coder could do and use....thanks
I clicked installed...

would love to see the "invite" added with a sound that would be way cool....looking forward to version 2


Thanks again yotsume for this mod and all your hard work....

I also click to nominate for mod of the month....wish more mods were done and written this asily...thanks again

When FlashChat makes a new release and upgrades, I will release a new version of my mod to include their new features. Proper code documentation needs to be made into rules to follow like a read me file on how to document and make instructions. This same readme for how to make instructions needs to be a standard on all forms especially vBadvanced forum. To many wasted posts and replies asking for help due to poor instructions. I am glad you like my mod. Remember to Vote.

Originally Posted by Tolas

This is a wonderful mod, Thank you!

*Installed*

Got a link to your site so everyone can see my mod in action?

[LorraineMc]

yotsume Again thank you....I love this mod and it was so easy to install...
I clicked the installed and voted this as "mod of the month"....best mod I have installed...works like a charm.

My site is Palm Coast-Info you have to be a registered member to see how the chat works and functions and your mod. (It is free to join)

I will be looking for other mods you have made and for any updates from you...

Thank you again....

I am really looking forward to your addition in your next version of

# Future Plans #############
- For version 2.0 of this module I plan to implement some kind of chat invitation system that will immediately notify other chosen members that you wish for them to enter the chat. A invitation window of some kind will appear containing the chat link. It would be nice if a sound would play to help alert them as well.

This would be the icing on the cake for this mod....(my opinion)

[Neo_obs]

any help with changing the color?

[yotsume]

Originally Posted by Neo_obs

any help with changing the color?

A few people have asked me this already. I believe the color of text is pulled from your vbulletin settings. What color is giving you a problem exactly?

Can you please give me a link to your site so I can see your scheme. I want to look into this now and post some instructions on how to tweak colors.