Profile Enhancements - Customizable Roster (Member List)

Customizable Roster (Member List)
[How to] get a working Guild/Clan Roster

Note: This modification is now discontinued - this means that while it will remain available for download and use, support will no longer be provided as the thread is no longer monitored. Please see the 3.7 release of this modification for future updates here.

Introduction:

This Mod started off as a [How to] template modification. I have since added in permission control and an installer. Those that install this Mod will need to make adjustments to two templates and one phrase depending on what you want displayed. I'll include instructions for each step as well as optional changes you can make at your decretion.

Click the following link for a Guild Roster preview: http://vanguard.sacredhaven.org/forums/showroster.php

You'll notice that I use the "Extra Profile Fields Page" by Wired1. It isn't needed for the Roster, but I think it makes the field updates look nicer for the users.


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).

Step 1: Download the attached showrosterXXX.zip file.

Step 2: Upload the files to their correct directories.

Upload the showroster.php to the /forum/ directory.
Upload the bitfield_showroster.xml to the /forum/includes/xml/ directory.
Upload the spacer.gif to the /forum/images directory if you plan to use avatars.

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

Import the product-showroster.xml file.

Step 4: Admincp > Languages & Phrases > Phrase Manager > Phrase Type: ShowRoster > showroster_title --> Edit

Change this to whatever you want as the title of your roster.

Step 5: 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 6: Admincp > Styles & Templates > Expand > ShowRoster Templates > showroster_header

This template contains the headers for each of your columns. Add/Edit/Remove columns to your preference. Be sure to update the colspan to the number of columns you have.

Step 7: Admincp > Styles & Templates > Expand > ShowRoster Templates > showroster_userbits

This template gets the data from each of the fields you want to have viewed on your roster. Add/Edit/Remove columns and/or the nowrap="nowrap" to your preference. Be sure to update each of the field#'s to match the fields from Step 5.

Step 8: Admincp > Usergroups > Usergroup Manager > Edit Usergroup

• Set "Access - Should this usergroup have access to the Showroster page?" to Yes for whatever groups you want to have permissions to access the showroster page.
• Set "Viewable - Should this usergroup be viewable on the Showroster page?" to Yes for the groups you want to have appear on the showroster page.

All instructions are included in the instructions.txt and optional.txt.

Enjoy!!!


Versions:

v1.1.3 - April 22, 2007

• Added 'Who's Online' plugin to the installer (Thanks m002.p).
• Made an update to the optional.txt file for changing the default sort.

v1.1.2 - April 20, 2007

• Added sorting to the roster. This is optional and will work without adding the sorting features.

v1.1.1 - April 19, 2007

• Small update. Just added total member count.

v1.1 - April 5, 2007 (Mod Revamp)

• Revamped everything. There is now an installer to do most of the work for you.
• The installer adds two new fields to your usergroup table. This allows you to set permissions for the showroster rather than using the showgroups permissions.
• Removed a few options from the optional.txt file since they are now a part of the mod.

v1.03 - April 2, 2007

• Added some code back to the showroster.php so join date, last activity, and usernames HTML markups could be used.
• Changed $user[username] to $user[musername] in the showroster_userbits template. This will allow HTML markups to the usernames again.
• Added instructions on how to change which usergroups appear on the Roster.
• Added optional.txt to the zip for optional changes.

v1.01 - March 27, 2007

• Changed a few variable names.
• Changed template names.
• Removed a lot of unneeded code from the showroster.php.
• Added the ability to include user avatars.
• Added a counter to keep track of how many users in each usergroup.

v1.01 - March 9, 2007

• Removed a lot of unneeded code from the SHOWROSTER template.
• Fixed a couple code problems.

v1.0 - March 6, 2007 (Initial Release)

[m002.p]

Mookie half of that is already availiable.

You just select a custom public usergroup and on the members primary usergroup check "allow users to join public groups".

Well no, the secondary usergroup would be checked for that game and then under display usergroup, change it to the primary or the game. Im sure one must work

Like i said i havent tried it, but i think in theory i know what i mean :s

[Sarcoth]

Just a quick update. Being out of work a week caused some backlog. I'm almost caught up with that, but I have been working on the sorting feature whenever I get some free time. Even though I have the sorting feature working on my site, I'm trying to get the coding down to the minimum needed. If I were to have released it last week, you would have to make numerous changes just to get it to work on your site. I've cut that down quite a bit, but you'll still need to make changes. I'm going to be releasing this as a separate mod for those that don't need the sorting feature. I really don't see it needed for everyone.

@ Mookie - Like M002.p stated, it can be done, but you'd need to rename a lot of files and coding for each game you want a roster for. I think M002.p's suggestion would be best. You'd want to have a extra profile field where the user gets to select which game he plays.

Regarding those suggestions. I use to have a paragraph suggesting users of this mod use the Extra Profile Fields Page mod. I guess I removed it when I upgraded. I'll be sure to readd it. The top two suggestions are really going outside the scope of this mod, I really don't even know where to start to make something like that work. I don't understand the third suggestion, can you elaborate?

[m002.p]

No problem Sarcoth, I cant wait for the release. Ive been on the forums visiting this thread anxiously lol!

If you need any help with testing or anything like that to relieve you slightly, my email is

All the best to you and good luck!

[Sarcoth]

SHOWROSTER - Version 1.1.1 (Manual Update)

In the meantime, for those wishing to add a total count of members to their roster, you can make the following adjustments on your own. I'm going to go ahead and update the main zip file as well for new comers. That way you could just download the new file and upload the new showroster.php file to your server. I'd recommend making a manual update to the SHOWROSTER template rather than uninstalling and reinstalling the mod. This adjustment is small.

Step 1: Admincp > Styles & Templates > Expand > ShowRoster Templates > SHOWROSTER
Find:

