LoTROInterface SVN KragenBars

KragenBars by Kragenwar and Valdacil
v5.08 - 2011-11-06

Kragenbars features all classes (except Warden, expected to be added in a later version) with all skills 
organized onto multiple bars and offering contextual feedback as appropriate. Skills your character is too 
low to use will be hidden. 


Global Features:
----------------------
- KragenBars button for each class to allow easy access to all KragenBars features
- Ability to resize, delete, and create new KragenBars (see notes below)
- Ability to customize combat visibility for each bar (Always, In-Combat Only, Out-Combat Only)
- Set "Snap to Grid" size to get bars lined up 'just where you want them'
- BETA: Add skills/items to KragenBars that weren't previously coded for KragenBars
- Automatic class detection and setup
- Ability to swap skills between bars
- Ability to lock swappable skill bars to prevent accidental skill swapping
- Ability to rotate bars to be horizontal or vertical
- Option to snap bars to grid for easy alignment
- Completely revised setup screen better details the options and allows for future additions
- Skills respond to combat states (ie. skills not usable in combat hide when combat starts)
- Fully compatible with Nov Update and other plugins by changing coding to AddCallback vice
attaching directly to the player. (Now fully compatible with BuffBars and other plugins)
- Reorganized directory structure to reduce dependencies on external libraries (please see
upgrade instructions below)

Certain plugins which directly overwrite player functions like InCombatChanged, StanceChanged, EffectAdded
and EffectRemoved may break KragenBars functionality if loaded after KragenBars. If things do not seem to
be working correctly then ensure that you are loading KragenBars last as KragenBars does not overwrite these
functions.


Class Specific:
----------------------
Burglar
- Crit chain bars display and update when you crit. [Partly broken in RoI]
- Find Footing indicator displays when stunned/dazed/knocked down
- Stance Slot for Mischief, Quiet Knife and Gambler stances.
- Mischief related skills only display when in mischief (Honed Wit option allows Clever Retort to display
     out of Mischief)
- Item slots for Marbles, Caltrops, Stun Dust and Throwing Knives/Hatchets
- FM Response bar displays when the fellowship completes a named FM
- Green Poison indicator appears on Cure Poison/Burglar's Antidote when you have clearable poison debuffs.

Captain
- Defeat response bar displays when you receive a defeat response
- Devestating Blow, Pressing Attack and Blade of Elendil only appear when available.
- Option for all three marks on one scrolling quickslot
- Motivating Speech indicator displays when buff is not active
- IDOME indicator displays when buff is not active
- Tactics quickslot contains all 3 tactics (use scroll wheel to change shown tactic). Can be set to either
     fade or disappear when a tactic is active on the player
- Cry of Vengence indicator displayed upon fellowship member defeat
- Herald scroll quickslot displays when not in combat and fades down to indicate when you have a banner buff
     on you
- Banner scroll quickslot displays all banner plus Armament for switching back to Heralds. Fades down when
     you have banner buff active.
- Brother toggles (Shield, Song, Sword) in one multislot
- Item Quickslots for Summoning Horn, Battle-Tonics and Blazoned Emblems
- Purple Fear indicator appears on Muster Courage when you have clearable fear debuffs.

Champions
- Defeat response bar displays when you receive a defeat response.
- Buff bar displays available buffs (Flurry/Exchange of Blows) depending on your stance. Icons disappear
     when buffs are activated and come back when they fade off.
- Stance quickslot contains all stances in one slot (use scroll wheel to cycle). Options available to select
     a primary and secondary stance. If you are in your primary stance, the stance slot will fade and show
     your secondary stance; if not it will show your primary stance. Options to hide or dim when in a stance.
- Hedge indicator when disarmed
- Blood Rage indicator when stunned/dazed/knocked down
- Fervor Tracking: Skills only display if you have enough fervor for them.
- Item Quickslots for Crafted Horn and Fervor Tonics
- Purple Fear indicator appears on Fear Nothing when you have clearable fear debuffs.

Guardians
- Block and Parry reactive bars display when you block/parry and update as you move down the chain. (Now
     includes Tier 3 Block/Parry Responses)
- Guardian's Ward quickslot can be set to dim or hide when you have the Guardian's Ward Buff up.  Additional
     option Early Warning makes the slot hide and then come back dimmed about 3-5 seconds before the buff fades.
