KayrMacro - Advanced Macros and Expanded Storage 

================================================================
= KayrMacro - Advanced Macros Addon for World of Warcraft
= Copyright (c) Kvalyr - 2015 - All Rights Reserved
================================

Please see the KayrMacro Wiki @ http://kayrmacro.kvalyr.com

THIS IS AN ALPHA 'PREVIEW' RELEASE.
! BUGS AND MISSING FEATURES !

In-Game Documentation added!

Syntax for macros may occasionally change during alpha phase, but once the addon reaches beta the KMacro addon syntax will be stable and should see minimal changes in future.

Please note: Users upgrading from versions prior to 0.3.4 may need to update any of their KMacros that used macro shorthands (such as [Tx] for talent-casting).
The wrapper symbols for these shorthands have been changed from "[x]" to "<x>"

This addon has been in development on-and-off for a number of months and I've been using it myself since 5.0.
I'm releasing this alpha version to get feedback from users on usability and functionality and to get the ideas and code out.

================================
Description & Features:
================

KayrMacro (KM) is an AddOn for World of Warcraft that expands the functionality of the game's built-in macro system.
It adds new conditions and keywords; and greatly expands macro storage, all while retaining full compatibility with the default UI as well as all ActionBar addons.

* Vastly expanded macro storage (Space for thousands of macros)
* New advanced macro conditions in addition to those built into WoW
* Macro-shortening and useful shorthands
* Macro Indentation & Syntax Highlighting during editing

================
Examples
================
Examples of the kinds of complex macros and conditions possible with KM can be seen at: http://kayrmacro.kvalyr.com

================
Existing macros are left untouched
================
KM never modifies existing macros and does not interfere with the normal usage of macros in WoW.
KM will only modify/rewrite macros that have been 'enabled' in the main KM window.

Players can choose to give KayrMacro control of none or all 54 macro slots in the default macro UI.

================
Expanded Macro Storage
================
KM greatly expands the amount of storage space available for macros by allowing the player to store their macros on an
account-wide, class-wide or character-specific basis.

The AddOn then dynamically calls up the stored macros according to the player's choice on a per-macro basis that can be
changed at any time (out of combat) by the user.

The actual macro icon in the macro frame or on the player's bars remains where it is at all times and the addon simply
re-writes the macro's code when necessary.

================
Advanced Macro Conditions
================
KM adds a number of new conditions to macros for choosing actions according to class, spec, talent-choices, known spells, etc.

Note: The new conditions added to the macro system by KM are ONLY PARSED OUTSIDE OF COMBAT.
The WoW API prevents macros from being edited during combat and KM makes no attempt to circumvent this limitation.

KM cannot automate macros during combat, it is simply a way to consolidate macros according to new out-of-combat conditions.

================
Infinite Macro-length
================
Macros in KayrMacro can be of any length. The advanced conditions added by KM make it less likely that the user will need macros
longer than 255 characters, but the addon supports macros of almost any length as long as no single slash-command within the macro
is longer than 1023 characters.
The addon warns the user in the rare case that this is an issue.

================
Macro Shorthands
================
Talent-spells can be cast by using <Tx> in place of a spell name, where 'x' is the tier of the talent.

For instance, to cast the player's chosen 2nd-tier talent:
''/cast <T2>;''

Other shorthands include:
Best Health Potion: <healthpotion>
Best Mana Potion: <manapotion>
Best Bandage: <bandage>
Best Food: <food>
Best Water: <water>

================
Macro Indentation and Syntax-highlighting
================
+ Macros written in KM can have as much or as little whitespace as the user desires.
+ KM ignores whitespace and even linebreaks in most circumstances.
+ The semicolon ( ; ) is used to signal the end of a 'line' in a macro.
+ This also allows for indentation so that separate conditions (such as modifiers) can be split across multiple lines after a
slash command for readability in a macro.

+ Examples of this can be seen on the Wiki ( http://www.kvalyr.com/wiki/index.php/KayrMacro#Syntax )



================
How it works
================
KM Works by adding a pre-processor stage to macro creation that works outside of combat to re-write KM macros according to
states such as the player's chosen spec, talents, available items, etc.

KMacros are handled in a window attached to the MacroFrame of the default UI but the macros produced by KM are normal, valid
macros indistinguishable from hand-written macros in the default UI.

================
Usage:
========
+ Please see documentation at http://kayrmacro.kvalyr.com
+ Getting started: http://www.kvalyr.com/wiki/index.php/KayrMacro#Getting_Started

================
Requirements & Compatibility:
=======
+ WoW 5.4 to 6.x (Mists of Pandaria / Warlords of Draenor)

+ KayrMacro requires empty/available macro slots to work initially.

+ The end-result Macros generated by KM are functionally identical to hand-written macros and are equally compatible with
existing action bar addons.

+ Please report any incompatibilities discovered to Kvalyr on the WoWInterface.com page for this addon.

================
Installation:
=======
+ Standard addon installation:
Place the "KayrMacro" folder inside "[WoW Folder]\Interface\Addons".
Enable KayrMacro in the Addons menu on the character selection screen.

================
Planned Features:
========

+ Options GUI
+ Multi-line Conditions
+ User-defined conditions, sub-macros, variables

================
Libraries
=======
+ Embeds KayrLib by Kvalyr and LibStrataFix by oscarucb

================
Credits/Contact:
=======
Wiki: http://kayrmacro.kvalyr.com

+ Kvalyr (Author)

================
Licence & Disclaimer:
=======
THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

KayrMacro & KayrLib - Copyright 2015 Kvalyr (Robert Voigt) - ALL RIGHTS RESERVED
Modification or redistribution without explicit consent from the author is prohibited and
considered a breach of copyright.

A lack of response by the author to requests for permission to redistribute this software
in any state must NOT be considered as permission, implicit or otherwise.
In such case as redistribution is explicitly permitted by the author, this software and
these accompanying notices must remain intact and included with the software.

================================
Authorized Download Locations:
================
WoWInterface.com

================
Known Issues:
=======
+ No user-configurable options for submacros (healthpotion, manapotion, bandage, food, water)

================
Change Log:
=======
See Change Log tab (above)

================================================================