
  Recap 3.58

This AddOn will track and summarise the damage dealt and received by every participant in a fight around the user.
Currently being maintained by Hawksy.

__ New in 3.58 __
- Added a shift+click report from the totals row on All Fights and Last Fight
  - Includes two summaries for friendly and non-friendly combatants
- Added a button on Options/Data Sets to save the Last Fight
  - (this allows you to later load in a single fight for examination)
- Added a button on Last Fight panel to hold the panel at the end of the fight
  - (gives you time to examine or save the Last Fight)
  - (Recap continues to track fights in the background)
  - (click to resume automatic updating of the Last Fight panel)
- Minor fixes, and added a program file integrity check
- Please see the FAQ section in readme.txt for additional information.

__ New in 3.57 __
- For patch 2.05.
- Fix for deaths not being recorded for the player.
- Repair for miscalculation of Tick counts and averages.

__ New in 3.56 __
- Fix for some postings going to 'say' rather than to the chosen channel.

__ New in 3.55 __
- Updated toc for patch 2.03.
- ParserLib 1.1 (r24418) is now separate, and is a required dependency.
- A number of improvements to posting.

__ New in 3.54 __
- Added option to remember recent damage and healing events.
  - Post recent events to chat for a combatant.
  - Post recent events to chat for a combatant's spell or ability.
- Added option to record only for the player (and pets).
- Added additional duration and "per second" information.
  - Separate duration for damage received for each combatant.
  - Separate duration for healing done for each combatant.
  - Damage received per second ("DPS In") shown for each combatant.
  - Healing done per second ("HPS") shown for each combatant.
- Added option to set combat event logging range to maximum.
- Added hotkey support for several kinds of reset.
- Improved tracking of initial hits for HoT spells.
- Repair for some misreported HoT spells (e.g. Siphon Life).
- Posting to a chat will post to the console if no chat edit box is open.
- A number of other improvements and fixes.
- A command-line option to automatically screenshot unexpected events.

__ New in 3.53 __
- Modified to include ParserLib 1.1 (r21077).
- Fixed battleground name problem.
- Incoming detail now separates non-melee hits and non-melee ticks.
- Increased the size of the outgoing detail scroll box to six lines.
- A number of other fixes.

__ New in 3.52 __
- Several fixes.

__ New in 3.51 __
- Added ability to sort "Spell or Ability" panel by any column.
- Fixed a typo that prevented Recap storing information about misses.

__ New in 3.50 __
- This version by Hawksy (on Elune)
- Recap is fully updated for the WoW 2.01 patch with many assorted fixes.
- In addition I have made a few minor improvements:
  - Healers now do not have to deal or receive damage before showing up in Recap.
  - The personal details panel ("Spell or Ability") now shows heals at full
	value.  The main panel ("All" or "Last Fight") continues to show the actual
	net healing and the overhealing percentage.
  - Friendly hit points are now gathered at the start of a fight as well as at
	the end so that the overhealing numbers will be slightly more accurate.
  - Faction icon and Level number are now no longer overlaid.
  - Some fields are wider so that text will be truncated less often.


The following documentation lists only the changes since version 3.32.  For earlier documentation please see readme_332.txt.

__ Usage __

New: In the Personal Details view you can sort each column by clicking its header. Click it once to sort by descending values or click again to reverse directions.

New: Faction icon and Level number now have separate columns.

New: You can shift+click on the totals row for the All Fights and Last Fight panels.  A pair of summaries is generated, one each for friendly and non-friendly combatants.

__ Details Panel __

New: The Personal Details view now shows healing at full value, while the fight panels continue to show actual healing (actual healing = full healing - overhealing).

New: The Damage tab of the details panel now shows six lines of information.  The Tanking tab of the details panel now shows the number of ticks of non-melee damage.

__ Memory Use __

Versions 3.50 and higher are a bit less memory-efficient than version 3.32, since to avoid some 'nil' problems there is less reuse of tables.  Use of the new Recent Event Mode setting will use significantly more memory.

__ FAQ: Healing __

Q: Do pure healers now show up during a raid?
A: Yes, healers now show up on the list of combatants as soon as they heal, not just when they give or receive damage.

Q: Is the calculation of overhealing more accurate?
A: Yes, the reporting of overhealing should be more accurate since Recap now checks health (for party and raid) at the beginning of a fight as well as at the end of a fight.

__ FAQ: Damage Per Second __

Q: Does Recap calculate DPS In (damage per second done to a combatant) and HPS (healing per second)?
A: Yes, separate durations are now kept for each combatant for damage done, damage received, and healing done.  DPS, DPS In, and HPS are calculated using the corresponding durations.  You can now see the raid's total DPS done to a boss in the "DPS In" column for that boss.

