Customizable Roster
 

Introduction:

This Mod is ideal for a Guild/Clan roster, but it is also a great replacement for the memberlist. Customize it any way you like: add or remove columns with just a few easy edits. The installer includes permission control that allows you to set which groups appear on the roster and which ones can view it. The most popular option is the ability to control advanced sorting; check it out!



Installation:

Step 0: If you are upgrading from a previous version, save a copy of your old showroster.php and rename your showroster templates (I recommend giving them an underscore prefix; Example: _SHOWROSTER). When upgrading from version, make a copy of all your templates, then revert the templates back to their default, and then uninstall the older version. Also, make sure you delete the bitfield_showroster.xml file in the /includes/xml directory; this will cause database errors if not deleted.

Step 1: Download the showroster_vX.X.X.zip file and unzip it.

Step 2: Upload the files to their correct directories.

Upload the showroster.php to the /forum/ directory.
Delete the bitfield_showroster.xml in the /forum/includes/xml/ directory (if there).

Step 3: Admincp > Plugin & Products > Manage Products > Add/Import Product

Import the product-showroster_v4.x.x.xml file.

Step 4: Admincp > User Profile Fields > Add New/Update User Profile Field

Add all the Profile Fields you plan to use and keep track of their number(s) (i.e. field6, field7, etc.).

Step 5: Admincp > Settings > Options > ShowRoster Settings

Update the settings for your roster: usergroups allowed to view the roster, usergroups that are displayed on the roster, the title and field# for each of your columns on the roster, and any of the many other settings.

Step 6: Admincp > Styles & Templates > Expand > ShowRoster Templates > SHOWROSTER, showroster_header, and showroster_userbits

You only need to adjust these if you have custom adjustments to make. Otherwise, there is no longer a need to change these.

NOTE: See installation and upgrading instructions in the included corresponding txt files.

Version Updates:

Version 4.0.0 - February 8, 2010

• Release of this hack for vBulletin version 4.0.x.
• This version works on both 4.0.0 and 4.0.1; message below for more information.

Version 4.0.1 - March 11, 2010

• Converted all code to the new vBulletin 4.x format.
• Improved sorting: Now each column will be sorting ASC and if you click on it again, it will go DESC.
• Less php and template edits. You can now set everything from the options area.
• The avatar, profilepic, birthday fields have not been added yet. I'll add them back if people show more interest in this mod.

Version 4.0.2 - March 17, 2010

• The ShowRoster Title can now be set from the ShowRoster Settings.
• Online Status indicator works again.
• Online Status indicator can now be turned off/on in the ShowRoster Settings.
• showroster_userbits template has been updated; online status and musername has been made into a table for a nicer layout.
• showroster_header template has been updated; user_name field is now centered.
• Default sorting has been added to the ShowRoster Settings.
• Made a fix to the plugin Viewing ShowRoster Location Display.
• Removed the phasegroup from the product file since the title is now set in the ShowRoster Settings. Also had to update the showroster.php file; $phrasegroups = array() part.
• Added the Last Visit/Activity column with an option to turn it off.
• Found and fixed a problem with one of the IF statements in the SHOWROSTER and showroster_header templates.
• Added the Profile Picture column with an option to turn it on; default is off.
• Added the Avatar column with an option to turn it on; default is off.
• Updated the Viewing plugin to display whatever the user enters for the title.
• TD class has been removed from the showroster_userbits template so the user data looks better for all website styles.

Version 4.0.3 - March 25, 2010