- Stance quickslot contains all stances in one slot (use scroll wheel to cycle). Options available to select
     a primary and secondary stance. If you are in your primary stance, the stance slot will fade and show
     your secondary stance; if not it will show your primary stance. Options to hide or dim when in a stance.
- Overpower bar shows if you are in Overpower. Shield Blow, Protection and Shield Wall disappear when in
     Overpower.
- Turn the Tables indicator displays when you are stunned/dazed/knocked down
- Item Quickslots for Shield Spikes and Overpower Tactics
- Red Wound indicator appears on Feel No Pain when you have clearable wound debuffs.

Hunter
- Agile Rejoinder displays if you receive Parry response
- Swift Stroke indicator displays when you don't have the Swift Stroke buff
- Stance quickslot contains all stances in one slot (use scroll wheel to cycle). Options available to select
     a primary and secondary stance. If you are in your primary stance, the stance slot will fade and show
     your secondary stance; if not it will show your primary stance.
- Find the Path indicator can hide or dim when active
- Tracking skills contained in one slot (use scroll wheel to cycle)
- Trapping skills contained in one slot (use scroll wheel to cycle)
- Strength of the Earth hidden when not in combat
- Focus Tracking: Skills only display if you have enough focus for them.
- Fire Oil and Light Oil quickslots configurable in the setup window. When an oil is active that slot will
     be hidden and the alternate oil slot will dim.
- Bow Chants quickslot configurable in the setup window.  When Bow chant is active slot will be hidden.
- Crafted traps multiquickslot configurable in the setup window (use scroll wheel to cycle crafted traps slot)
- Ports contained in one slot (use scroll wheel to cycle)

Loremaster
- Warding Lore skills contained in one slot (use scroll wheel to cycle)
- Pet buffs contained in one slot (use scroll wheel to cycle)
- Pet food multiquickslot configurable in the setup window.  (use scroll wheel to cycle)
- Pets contained in one slot (use scroll wheel to cycle between pet types; Alt+Scroll to cycle appearances).
     Setup window has options for which pets and appearences to show when scrolling
- Pets and Back from the Brink are hidden when in combat 

Minstrel
- Anthems and Codexr hide as appropriate
- Option to either hide or dim anthems with active buffs
- Skills only available in Warspeech are hidden if WS is not active
- Dethreat skills only show in combat
- Silence removal skills only show when silenced (option to Always Show Cry of the Chorus in setup)
- Tales contained in one slot (use scroll wheel to cycle). Tales indicator dims when a tale is active.
- Quickslots for Lute Strings and Sheet Music.  Lute Strings slot will hide while Lute Strings are active.

Runekeeper
- Calming Verse indicator shows when buff is not active
- Distracting Winds indicator show in combat
- Master of Writs indicator dims when buff is active. Writ skills show/hide depending on whether buff is
     present.
- Attunement and OffAttunement bars: Attunement bar shows usable Healing or Fury of Storm skills based on
     whether the player is Healing attuned or Battle attuned. OffAttune bar shows Scribe's Spark and
     Ceaseless Argument or Prelude to Hope, Rune of Restoration, Mending Verse and Writ of Health based on
     what is shown on the Attunement bar
- Skills show/hide based on attunement level
- Healing skills hide when out of combat as appropriate


Installation
----------------------
Due to significant reorganization within the KragenPlugs directory, if upgrading from version 2.0 and below
it is recommended that you delete your old KragenPlugs folder before installing the new version.  If you are
a KragenSlots user you can keep the directories KragenSlots, DUInterface and the file KragenSlots.plugin

Option 1: Use Lotr:O Plugin Assistant by Ify
1) Download KragenBars
2) Drag KragenBars.zip downloaded in step 1 onto Lotr:O Plugin Assistant.  Accept the prompt to upgrade.
3) Launch from within game as normal (via manager or via /plugins load Kragenbars)


Option 2: Manual Install
1) Download KragenBars
2) Extract KragenBars.zip downloaded in step 1 to your %Documents%\Lord of the Rings Online\Plugins
directory and overwrite all files when prompted
3) Launch from within game as normal (via manager or via /plugins load Kragenbars)


Note
----------------------
Due to significant changes in the PluginData file, anyone upgrading from a version of KragenBars prior to
version 3.00 will have their KragenBar settings reset to KragenBars defaults on first load of versions higher
than 3.00.