Q: Why does Recap show only one Time column?  And what Time is shown?
A: The Time column that is displayed is the duration for damage done.  The damage received and healing done durations are stored but not shown.  A combatant may show up on the All Fights panel or the Last Fight panel while having a Time of zero.  This will be because their Time In or Time Heal (not visible) will be long enough for them to be shown.

Q: Why is the Recap DPS calculation especially good for groups and raids?
A: Because DPS classes are not penalised on the DPS calculation when they wait for the tank to gain aggro.  "Wait for 3 sunders"?  No problem.  Their DPS for the fight will be based on the time of the individual combatant's first and last attacks.  The DPS+ column will continue to show DPS based on the overall duration of the fight.

Q: Why do the DPS In and HPS figures for "All Fights" seem too low?
A: Until the fights are reset, the new durations for DPS In and HPS for "All Fights" will not be accurate for combatants carried over from a version prior to 3.54.  The DPS In and HPS figures for "Last Fight" will be accurate.

__ FAQ: Event Recording __

Q: Does Recap remember recent events?
A: Yes, there is now an options setting "Recent Data Mode" that remembers up to 2000 recent damaging or healing events.  Warning: Use of the Recent Data Mode can take a lot of memory, and can slow down Recap.  Note that Recap starts fresh every time you log in or reload your UI, so if you want to examine recent events do so before logging out.

Q: How do I post the recent Incoming damage or healing events for a combatant?
A: If you shift+right-click on a combatant on the "All Fights" or "Last Fight" panel, then recent Incoming events for that combatant will be posted, either to a chat if you have a chat edit box open, or to your own console.  This feature allows you to check in detail the last moments of a boss or of a main tank.  Be restrained about posting to shared channels, as there will often be very many lines that will overfill the chat window (which shows only 128 lines).  If you expect to need to examine more than 128 recent events, you may need a chat logging addon to save the chat to a file.

Q: How do I post the recent Outgoing damage or healing events for a combatant?
A: If you control+right-click on a combatant on the "All Fights" or "Last Fight" panel, then recent Outgoing events for that combatant will be posted.  This feature allows you to check the spells and abilities used by a boss during the last stages of a fight.

Q: How do I post the recent Outgoing damage or healing events for a particular spell or ability for a combatant?
A: If you control+right-click on a spell or ability on the "Personal Details" panel for you or on the "Outgoing Details" panel for a combatant, then recent Outgoing events for that spell or ability for that combatant will be posted.  This feature allows you to see (when you examine the timestamps) the time between uses of a spell or ability by a boss.  The timestamps show minutes, seconds, and tenths of a second.

Q: Can I annoy people by posting huge lists of recent events that fill up people's chat windows?
A: Unfortunately yes.  There is no easy way for Recap to decide which chat channels to exclude.  Recap will refuse to post recent events to the channels Yell, General, Trade, LocalDefense, WorldDefense, and GuildRecruitment (and corresponding French and German channels).

Q: Can I also see recent buff, debuff and debuff removal events?
A: No, Recap does not currently track buffs, debuffs, or their removal, only events that result in damage or healing.

__ FAQ: Last Fight Examination and Saving __

Q: Can I save the information for a single boss fight?
A: Yes, on the Options/Data Sets panel you can now save the Last Fight as well as All Fights.  This allows you to later load the data for a single fight for examination.

Q: Can I force the Last Fight information to stay around long enough to save?  Sometimes after a boss fight someone kills a toad or heals a friend, and this new 'fight' replaces the boss fight information before I have had a chance to examine it or save it.
A: Yes, Recap has a new feature to temporarily suspend the automatic updating of the Last Fight panel, and to hold one fight on view indefinitely.

Q: How does it work?
A: There is a new button on the Last Fight panel labelled "Hold".  The Hold button can be clicked before (or even during) the fight that you want to have held.  The button changes to "Waiting", and at the end of the fight the Last Fight panel will be held for you.  The button changes to "Resume".  When you have finished examining or saving the Last Fight, click the Resume button.  Recap will resume automatic updates to the Last Fight panel, and the button changes back to "Hold".

Q: Am I losing fight information while the Last Fight panel is being held?
A: No, Recap will continue to track fights in the background.  However, there is a drawback.  If more than one fight takes place while the Last Fight panel is being held, Recap will treat all fights that are tracked in the background as one long fight.  Durations will be longer than expected, and calculated "per second" values will be lower.

Q: What can I do to keep durations and per second values as accurate as possible?
A: If the Last Fight panel is being held, click Resume as soon as possible.  If the Last Fight is being held, then the Last Fight panel will pop up every time a fight ends, as a reminder, until you have clicked the Resume button.