• What usergroups are displayed on the roster can now be managed from the ShowRoster Settings. This is a huge thing because now you won't need to Edit Usergroups individually and there is no longer a use for the bitfield_showroster.xml file.
• includes folder, xml folder, and bitfield_showroster.xml file removed from installation package; no longer needed.
• showroster_permissions and showroster_add phrases removed from the install file; no longer needed.
• installcode and uninstallcode for table removed from the install file; no longer needed.
• Updated the Navbar plugin to check the permissions of the access_groups and to register/render the code for the navbar template.
• Updated the navbar template to only display the Roster tab to those in the access_groups list.
• New setting has been added to the ShowRoster Settings that allows the admin to select where the Roster tab should appear on the Navbar: Left, Middle, or Right.
• Updated the Navbar plugin to check for the Roster tab location.
• Added an option to each column for the default sorting; either ASC or DESC. Changes were made to SHOWROSTER template, showroster.php, and to the install file.
• Added an option which allows an admin to set whether a column is sorted as groups or in a single table. Changes were made to SHOWROSTER and showroster templates, showroster.php, and to the install file.
• Added an option which allows an admin to filter out users from the roster if they leave a certain field blank. Changes were made to the showroster.php and to the install file.
• Added an option which allows an admin to filter out users from the roster when sorting certain fields. The users will not appear on the roster if the sorted field is blank. Changes where made to the showroster.php and to the install file.
• Many adjustments have been made to the showroster.php and showroster_header template so the new sorting option will work correctly.
• 4 stylevar vB4 variables have been fixed in the SHOWROSTER and showroster_header templates.
• The roster title has been changed around a bit and the member count has been moved to work with all browsers.
• The sorting links have been moved the mini navbar. They have been placed in a sorting options dropdown.
• The navbar plugin has been adjusted and all coding has been copied to the showroster.php file. This allowed me to use the code from the php file in the mini navbar while allowing the Roster tab to still appear in the menu (whether on the Roster page or not).
• Usergroups are now sorted in the order the id's are entered for the "Usergroups displayed on the roster" setting.

Version 4.0.4 - July 24, 2010

• All templates have been updated to work better with the vBulletin 4.x.
• CSS template has been added to help with the template updates.
• The Roster tab on the navbar can now be turned off.
• You can now choose whether to view just primary or secondary usergroups. Or just leave this alone to keep using the default of both. Check the Showroster Settings document and the FAQ post (2 posts down) for more information.
• There is now an ability to use multiple roster on a single site. Although, each roster will use the same columns. Check the Showroster Settings document and the FAQ post (2 posts down) for more information.
• Along with the ability to select usergroup ID's to be displayed on the roster, you can also select which usergroups to be blocked from using this new setting. This is for security purposes.

Version 4.0.5 - August 12, 2010

• Templates: statbits has been added for the new statistics table. SHOWROSTER has had some code added to work with the new statbits template. Small changes have been made to other templates.
• CSS template has had some new code added to address the new statistics table.
• A new option settings "ShowRoster Group Settings" has been added for use with the new statistics table.
• A lot of new code has been added to the showroster.php file to work with the new statistics table.
• The image path that is used when a user does not have an avatar has been fixed.

Version 4.1.0 - January 4, 2011

• id's and mid's are included in the sort functions.
• Allow the Roster tab to be removed.
• Allow the Roster tab to be renamed.
• Fully redid the navtab code, many times.
• Removed the stats template when sorting.
• Navtab positioning is fully controlled via the plugin; change the execution order to move its order.
• Border should now adjust correctly for all styles.

Future Releases:

Completed:
Possible Future Add-ons:

• Maybe find a way to show how the roster tab can have a dropdown menu for multiple rosters.

Main FAQ

Q: I set the "Usergroups displayed on the roster", yet none of those users are appearing! What is wrong?
A: Calm down. You probably have the following set: "Choose a field to be filtered (I.E. field7). Users that leave this field blank will not appear on the roster." Make that field blank until you are ready to use it.

Advanced Usergroup Settings FAQ

Q: What is the Primary/Secondary usergroup setting?
A: All users on your forum are placed in a Primary Usergroup. Some are also added to Additional Usergroups (membergroups). You would use this setting if you want to have your users only in Primary Usergroups or Additional Usergroups to appear on your roster. By default, both options are used. This means, if you have two usergroups shown on your roster, then a user could appear twice on the roster if they are in both usergroups. Most should not need this feature, but feel free to play with it if you like.

