July 31, 2006

GuildPal 0.3

GuildPal is a World of Warcraft addon that adds two simple slash commands to your World of Warcraft interface, intended to facilitate the communication between members of a growing guild.

Download

GuildPal can be downloaded here.

Documentation

GuildPal
By Atul Varma

------------
INTRODUCTION
------------

This addon adds two simple slash commands to your World of Warcraft
interface, intended to facilitate the communication between members of
a growing guild.

--------------------
INSTRUCTIONS FOR USE
--------------------

'/gwho' is a command that searches through the guild roster's list of
online guildies using a criteria (provided as an argument), and
returns the results.  For example:

  /gwho karin

may return (if Karin is online):

  ONLINE [Karin]: Level 60 Rogue (Ringleader) - Stormwind City -
  Enchant 300/Mining 300 - Main
  1 guildie(s) total

The above display shows the obvious vital stats, as well as the
guildie's rank within the guild ('Ringleader'), and their note
('Enchant 300/Mining 300') followed by their officer's note ('Main').

Queries that hit multiple individuals will generate multiple results,
up to a maximum of 20, at which point only the number of results will
be returned.

'/gwhoall' is a command that works exactly like '/gwho', only it also
includes offline guild members in the search.  For example, '/gwhoall
karin' results in:

  OFFLINE (last online 4 hours ago) [Sleeperbank]: Level 1 Priest
  (Sergent-at-arms) - Stormwind City - OMG IM THE BOSS - Karin's alt
  ONLINE [Karin]: Level 60 Rogue (Ringleader) - Stormwind City -
  Enchant 300/Mining 300 - Main
  2 guildie(s) total

As can be seen from the above query, the most powerful part about the
GWho commands is that they don't just search the names of guildies,
but also through their note, their officer note, their class,
their zone, and their rank.

--------------
SAMPLE QUERIES
--------------

So for instance, here's some sample questions followed by examples of
GWho commands that can answer them:

Q: Are any of Karin's alts online?

A: '/gwho karin'.  This assumes that every guildie has an officer note
   that include's their Main's name.  This will find 'Sleeperbank',
   for instance, because that guildie's officer note is 'Karin's alt'.

Q: Who are all of Shikaro's alts?

A: '/gwhoall shikaro'.

Q: How many warriors are in our guild?

A: '/gwhoall warrior'.  Note that this figure may not be exact if
   there are guildies whose names are 'Dethwarrior', or their note is
   'I hate warriors', etc.

Q: What engineers are online?

A: '/gwhoall eng'.  This assumes that engineers have a note that
   includes the word 'eng' in it.

Q: How many guildies are in Ironforge right now?

A: '/gwho ironforge'.

Q: Are there any officers (Sergent-at-arms) or Emissaries online right
   now?

A: '/gwho sergent', followed by '/gwho emissary'.

------------
KNOWN ISSUES
------------

Currently, the query results may be a bit out-of-date due to the way
that guild roster information is being obtained.  Hopefully this bug
will be fixed soon.

© Atul Varma 2017