Q: Why do I have to remember to click the Hold button before the fight, and to click the Resume button after I've examined or saved the data?
A: Because I haven't figured out, at least not yet, how to have Recap do it automatically in a way that would satisfy almost everyone.

__ FAQ: Misc ___

Q: What additional information is available from ParserLib that Recap is not yet tracking?
A: Recap does nothing with the isGlancing, isSplit, amountResist, and amountAbsorb information.  Recap does not track all types of miss (absorb, dodge, miss, and parry for melee) (absorb, immune, and resist for non-melee).  Recap does not track the 'element' (e.g. Fire) for a spell.

Q: Does Recap track self-inflicted damage?
A: Yes, Recap now tracks effects like "You suffer 87 Fire damage from your Hellfire".

Q: Why are there fewer healing ticks than damage ticks for some dual damage/heal effect?
A: When a hit or tick from a dual damage/heal effect kills the target, Blizzard chooses to award no healing rather than to calculate an appropriate partial healing.

Q: Can I bind hotkeys for resetting Fights and Personal Details?
A: Yes, check the "Key Bindings" on the Blizzard Main Menu.

Q: Why doesn't Recap record damage and healing for my shaman totems?
A: Blizzard's combat messages (e.g. "<totem>'s <effect> hits <victim> for <damage>") give no indication as to who owns the totem, and so Recap cannot credit the damage or healing to anyone.

Q: Can I collect information for just me and my pets?
A: Yes, there is a new options setting "Self Data Mode" that will keep information only for you and your pets.

Q: Is there anything I can do while waiting for Recap to get a raid sync ability?
A: Yes, try the Maximum Combat Event Range option.  Using the maximum range means that Recap will receive combat events from an area about ten times larger than normal.  This should be enough to record everything during fights in instances.  It won't be enough in a battleground, nor for folks who get out of range (for example, by releasing after death).  It could slow Recap down.  It seems to have worked fine for me in battlegrounds and in AQ20, but it hasn't had a lot of other testing in instances.  Because this option sets some global values it might conflict with other addons.

Q: What's the most obscure feature of Recap?
A: Perhaps the four extra columns available on the Outgoing Details popup panel, because you can only see one column at a time.  Right-click on the column header to get a menu to select one of the other columns.

Q: Will Gello be taking over maintenance of Recap again?
A: You'd have to ask Gello.  If Gello wants to have Recap back, I'd be delighted to return it into those excellent hands.

Q: How can I help record rare and unexpected events to help improve Recap, and perhaps ParserLib?
A: In a chat box type "/recap snap on" (with "/recap snap off" to turn it off).  This is an effort to record a) unexplained damage events that do no damage, b) unexplained healing events that do no healing, c) duplicate combatants and effects getting past ParserLib, and d) unexpected output from ParserLib.  Recap posts some diagnostic information to your personal chat, and if the "snap" option is "on" Recap then triggers a screenshot.  There will be a screenshot 'clunk' sound, and a yellow "Screen Captured" message in the middle of your screen.  The screenshot(s) will be found in your "World of Warcraft/Screenshots" folder.  If you can, please zip them up and email them to me at hawksy@telus.net.  When these events are understood there will be no more need for screenshots.  The "snap" option starts "off" after every reload, so you'll have to remember to turn it on.  You can still capture a screenshot manually in the usual way if you have the "snap" option turned off when one of these unexpected diagnostic events occurs.

Q: I found a bug!
A: You can contact me via the wow.curse-gaming.com comments section for the addon, or email me at hawksy@telus.net.

Revision history:

3.58, 2007-01-26 - Added click-reporting from the totals line for All Fights and Last
	Fight, including separate totals for the non-friendly combatants (not otherwise
	available); added a button on Options/Data Sets to save the Last Fight; added a
	button for holding the Last Fight panel so it can be examined or saved; fix for
	an over-enthusiastic attempt to round percentages (reported by jjacko); added
	a simple integrity check for program files.

3.57, 2007-01-15 - Fix for deaths not being recorded for the player (reported by
    LostHero); repair for miscalculation of Tick counts and averages (reported by
    jjacko); added a Ticks element to Details to minimise future confusion; some
    cleanup in preparation for localization.

3.56, 2007-01-12 - Fix for some postings going to 'say' rather than to chosen channel
	(reported by xenmal); format changes to the Options/Reports panel.

3.55, 2007-01-10 - ParserLib is now a separate folder; updated toc to patch 2.03;
	a number of improvements to posting, including sorting Personal Details columns
	when posting by column, and crediting "Recap" for all posts; separated
	"Write to WOWChatLog.txt" into Open, Report, and Close buttons.