Note on KragenBars New/Remove Bar Feature
----------------------
In order for certain features to work properly, some bars have been made non-editable/non-removable (though
you can still make them inactive if you don't want to see them).  Examples of this are the Burglar's Crit Chain
and the Guardian Block/Parry Chain bars.  Any skills located on these bars cannot be swapped or placed on
other bars (even if you deactivate the original bar).


Note on Adding Skills to New Bars
----------------------
You may now drag skills from your Turbine Skills Panel to KragenBars and the effects coding will follow the
skill.  Skills placed on non-KragenBars will not have any KragenBars effects however.  If you drag a skill that
is contained within a multislot (ie. a stance or a Minstrel Tale), the entire multislot will be moved to the
new location.  Dragging any skill from the Skills Panel to a KragenBar will remove that skill from whatever
bar it was previously located (even if that bar is still visible).  You may also drag quickslots from the
KragenBars quickslot panel in the same manner.  As mentioned above, skills located on hard coded KragenBars
cannot be dragged to customized KragenBars.


Note on BETA: Adding non-coded skills/items to KragenBars
----------------------
V4.00 brings a BETA feature we are testing out that allows the ability to drag skills/items that weren't
originally coded for KragenBars.  An example of this would be adding the Direct Soldier skill to a KragenBar
or add potions from your inventory to KragenBars.  Please note that this is a Beta feature and you may
encounter unforeseen problems.  Please submit feedback and bug reports and we will do our
best to refine this feature.


Usage
----------------------
The first time Kragenbars is loaded (either via an in-game plugin manager or by executing the command:
"/plugins load Kragenbars") your class will be automatically detected and default options selected.

Once you have configured Kragenbars with your class, you can access setup by clicking on the KB icon (which
defaults to the top lefthand corner of the screen).

Rt. clicking on the KB button brings up a list of commands which can be executed for KragenBars (such as 
Refresh Level).  You can also change traits, features, and defaults via the rt. click menu.


Known Issues
----------------------
-The API does not allow us to determine whether the client is in layout mode (CTRL + \) or not. Loading
     KragenBars while in layout mode will result in drag bars that display/hide when they should be doing
     the opposite. If this happens just unload and reload the plugin with layout mode turned off.

-If you place a KragenBar on top of the main Turbine bar (the one in the bottom center of the screen with
     the menu, panel buttons, and first quickbar) then enter layout mode (Ctrl + \), the KragenBars icons 
     may appear behind the main Turbine bar making them inaccessible.  If you unload and reload the KragenBars
     should appear in front of the main Turbine bar again.

-Burglar: The second tier of the crit chain will show after the first tier fades even if you do not use
     Burglar's Advantage.  This is due to there not being a buff effect for tier 2 and the Burglar
     ClassAttributes do not function properly for Burglar.  This will be fixed once Turbine fixes this part
     of the API.

-KragenBars relies on effect names to change the state of your UI.  Because of this all features may not
     function properly on German and French clients.  We are in the midst of working on this, if you would
     like to help with effect name translation please PM KragenWar.
    - Minstrel: French translation needed.  Some German translations needed.
    - Loremaster: French and German translation needed.
    - Hunter: French and German translation needed.
    - Runekeeper: French and German translations needed.
    - Burglar: French and German(partial) translation needed
    - Captain: German(partial) and French(partial) translation needed
    - Guardian: French(partial) and German(partial) translation needed


Version Notes
-------------------
v5.08
- Added load confirmation with version number
- Captain: Added German translations provided by carnac
- Runekeeper: Added German translations provided by carnac
- Minstrel: Added German translations provided by carnac

v5.07
- Hunter: Added Guide to Galtrev

v5.06
- Guardian: Bug fix Improved Whirling Retaliation (seriously this time)

v5.05
- Guardian: Bug fix Improved Whirling Retaliation (second attempt)

v5.04
- Guaridan: Moved Parry skills around to account for Improved Whirling Retaliation moving to T1

v5.03
- Guardian: Bug fix for Guardian's Ward Tactics visibility

v5.02
- Guardian: Bug fix for Wound Indicator color
- Ministrel: Included German translations provided by carnac

v5.01
- Guardian: Fixed a bug regarding the Wound Indicator and trying to close the Setup Window
- Guardian: Fixed "Protection by the Sword" visibility in Overpower

v5.00
- RISE OF ISENGARD release; all classes updated as appropriate

v4.21
- Minstrel: Fix for T3 and Anthem visibility when Active Ballad Effect is set to Hide (Thanks rafelek)

v4.20
- Loremaster: Set Pet Food multislot to only appear when not in combat
- Loremaster: Changed Ancient Wisdom Early Warning to 85% of duration vice 70% of duration (warning at 4:30 vice
      9:00)
- Minstrel: Added trapping for Improved Tale of Battle and Improved Tale of Warding on Tales indicator
- Minstrel: Added options to select which buff triggers Dim or Hide on Ballad of Composure and Ballad of Flame
- Minstrel: Fixed Improved Herald's Strike to correct version (no more Improved Herald's Strike expoit)
- Minstrel: Fix for T3 Ballad Effect Names
- Runekeeper: Set Abrupt/Final Words to only appear in combat (can't interrupt someone unless you are fighting
      someone)