Q: What about using the m= function for my roster?
A: You will need to turn on the Primary/Secondary usergroup setting to use this function. This will allow you to have a default roster, and then use the ?m= function if you would like to view the roster in other ways. m=1 is used if you want to see users in both the primary/secondary groups, m=2 is used to view users only in the primary groups, and m=3 is used to view users only in the secondary groups.

Q: What is the ID usergroup setting?
A: This is the main setting that will allow you to have multiple rosters. It can be used in conjunction with the primary/secondary usergroup setting for more indepth rosters. Just add an ?id= followed by all the usergroups you want to view (comma separated), and it will display those usergroups for you. I.E. showroster?id=13,14,15,16.

Q: What about the ID usergroup block setting?
A: This setting is for security purposes and allows you to block certain usergroups from being displayed with the ?id= setting. After all, we don't want anyone to stumble across any of your private groups and have access to all the users in that group.

I'll add things here as questions come up.

Screenshots

Reserved.

wow
nice work !

Superb looking i will give this a try tonight many thanks!!

Yours looks so much nicer than mine: http://flotgaming.net/forums/showroster.php

Am I missing something?

It appears it shows the user groups based on their user group ID. Is there a way to change this? The reason I ask is because on my page, it shows the regular clan members before the admins. I'd like the admins listed first.

is there a way to select a specific usergroup out and only show that one

ie ..... showroster.php?group=301

whereas 301 is the usergroup id

Installed! Great! Easy to manage all my site members now!

Question... How do I order in which order the usergroups appear from top to bottom? www.brotherhoodofgamers.com/showroster.php

It appears it shows the user groups based on their user group ID. I hope that a future release can allow us to organize this.

The optional_changes.txt has a way for you to adjust how things are ordered. Let me know if that helps. Otherwise, describe what you want in depth and I'll see what I can think up. Make sure you give me the id's and names of the groups you are planning to use.

BTW, if you want me to look at your roster you'll need to turn on the access for unregistered. :)

Interesting. I'm sure there is a way, I just need to think on it for a bit.

I can't get to the code right now, but I'll look at it in a couple hours. I may have something in the optional_changes.txt though, so check it out. I noticed you have a field for your members steam ID's. If you can provide me with a full link to one of those, I can probably make those ID's into links for your roster. Not hard to do. Also, don't forget to update the field names of your sorting area.

Wow making all those IDS into links... that is amazing. so once you click them, it takes you to their profile page... sweet. But I think you would need a converter and I have some place where I can get a converter for them into a link...

