Add-On Releases - UGL - Usergroup Legend (vBA Support Included)

What it does:

This plugin displays the user group color legend at the bottom of the forums index and/or in the Users Online box for those with vBAdvanced installed. Basically, this will work for people with vBAvanced as well as those without it.

This is my first vB mod and I wrote it only after a few hours of looking into how to make a plugin, so please... be nice in your comments.

How to install:

Admin CP -> Plugins & Products -> Manage Products -> Add/Import Product

Select the XML File

Import the file

IF YOU ARE USING vBA, then follow the next set of installation instructions (upload the file, make the module edit)

This mod requires a hook that doesn't exist in vBA, so I've created one myself.

Upload the file hooks_ugl.xml into your /includes/xml folder.

Now you have to add in the call to the hook.

Open the file /modules/onlineusers.php

Find:
[pre]if (!$activeusers)
{
$activeusers = construct_phrase($vbphrase['no_x_online'], $vbphrase['members']);
}
[/pre]

Add After:
[pre]
// Added by UGL module
($hook = vBulletinHook::fetch_hook('vba_cmps_module_onlineu sers_complete')) ? eval($hook) : false;
[/pre]


Configuration:

Admin CP -> vBulletin Options, User Group Legend

By default the display for vbAdvanced is turned off, so if you use vBA, turn it on here. Otherwise, configure the usergroups you'd like displayed and in what order.

How do I change the usergroup colors?

In order to change the colors of the different usergroups, you have to edit the user groups themselves, this is standard for vBulletin but some people have a hard time figuring it out (myself included at first).

AdminCP -> Usergroups -> Usergroup Manager -> Edit (next to whatever usergroup)

What you are looking for is the field: Username HTML Markup

Edit the first box and add in: <span style="color: #FF6600;">
Edit the next box and add in: </span>

Do that for each usergroup you want, changing the HTML color value to your liking.

Credits:

This mod is derived from the mod Usergroup Color Bar Legend, https://vborg.vbsupport.ru/showthread.php?p=1707616 by Atakan KOC.
Mostly all I did was add in support for vBAdvanced.

Screen Shots:

[kool_zero]

Originally Posted by kool_zero

no matter what i set in the start box and end box, i never see colors. any ideas here?

nevermind i had a bigger issue that is now resolved

[viper357]

Thanks for this, quick question, if I want to add the words "Color Legend:" at the bottom of the forums page, I assume I would need to edit the plugin code:

if (THIS_SCRIPT == "index" and $vbulletin->options['ugl_forumsindex_onoff'])
{
$activeusers2 .= '<br />';
$userbuls = split(',', $vbulletin->options['ugl_display_order']);
foreach($userbuls AS $userbul) {

$activeusers2 .= $vbulletin->usergroupcache["$userbul"]['opentag'] . '? '.$vbulletin->usergroupcache["$userbul"]['title'] . $vbulletin->usergroupcache["$userbul"]['closetag'].' ';
}
$activeusers = ''.$activeusers2 .'<br /><br />'. $activeusers; 
}

I've tried to put it in a couple of places but it is either not in alignment or it completely stops the legend from showing. Thanks.