<td class="tcat" colspan="7">$vbphrase[showroster_title]</td>

Replace with:

<td class="tcat">$vbphrase[showroster_title]<div style="position: absolute; right:9%">Member Count: $totalcount</div></td>

You'll need to adjust the right:#% depending on what works best for your site. It represents how far from the right margin it appears. Trial and error.

Step 2: Edit the showroster.php file and upload it to the /forum/ directory.
Find:

if ($permissions['showrosteraccesspermissions'] & $vbulletin->bf_ugp['showrosteraccesspermissions']['showrosteraccess']) {
	$rosterheader = '';
	if (sizeof($groupcache) >= 1) {
		ksort($groupcache); // Alphabetically Sort Usergroups
		foreach ($groupcache AS $users) {
			ksort($users); // Alphabetically Sort Users
			$rosterbits = '';
			$usercount = '';
			foreach ($users AS $user) {
				//if ($user['field#'] != ''){  //Step 1 - If you wish to limit blank fields from appearing, remove the front two slashes and change field# to a field of your choice
					exec_switch_bg();
					$user = process_showgroups_userinfo($user);
					$usercount++;

Replace with:

if ($permissions['showrosteraccesspermissions'] & $vbulletin->bf_ugp['showrosteraccesspermissions']['showrosteraccess']) {
	$rosterheader = '';
	$totalcount = '';
	if (sizeof($groupcache) >= 1) {
		ksort($groupcache); // Alphabetically Sort Usergroups
		foreach ($groupcache AS $users) {
			ksort($users); // Alphabetically Sort Users
			$rosterbits = '';
			$usercount = '';
			foreach ($users AS $user) {
				//if ($user['field#'] != ''){  //Step 1 - If you wish to limit blank fields from appearing, remove the front two slashes and change field# to a field of your choice
					exec_switch_bg();
					$totalcount++;
					$usercount++;
					$user = process_showgroups_userinfo($user);

Rather than do Step 2 manually, you can just download the new showroster_1.1.1.zip file and upload the showroster.php file.

[Mookie]

m002.p and Sarcoth thanks for the reply. I am also waiting on the release of the column sort before installing but I will be adding this for sure (even if just for one game).

Sarcoth I was just coming up with some ideas for you incase you where a little stumped on what to try and add next. The 3rd one was more of a admin feature that would allow administrators to demote and promote users in the roster easily. But what i am understanding the primary user group has to be there game rank. The problem that I run into is with numberous games I have Members in some games and in other games they are officers. Would the secondary user group for that game allow them to be displayed in the Officer area if I have the secondary user group set to Officer of the desired game. I hope i explained that a little better. If not then I will play around with it once the new update comes out. Thanks again.

[Sarcoth]

@ Mookie

I really like suggestions since I sometimes run out of idea's on my own, so keep them coming. I might not be able to use them all though. Some things just won't work with the current code and some other things are beyond my abilities at this time. I was thinking more about the multi-game setup and I may have an idea on how to pull it off. Don't expect it for awhile though.

In regards to the 3rd suggestions, I think it is already very easy to promote/demote users. The roster doesn't just look at the primary groups, it looks at primary and/or secondary. On my forum, all my users are in the registered primary usergroup except for myself and my officers. I am in the guild leader primary group and my officers are in the guild officers primary usergroup. I use my member and recruit groups as secondary groups and change my users to those groups as needed. So, as you can see, my roster mod makes use of all groups. It will only show the groups you ask it to show. If I changed the registered user group to appear on the roster as well, you would see many users appear in the member group and the registered user group; they would appear in both.

So, if you wanted to use this roster for multiple games. You could have secondary groups for each game + ranking. For example, Vanguard - Member, Vanguard - Recruit, EverQuest - Member, Everquest - Recruit, WoW - Member, WoW - Recruit. Then every user would appear in their correct group and you would only have to use one roster page.

I hope I understood your question.

[Sarcoth]

I made a small correction in the SHOWROSTER - Version 1.1.1 (Manual Update) as well as the main download.

It seems I was telling you to use showroster_sort_title in the SHOWROSTER template when it should have been just showroster_title. The showroster_sort_title is something I'm using on my test sort page.

BTW, another small update on my progress. I figured out a way to add the sorting to this mod without creating a whole new one. I will be adding the sorting as a optional change rather than forcing it on everyone.

[Sarcoth]

<font size="3">SHOWROSTER - Version 1.1.2 (Manual Update)</font>

I found it easier to add the sorting than I originally thought. So, rather than make a new version of this mod with sorting, I was able to just make the sorting optional. The code will already be placed in the showroster.php file so all you have to do is edit the SHOWROSTER template to get the sorting to work.

Step 1: Download the new showroster_v1.1.2.zip file. Unzip it and upload the showroster.php file to the /forum/ directory.

Step 2: Read the Optional.txt file and follow the instructions for #1; editting the SHOWROSTER template.

----------------------------------------

Those of you less code savey may want to uninstall the last version and just reinstall the new product-showroster.xml file. If you go that route though, you'll still need to make updates to the templates if you have made changes to them. Let me know if you have any problems.

Enjoy!

[m002.p]

Great work mate. Im on the case of upgrading it

Thanks for your time and one of the best clan hacks out there

[m002.p]

Hmm ive just installed and get this:

http://www.sog-team.co.uk/forum/showroster.php

It appears the "<" correspond to the usergroup member count :s

Any ideas?

BTW also the member count is not in the header correctly; am I correct in thinking that this "right%" is only to adjust the alignment of the total count text? Im guessing some code is set incorrectly here :s

EDIT: I think the "showroster_sort_title" isnt correct. The phrase doesnt appear on the roster as it is not in the phrase manager.

Thanks

Matt