Anyway my Steam ID is: STEAM_0:1:17768031
It should link to my profile at: http://steamcommunity.com/id/bogbouncer
What also shows up on that roster is Steam Player ID but its named as Xfire at the moment of this post by accident...will fix that, that one is: bogbouncer (as you can see its on the link after /id/

And I looked at the extra txt file.. there was nothing about making the usergroups in a certain order I believe.

Thanks.

What are you using the IDs for then? What's the use for it? The IDs need to be part of a common URL, otherwise we won't be able to create a link with those.

The ids we use as a community to identify players.. not gonna explain exactly right now..

Here is the html to convert it https://forums.alliedmods.net/showth...=60899&page=24

That's not the first post of that thread through just so you know, but I think that poster's html is the best. Hopefully you can figure out how to incorporate it so it does it automatically?

BTW I would like the actual STEAM ID to remain as numbers, just that when you click on it.. it leads them to their profile page. So basically it would convert it in the "background"

I just looked over the code and it is sorting by Title by default (alphabetically). If you want to to change it to ID, you can do that by changing something in the .php file. Those instructions are definitely in the optional_changes.txt file (#2). If that doesn't put them in the order you want, you'll need to do some special coding in there. If you look at my example, I use title and I named my titles alphabetically so they would be organized the way I want them. I then add code to rename the titles what I want. I'll provide you with the code later, but you'll need to adjust it if that's the way you want to go.

Open the showroster.php, find: if ($grouporder == '') { $grouporder = 'asc'; }
Change to: if ($grouporder == '') { $grouporder = 'DESC'; }

Cool, I think I can do something with that. I'll look into it when I can.

Sweet man, thanks for taking a step out to help me out on this and even offering it without me asking for it! Really appreciated and makes it much easier to manage our members!

Let me know when its ready.

Sorry for another post... but that thread I linked to might confuse you a bit.. so here is the actual converter! http://forums.alliedmods.net/showpos...&postcount=118

Hi Guys,

I'm hoping you may be able to help as im being really stupid and cant remember how to get this working correctly.

On the rosta i want to be able to add a piece of text in that is a url thats pre-defined i.e in field 5 i have it set to Armory Page that in their profile they just put the word Grushdeva and then on the rosta it will show "Grushdeva" but when you click on it it takes you through to www.thewebpage.com/Grushdeva.

Here is what i have got in the showroster_userbits-: <tr>
<td class="$bgclass">
$user[onlinestatus]&nbsp;&nbsp;<a href="member.php?$session[sessionurl]u=$user[userid]">$user[musername]</a>
</td>
<td class="$bgclass" nowrap="nowrap" align="center"><a href="http://eu.wowarmory.com/character-sheet.xml?r=Hellscream&cn=">$user[field5]</a></td>
<td class="$bgclass" nowrap="nowrap" align="center">$user[field6]</td>
<td class="$bgclass" nowrap="nowrap" align="center">$user[field7]</td>
<td class="$bgclass" nowrap="nowrap" align="center">$user[field8]</td>
<td class="$bgclass" nowrap="nowrap" align="center">$user[field9]</td>
<td class="$bgclass" nowrap="nowrap" align="center">$user[field12]</td>
<td class="$bgclass" nowrap="nowrap" align="center">$user[field11]</td>
<td class="$bgclass" nowrap="nowrap" align="center">$user[datejoined]</td>
</tr>

The problem i get is when you click on the name Grushdeva it just takes me to the first part of the url and doesnt add the name on the end.

I hope that makes sense.....

Can anyone tell me what ive done wrong in that code {Highlighted in red} so i can get it to recognize and add the name to the end of the url automatically from the info they fill out on their profile page?

Thanks in advance

Rob

Try this first:

If that fails, let me know and I'll do some testing.

yea that worked thanks allot Sarcoth

I looked into this a bit last night but I'm failing to understand. First, where are you getting the SteamID#. I looked all over for my SteamID# and I couldn't find it. I found my steam profile page, but not the other.

Just out of curiousity. Is there a reason you are using the SteamID# over the ProfileID? The later would only require a simple link that everyone uses and then it would grab the ProfileID for each person separately.

We use steam id to better identify our members. So is it posible to make it clickable so that once u click it, it takes you to their profile?

I think it is. I'll need to still look into it further. But, I'd like to know where you get the SteamID# from. I think it would help me understand it better.

well there are different ways to get it... we use a program.. but the steam ids are already in people's profile, they are forced to put it in when they register. so its tied to a field.

Currently im having issues with my site 4.0.2 totally f*cked it up and its all messed up.

So, you mean the SteamID# (STEAM_0:1:17768031) is generated by a program? It just seems strange to me that you do it this way. Use a program to generate a SteamID#, then you put that SteamID# into the profile field, and then you want to use more code to change the SteamID# back into your Steam profile name. What's the point? Wouldn't it just be easier to put in the Steam profile name and use that as a link?

For example, I just installed the Gamercard Blocks mod two days ago to try to understand what you are trying to do. But, there's nothing in that mod for the SteamID#, it instead just uses my steamcommunity/id/PROFILENAME. That to me seems the easier way to go. At least for the roster. My mod won't do anything special like pull in awards or groups from Steam, it would only be used to provide a link to the member's Steamcommunity home page...right?

I may still look into it more on Monday, but I just want to understand the reasoning behind wanting to use the SteamID#. Personally, I'd rather focus on making this mod better myself.

Current Plans & Status Update for this mod: I'm currently trying to make it more friendly so less edit's are needed. I'd really like to get it so you can do all the edits from the AdminCP rather than going into the code. I've converted all the template variables to the new vB4 format, so that is one thing that will definitely be done. I'd like to get the other part done too though before releasing the next version.

K not to be offensive, but why does it matter how we get it as it is pretty irrelevant?

Our site is tied to our gaming servers, so we use Steam IDS to give out admin.

Now with the steam id converter I posted earlier are you able to make the links clickable to go to their profile homepage? All I want is so once you click it, you go to their profile homepage on the steam community site.

Simple as that.

Well, I wanted to know so I could do some testing since I really don't like giving out untested code. I know a way is possible, but I was hoping to have all information in front of me before testing. I really don't want to ask again though so I'm going to pass. I have an alternative for you though that is a lot simpler and I've already tested it. Create another field and ask the users to enter their steamcommunity IDs (i.e. bogbouncer).

Then use that field to provide the link for your SteamID#. Basically, you'll still display only the SteamID#, but it will then use the other field to generate your link.

field9 = to the field number of your SteamID#. (i.e. STEAM_0:1:17768031)
field42 = to the field number of your Steam Profile ID. (i.e. bogbouncer)

Much easier. Enjoy and good luck with your roster.

Two ways.

If you want to make this permanent, then go into the showroster.php file:
Find: Replace with:
If you want to make this one of the sorting options, go into the SHOWROSTER template:
Find any of the sort fields, i.e.: Replace with:

STATUS UPDATE: I have given this mod a complete facelift. All of the old code has been converted to vB4 effectively. While trying to look for ways to do some things, I learned that a lot of vbulletin code has been changed, and because of that I was able to remove various things from mine (namely the functions). I still need to test the avatar and profilepic part, but everything else appears to be working.

My biggest roadblock right now is trying to find a way to move the permissions to an options menu rather than using the edit usergroup area. I was able to move the access permissions for that over, but I still don't know how to get the usergroups that need to be displayed on the roster moved.

I also need to get the columns moved to the showroster option menu as well as some other things I am adding. My goal right now is to make it so you don't have to do any edits to the php or the templates (unless you require something outside what the default roster does).

For those interested, I hope to have an update posted within the next two weeks.

Heres a hard question...

If I have field 5, 6, 7, 8 displayed for all "normal" users but I want only fields 9, 10, 11 showing for certain users(or usegroups) how would I go about doing this?

Is this mod working with 4.0.2?

How would i go about adding

To this roster so it shows the xbox live gamer card also ?

cheers in advance

Keep up the great work :up:

Hey how can we re-order the way usergroups are listed?
Heres mine http://www.brotherhoodofgamers.com/showroster.php

I wana re-order the way usergroups are listed top to bottom, and is it possible for me to put a centered image above each usergroup? If so how? Thanks.

I'll try to answer this one tonight.

Yes, it is working for me.

I can't swear this will work the way you want without some testing, but instead of using post.field, you should use the $user[field15].

I'll have to do some testing on it later and let you know. To be honest though, this will change completely with the update I am hoping to get out soon. I changed a lot of stuff on how things are done.

The best way to order the usergroups is by redoing them. The default code does the usergroups in order of title. You could order them by usergroupid instead, but that means you may have to redo them from scratch. The alternative is to keep it ordered by title and rename your usergroups to something like a-usergroup1, b-usergroup2, c-usergroup3. Then in the php code, you could set up a case/if statement. if title=a-usergroupa then $title=usergroupa. Then you would have to use $title in the template rather to fix the problem. I'll try to put together a how-to on how to do this once I get the update done. I need to iron out the current release right now.