Updated to v1.4! Please update if you got v1.1.
TuringTest Leech Monitor -- Automatic AFK/Leecher Reporting Add-On for Battlegrounds
Phobia@Dark Iron [US]
This is a mod written for anyone who's tired of having numerous permanent cave dwellers in every round of Alterac Valley. If you think that AFKing in BGs is acceptable or are proud of your own spacebar-tapping cave defense strategies, then this mod isn't for you.
This mod takes the time and annoyance out of using the new 'Report Player as AFK' functionality that Blizzard added in 2.2. It runs quietly in the background, monitors all players in the battleground, and uses a variety of metrics to determine which ones are playing, and which are just sitting idle in a corner or otherwise being useless. Whenever it identifies one of the latter type, it submits a report using the Blizzard API and notifies you that it has done so, along with a brief summary of that player's contribution statistics to explain why it identified that player as a leech. The heuristics are customizable through a config panel, and there is support for all four battlegrounds, although it is primarily intended for Alterac Valley.
--What are the rules?--
The mod is quite generous in its definition of an AFKer/Leecher, and many of the settings can be tweaked by the user.
The primary means of identifying an afker is through damage and healing done. The mod calculates the average damage and healing of the entire battleground (excluding those with a zero in this column) and compares each player's damage and healing to a percentage (modifiable, default 10%) of these values.
Because people often join a BG late, the mod also tracks the time that a player joined, and the total time that the BG has been running, to calculate the percentage of the game that a player has been present for. It also notes the percentage of the total honor gained. It then applies the greater of these two percentages to the required value, so at the default of 10% effort, if a player has only been present for 5 out of 10 minutes, and has recieved 45% of the total honor, they are only required to have 5% of the average damage and healing.
Because players often spend time defending nodes that may not get attacked, the mod tracks the location of every player and zones defined around most defense points. Any player seen within one of these zones will be credited with time spent defending them. The percentage of time they have spent defending is thus multiplied by a fraction (modifiable, default 50%) of the average damage and healing in the BG and credited to them as bonus damage/healing, even if their actual scores are zero. Thus, a person who spends 2/10 minutes defending SP GY will recieve .2 * .5 * averageDam = 10% credit, enough to not be reported.
Players are also credited with bonus effort (default 20%) for each secondary objective point they have accrued (flag caps/returns, graveyard/tower assault/defenses, etc). Thus by default even returning one flag is enough to consider a player to be contributing.
In Warsong Gulch, the flag carrier is always immune while he is carrying the flag, and accrues 'defense credit' as above while he is carrying it.
--When are reports issued?--
Since there is a finite but secret limit (per Blizzard) to the number of reports that can be issued in a given time frame, reports are only issued against players who do not already have the 'Inactive' debuff and are only reissued on 3 minute intervals.
There is by default a 3 minute (configurable) delay before the first reports are issued. This time is figured from when the gates opened or when the player in question joined the BG, whichever is later. However, there is a shorter delay of one minute (configurable) before reporting any player standing in the starting area of a BG (does not apply to WSG). This means all players have at least one full minute just to get out of the gate after joining. In Alterac Valley there is a further delay of two minutes for anyone in the center valley, and another two minutes for anyone in the opposite valley, to give everyone travelling time. In all, AV players have seven minutes from the gates opening (or from the time they joined) to either damage, heal, or defend something if they ride straight toward the enemy.
Command syntax:
/ttlm -- Displays help information.
/ttlm-config -- Displays the configuration panel.
/ttlm-listafk -- List currently identified AFKers.
/ttlm-showall -- List statistics for all members of current BG.
/ttlm-announceafk -- Announce the current AFKers in BG chat.
/ttlm-advert -- Send an advertisement for this mod to BG chat.
--How does this 'AFK Reporting' work?--
In 2.2 Blizzard added a feature to Battlegrounds whereby players who are not contributing (ie, sitting in the cave, hiding in the woods, etc) can be reported as leechers/AFKers. Once a certain number (unknown, probably around 5) of different people have reported the same player, that player will recieve a 60 second debuff. At the end of 60 seconds, they receive a permanent debuff which prevents them from recieving any further honor or tokens. It does not remove any honor they already have gotten, nor does it remove them from the battleground (yet). If the target player takes any action that would result in a pvp flag (on pve server) (healing an ally, attacking an opposing player, etc) these debuffs are immediately removed.
Because the AFK reporting system requires more than one person to report a leecher before they are debuffed, I encourage as many people as possible to run this addon. Please leave feedback regarding the accuracy of the algorithms. If you have encountered scenarios where you feel it has incorrectly identified someone as leeching, please provide details and it will be considered for modification.
--Known Issues--
Periodically, the Blizzard API for finding the location of a raid member may fail for some players, resulting in the mod stating that they are in an 'UNKNOWN LOCATION'. This happens fairly infrequently, and hopefully Blizzard will correct it soon.
Also, if you queue for multiple battlegrounds, the Blizzard API for getting the total elapsed BG time may fail when a second BG becomes ready for you to join. In this case the mod will disable itself until the API starts working again. Often joining the second BG will fix the problem. Leaving all BGs and then queueing for a new one will always fix the issue. Again, hopefully Blizzard will fix this soon.
Thanks, and have a leech-free AV experience!
Version History:
v0.1-0.3:
Pre-release beta versions.
v1.1:
Initial Release.
v1.2:
Added the ability to suppress notification of reports being sent. The Blizzard API will still generate messages, I cannot suppress these. Thanks Hobomedic!
Removed the Version Announce messages from the addon channel. Thanks Elzar!
v1.3:
Added flag support for EOTS.
Fixed bug related to loading correct mod variables after an upgrade.
v1.4:
Disabled reporting in Arenas.
Added command-line options for various features.
Corrected tower location definitions for EOTS.
Added BG Advertisement command.
Partially localized to French and German to fix certain bugs related to those locales. (Thanks Lenja!)
Installation Guide
- Exit "World of Warcraft" completely
- Download the mod you want to install
- Make a folder on your desktop called "My Mods"
- Save the .zip/.rar files to this folder.
- If, when you try to download the file, it automatically "opens" it... you need to RIGHT click on the link and "save as..." or "Save Target As".
- Extract the file - commonly known as 'unzipping'
Do this ONE FILE AT A TIME!
- Windows
- Windows XP has a built in ZIP extractor. Double click on the file to open it, inside should be the file or folders needed. Copy these outside to the "My Mods" folder.
- WinRAR: Right click the file, select "Extract Here"
- WinZip: You MUST make sure the option to "Use Folder Names" is CHECKED or it will just extract the files and not make the proper folders how the Authors designed
- Mac Users
- StuffitExpander: Double click the archive to extract it to a folder in the current directory.
- Verify your WoW Installation Path
That is where you are running WoW from and THAT is where you need to install your mods.
- Move to the Addon folder
- Open your World of Warcraft folder. (default is C:\Program Files\World of Warcraft\)
- Go into the "Interface" folder.
- Go into the "AddOns" folder.
- In a new window, open the "My Mods" folder.
- The "My Mods" folder should have the "Addonname" folder in it.
- Move the "Addonname" folder into the "AddOns" folder
- Start World of Warcraft
- Make sure AddOns are installed
- Log in
- At the Character Select screen, look in lower left corner for the "addons" button.
- If button is there: make sure all the mods you installed are listed and make sure "load out of date addons" is checked.
- If the button is NOT there: means you did not install the addons properly. Look at the above screenshots. Try repeating the steps or getting someone who knows more about computers than you do to help.
Translations
When you download a mod, please be sure that the mod is compatible with your translation of wow. Some mods only work on the US versions, while some only work on some of the various European versions. These variations are called "Localizations".
TOC Numbers (Out of Date Mods)
When Blizzard patches WoW, they change the Interface number. This means that all mods will be "out of date" unless or until the author releases a new version for that interface. Some people go into the .toc files and update the numbers themselves, but this is STRONGLY advised against as it will cause problems locating possible incompatibilities addons. When you log into WoW after a patch, you DO NOT have to delete your interface directory. All you have to do is simply tell WoW to ignore the interface numbers and load all the mods anyway. All you have to do is, while at the "character select" screen, look in the lower left corner and click on the "addons" button. A window will pop up listing all your installed mods.
If you look in the upper left corner of that window there should be a box that says "Load Out of Date AddOns". You want to CHECK this box. Now simply go into WoW normally and all your mods should load. As of the 1.9 patch, you will have to do this after EVERY patch/update that Blizzard posts! If you encounter any problems with a mod after a patch, please be sure to let the author of the mod know so they can fix it.
See also: About "Out Of Date AddOns"
Mac Support
WoW addons are not platformed based. As such, they can be used on either Mac or PC. You can extract both .zip and .rar files on a Mac using StuffitExpander.
Directory Structure
World of Warcraft
|_ Interface
|_AddOns
|_*AddonName*
|_ *AddonName*.toc
|_ *AddonName*.xml
|_ *AddonName*.lua
|_ (possibly others as well)...