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)

[VenomMaster]

Hi m002.p,

Originally Posted by VenomMaster

[...]I use this on my site (http://www.kommando-xiv.de/board/showroster.php), and now i tried to integrate my Award System with this. [...]

I wrote something other than i meant... Actually it's not my Award system, i'm using the YAAS 2.14, found here.

[Sarcoth]

Originally Posted by Sarcoth

Not that I really mind someone linking a similiar MOD from mine, but can you tell me which post someone requested that? I couldn't find it. I think to make things fair, you could put a link to my hack in yours.

BTW, thanks to Finger, I found a small problem in my hack. If you are using the Optional Step #3, the sorting doesn't work the way I want it to. So...I will be making an upgrade to the hack. If you aren't using the Optional Step #3, then you have no need to upgrade. It's just to fix a small piece of coding. I'll get something posted next week.

I went through my code, made a lot of tests and have come to the conclusion I can't fix the problem. I shouldn't really call it a problem, it's more of an annoyance. The annoyance only occurs when trying to use sorting and Optional Step #3. If you have a your roster set to ignore people missing a certain field, the roster may show an empty group when sorting.

This will really only be a problem when a user completes all fields except for the one you require. If you sort by a field they completed and they are the only one in that group, a group header for that field will show, but it will be empty. It's hard to explain since a lot of variables have to be in place. It will probably be rare anyhow, so it isn't an issue. The only fix I could come up with caused a much bigger problem, so I came to the conclusion that I should just leave it as is.

I will be reposting the current version with an updated optional.txt file, nothing worth alerting everyone.

[Shana]

Mine isn't showing up the list for some reason? o_O. Everything else works.

[Shana]

By that, I mean that when I go to my page it's just an empty layout page (the layout of my normal board). There's no roster or anything; I don't think I've done anything wrong? I left the showroster.php as is, nothing was changed and no additional things were put on.

[Sarcoth]

If the page is just an empty white page, that usually means the showroster.php is not seeing the correct template. Can you verify that the SHOWROSTER template is in your style's and templates.

[Shana]

It's not an empty white; it has my forums 'template'. Like, the background, header, footer, etc. It even had the title that I put and the box with the title (as normal forums do for the boards). Just the roster isn't showing up.

[Sarcoth]

@ Shana - First thing that comes to mind is that you haven't set permissions for your group to view the page. You have to set which groups appear on the page and which groups have permissions to view it.

If that doesn't fix it, please give me a link to the page. Maybe just looking at it will give me a clearer idea.

If that does fix it, please click install for future assistance.

[Shana]

Sorry, I forgot to press install; I usually do. Thanks for the support even tho I didnt :P.

Anyways, I set the permissions for sure. The link is www.knightsofmaple.com/forum/showroster.php

Thanks.

[Halfhearted]

Awsome Hack.

1 Question tho, in LOTRO, you have 5 characters (10 with 2 accounts) with 3 professions with 5 levels per profession. Anyway to make this work? I know currently you would have crap loads of fields and wont sort by profession because of different profession fields.

What I am looking for is that Admin's add the character names and the members change their professions and profession levels to suit.

Thanks in advanced for any replies.

[Sarcoth]

Originally Posted by Shana

Sorry, I forgot to press install; I usually do. Thanks for the support even tho I didnt :P.

Anyways, I set the permissions for sure. The link is www.knightsofmaple.com/forum/showroster.php

Thanks.

Without being able to see the templates myself, the only thing I can think of is that the roster is clashing with another hack. It looks like you are using a lot so that is possible. You can test that theory out by disabling the other hacks one at a time just to see which one may be the culprit.

Other than that, have you made any changes to the showroster.php file? Can you upload it for me either way. I'd just like to look it over. I'll look over my code and try to come up with something.