- Runekeeper: Fix for Glorious Foreshadowing attunement
- Burglar: Fix for Stance issues
- Champion: Fix for Stance issues
- Hunter: Fix for Endurance Stance


v4.13
- Fixed an issue where slots could disappear off your bar when moving them to blank spots on another bar.
- Burglar: Added Stance Priority and Stance Active options to Burglar to match other classes with stances.

v4.12
- Burglar: Fixed a bug when upgrading settings to V4 from pre V3.2. Thanks Denkirilargo.

v4.11
- Fixed issue when upgrading from V3.22 which would have required wiping settings to get the plugin to load.
     Now version 3.22 settings should upgrade properly to v4+.
- Fix for a bug that could cause invalid member function call errors on Save. (Thanks Stever1388)


v4.10
- Burglar: Updated for Lotro Update 2
- Hunter: Updated for Lotro Update 2
- Minstrel: Updated for Lotro Update 2 (New "Power of Song" effect untested) [Thanks to Rohanwood for helping
     with hex values of new skills] NOTE: New skills & effects don't have translations
- Beginnings of basic Help added to Setup
- Hunter: Bug fix for oils slots
- Runekeeper: Fixed level of Distracting Winds [thanks Kirkaland for pointing this out]
- Guardian: Fixed issue when updating settings file from pre v4.  Thanks macabrex.

v4.01
- Captain: Fixed issue with upgrading previous settings files to V4 structure.
- EU Clients: Fixed a bug in the Save/Load Methods on French and German Clients.

v4.00
- Added KB button which can be left clicked to access Setup and rt clicked to access numerous other features
- Added slider for Grid Size to set the Snap to Grid size to line up bars more precisely
- Added ability to alter/add/remove customized KragenBars (see notes above for exceptions)
- Added ability to set combat visibility by the user at the bar level (Always, In-combat Only, Out-Combat Only)
- Changed core coding of effects to better handle localized clients and better support customized KragenBars
- Refined the coding to traits, features, defaults and quickslots to be more universal across the classes
- Added ability to drag skills from the Turbine Skills Panel to KragenBars (see notes above).
- Added ability to drag quickslots from the KragenBars Setup window to KragenBars.
- Minstel: Added option to Always Show Cry of the Chorus
- BETA: Added ability to drag skills and items not originally coded (ie. Soldier/Crafting skills, potions,
      battle/warding lore, weapons, etc) onto customized KragenBars

v3.20
- Added language selection to setup window to override client locale.
- Updated Minstrel, Loremaster, Hunter, and Runekeeper with core code for localization.  Please see above
      translation requests for help in translating effects.
- Loremaster: Added pet food multiquickslot next to the Pet Buffs multislot.
- Hunter: Added crafted traps multiquickslot next to the Trapping multislot for 3 crafted traps.
- Hunter: Added Bow Chants quickslot next to the Light Oil quickslot.  Bow chant slot will hide when bow
      chants are active.
- Hunter: Bug fix for Distracting Shot showing up behind Rain of Thorns.
- Champion: Fixed some level errors on the skills Clobber, Bracing Attack and Hamstring
- Champion: Added quickslots for Crafted horn and Fervor Tonics
- Guardian: Added quickslot for Overpower Tactics
- Captain: Added quickslots for Rally Horn, Battle-tonics and Balzoned Emblems
- Burglar: Added quickslot for Throwing Knives/Hatchets
- Bug fix: Fixed bugs related to item quickslot visibility.

v3.12
- Bug fix: Burglar's Sneak was not displaying until level 28.  Sneak now will display at level 4.
- Bug fix: Burglar's FM Responses were causing an error due to a typo.
- Bug fix: Encoding/Decoding of numbers on French/German clients was not properly converting keys.  This has
     been fixed (Big thanks to ptweety for testing this and giving assistance in solving the issue)