3.54, 2007-01-06 - added hotkey support for "Reset All Fights", "Reset Last Fight",
	"Reset Personal Details", and "Reset Fights and Details" (suggested by Knifed);
	added separate durations for combatants for damage dealt, damage received, and
	healing done; added "HPS" (healing per second) and "DPS In" (damage received
	per second) columns to the main fight lists; added "HPS" and "DPS In" on the
	popup Summary; restored Recap's ability to remember selected combatants between
	"All Fights" and "Last Fight" lists (thanks to a report by Phaelon); fix for
	the healing half of dual damage/healing DoT/HoT spells (such as Siphon Life)
	being incorrectly reported via ParserLib as non-HoT effects; replaced
	SPELLCAST_START events with UNIT_SPELLCAST_SUCCEEDED events; added option to
	collect data only for player and player's pets (suggested by TheRealAgro);
	investigated some of the zero-healing events and will no longer issue diagnostic
	messages for them (nor for similar zero-damage events if any occur) (reported by
	LostHero); added option to remember recent events, and to post them to chat
	filtered by combatant and spell or ability (suggested by Elsia); added option
	to set combat event logging range to maximum (suggested by Zamolxis); fixed a
	problem with merging pets with owners (existing merged information may be
	inaccurate); every posting field (any field that responds to shift+click or
	control+click) should now post to the player's console if a chat edit box is
	not open; fixed a bug where pet owners might not show up on the "Last Fight"
	panel while they had "Merge Pets with Owners" turned on; added confirm
	dialogs for the Resets on the Last Fight panel.

3.53, 2006-12-28 - modified Incoming details to separate non-melee hits and
	non-melee ticks; increased size of scroll box for outgoing details to
	six lines; added German recognition of duplicate "<spellname> kritisch";
	fixed a bug that would occur if the first event for a previously unregistered
	combatant was a miss; fixed a bug at Recap 3590 (reported by Anari); modified
	Recap to include ParserLib; fixed duplicate "<combatant>'s <spellname>" for
	healing; fix to calls to UnitName (which fixes the battleground name problem,
	broken since patch 1.12, although Recap will combine two combatants with the
	same name from different realms); fixed some issues with tracking misses;
	added a debugging feature to copy everything received from ParserLib to
	WOWChatLog.txt.

Notes for 3.53 concerning ParserLib:
- Repaired by 3.54: ParserLib reports the healing side of "Siphon Life" as a
  non-HoT heal, so Recap will record it as healing 'hits' rather than as healing
  'ticks'.
- ParserLib reports many deaths twice, and to avoid recording many deaths twice
  it is necessary to occasionally miss recording a death.
- ParserLib reports resists of some non-damaging effects (e.g. "Tainted Blood
  Effect" and "Fear") as the resists of damaging spells, and Recap will record
  them that way.


3.52, 2006-12-22 - fixed sorting order error for "Outgoing Details: Damage"
	panel (reported by Anari); fixed yet another 'nil' result error (reported
	by Anari); fixed a problem with sorting columns of averages in the
	personal details (reported by Anari); fix to show 100% overhealing; fixed
	error in report dropdowns (reported by Silan).
3.51, 2006-12-21 - fixed typo that prevented main "Spell or Ability" panel
	sorting properly; fixed typo that prevented counting misses; added
	ability to sort "Spell or Ability" panel by column in the same way
	as the main ("All" or "Last Fight") panel; a fix to further reduce
	display problems after changing column selections.
3.50, 2006-12-20 - modified by Hawksy (on Elune) from lua 5.0 to lua 5.1
	for WoW 2.01; forced default values in the lua code for all options
	not already initialised; adjusted logic so that healers don't have
	to do damage, or be damaged, before they show up in Recap; assorted
	other updates (a lot of code that worked in 5.0 no longer works in 5.1,
	for example 'nil' results are no longer propagated quietly upwards);
	fix to ChatFrameEditBox code; fix to Recap_DropMenuTemplate; fix
	to writing to WOWChatLog.txt; workaround for bad text display when
	Class is not selected as a column; modification to show a higher
	proportion of combatants in the "Last Fight" panel; separated Faction
	icon and level number, since overlaying them made both hard to read;
	modification so that on the personal details panel heals are shown at
	full value; modification so that hit points for friends are gathered
	at the start of a battle, so that overhealing is more accurately
	calculated; fixes to clear List and SelfList tables rather than
	re-using them; increases in the widths of a number of display fields;
	fixed list redisplay after deletion (resetting) of a combatant or effect;
	doubled the time before the popup menus fade.


The revisions for 3.32 and earlier are by Gello (see readme_332.txt)
