MembersList
 |
Important note: When you edit this page, you agree to release your contribution into the public domain. |
Contents |
MembersList
MembersList is a Roster 2.0 addon for display member lists and can be used for other list using the memberslist library.
MembersList also includes Main/Alt display. It uses data set in the guild note or officer note to group together each player's characters. It has 2 main components:
- Display component. This is branched from the main member list, and shows each player's alts under his main.
- Update component. This is run if you update the guild list or characters (if configured to do so), or by entering MembersList config via RosterCP
Where to get it
MembersList is included with Roster 2.0
Installing
- Extract the zip archive locally
- Upload all files in the archive to the roster\addons\ dir on your webserver.
- Go to RosterCP->Manage Addons and click the install button for MembersList
- Once the installer is done, go to the MembersList config in RosterCP under the "Addon Config" menu on the right side
- Make the alt table update at least twice by doing either of these:
- Upload CharacterProfiler.lua with the Run 'update triggers' on guild update enabled
- Fill in the password and click the Rebuild Mains/Alts button in the bottom of the alt list.
Configuration
This is probably one of the more complex Roster addons to configure. Below are explanations of all options.
Under Main/Alt Relations
| Regex | /ALT-([\w]+)/i |
|---|---|
| Apply on field | note |
| Use match no | 1 |
| Main identifier | Main |
| No result | 0 Main 0 Mainless Alt |
| Invalid result | 0 Main 0 Mainless Alt |
| Alt of Alt | -[Set as mainless alt ]- |
| Update type | -[ Guild ]- |
These are the most important and most difficult settings. These 3 values tell MembersList how to find the alt information in the guild list info. The first is a regex pattern using the perl-compatible regex syntax used in php. PCRE reference
Basically, the ([\w]+) part signifies the 1 word in the string that contains the main name for the character. the slashes at the beginning and end of the setting signify the beginning and end of the pattern. The i after the last slash makes it use case insensitive matching, omit it to use case sensitive matching. Valid values are:
- /([\w]+)/: Matches any number of letters. Since the first possible match is chosen and made as long as possible, this is the full first word.
- Example: '(PleegWat) Dragonscale LW'
- /ALT-([\w]+)/: The first word starting with ALT-. The main's name is the part after that.
- Example: 'Alchemist ALT-Azyplagat'
- /([\w]+)'s alt/:The first word that is followed by 's alt.
- Example: 'Timmy's alt'
The second setting of these 3 signifies on what field the regex is run. Usually this is note for the public note or officer_note for the officer's note.
The third setting tells which bracketed expression is used. This is 1 in most cases.
| Main identifier | Main |
|---|
If the main name returned by the regex has this value the character is assumed to be a main. This is mainly useful if the 'first word' type matching is used; you can set the note '(Main)' for a main character.
| No result | 0 Main 0 Mainless Alt |
|---|
If the regex doesn't return a value at all, this setting defines if the char is a main or a mainless alt. For example on the second example regex, if 'ALT-' doesn't appear in the note at all this setting is used to decide if the character should be a main or a alt without a main.
| Invalid result | 0 Main 0 Mainless Alt |
|---|
If the value returned by the regex isn't a guild member's name, this setting defines if the char is a main or a mainless alt. This is set to false by default since you don't usually have mainless alts in, so characters displayed as mainless alts probably have an incorrect setting.
| Alt of Alt | -[Set as mainless alt ]- |
|---|
The value of this setting is used to decide what to do if the main of a character turns out to be an alt too.
- 'Try to resolve': Find out who that alt's main is and set the alt to be a main of that. It may not resolve correctly first time round.
- 'Leave in table': Will allow the alt of alt situation to stay in the table. This doesn't work right with the default main/alt list.
- 'Set as Main': Sets the character as main
- 'Set as Mainless Alt': Sets the character as mainless alt
| Update type | -[ Guild ]- |
|---|
This tells MembersList when to update it's main/alt relations
You can set this to update during a members update, a character update, or on both updates
Display options
Not yet available.
FAQ
Not yet available.