- Minstrel: Added quickslots for consumables (Lute Strings and Sheet Music)
- Minstrel: Updated for localization and added German translations of effect (thanks to ptweety)
- Minstrel: Bug fix for Fellowship's Heart visibility after setting in the Setup window.

v3.11
- Bug fix: Hunter's Bards Arrow should now properly display on load.
- Bug fix: Multi-Slots were not showing if the user did not have the latest Turbine folder.  Multi-Slots are
     now independent of the Turbine library.
- New: Added encoding and decoding of numbers on save/load for French and German clients.  French and German
     clients should now properly save and load settings.
- Bug fix: Minor bug fixes to Champion and Captain.
- Bug fix: Sometimes the left half of the quickslots were becoming unclickable, this has been fixed.

v3.10
- Added Hunter "Stance Active" option in the Features panel
- Added Hunter Port skills on a single multislot (use scroll wheel to cycle)
- Bug fix for Minstrel related to Tales removal.

v3.02
- Additional bug fix for Minstrel skill Song of Restoration.  Thanks Uendilor for catching this one.
- Bug fix for Guardian and Champion Stance indicators.

v3.01
- Bug fix for Minstrel skill Song of Restoration/Chorus of Restoration.  Chorus will now replace Song at
     level 62.
- Optimization of features in Guardian, Champion and Captain setup windows.
- Bug fix for Captain's Motivated, IDoME and Tactics slots.  They should now behave as expected.

v3.00
- NEW: Automatic class detection and setup
- NEW: Ability to swap skills between bars
- NEW: Ability to lock swappable skill bars to prevent accidental skill swapping
- NEW: Ability to rotate bars to be horizontal or vertical
- NEW: Option to snap bars to grid for easy alignment
- NEW: Completely revised setup screen better details the options and allows for future additions
- UDATED: Skills respond to combat states (ie. skills not usable in combat hide when combat starts)
- FIXED: Fully compatible with Nov Update and other plugins by changing coding to AddCallback vice
attaching directly to the player. (Now fully compatible with BuffBars and other plugins)
- REVISED: Reorganized directory structure to reduce dependencies on external libraries

v2.0.0
- This is purely a fix to the problems introduced by the November Lotro Patch. Expect more fixes
and features early next week.

v1.5.2
- Fixed some bugs that were causing the individual components to still display on inital load if you had
set them off in the setup window.

v1.5.1
- CHAMPION: Fixed an issue where traited versions of Flurry and Exchange of Blows were not working
as intended.

v1.5.0
- KragenBars are now movable. Just press Ctrl+/ to unlock the UI and you will find dragbars for the
individual components of KragenBars. Additionally they will hide when you use F12 to hide your UI.
- New options and bars added to all classes, read the class sections above for more details. 
- BURGLAR: The Crit Chain for burgs was changed so that Burglar's Advantage/Double Edged Strike over
lap with the stage 3 responses. This was done because of the cooldowns on Exposed/Flashing Blades
I found that I missed not being able to start the chain over while waiting for cooldowns on
stage 3. Also feint attack will no longer display when you are in Mischief.


Future Plans
----------------------
- Add Warden class
- Update for GetClassAttributes() to better handle class specific features (stances, crit responses, etc)
     [Waiting on Turbine fix for API]
- PARTIAL (v3.11) - Localized versions for German and French clients (Translations needed)
- DONE! (v3.20) - Add class consumables w/ appropriate effects
- DONE! (v4.00) - Add ability to rename and resize bars
- DONE! (v4.00) - Add ability to make bars show only in/out of combat
- DONE! (v4.00) - Add option to make scroll slots to scroll when right clicked instead of on scroll


Credits
----------------------
Thanks to Digital Utopia for his Timer class and DUInterface UI Library.
Thanks to Deusdictum for his DragBar class. 
Thanks to Pengoros for his permission and assistance in adapting the BuffBars setup window.
Thanks to Eronaile for helping with the German effect names for Guardian/Burglar/Champion and Captain.
Thanks to ptweety for testing and helping with the German/French client settings number issue.
Thanks to rafalek for helping with effect localization bugs.
Thanks to Tholgar for assistance with Translation.
Thanks to all the faithful users for their positive feedback and assistance in driving improvements.