--==-- Segui Functionality Description --==--

This addon was originally called "SpeakEasyGUI", and its sole purpose was to facilitate roleplaying
while providing a graphical interface for configuration. This is still its specialty, but it can be employed
in other ways as well.

This addon allows the user to configure automated actions to a wide variety of in-game events,
such as using an ability or item, interacting with an object in the world, receiving a chat message or
combat event, manually invoking the configured action with a macro, or any number of other miscellaneous
phenomena. The action can be any number of chat messages or emotes, or non-secure slash commands
(including the "/script" command, which can be used to trigger a whole lot of more complex actions). The
only thing it cannot do is perform restricted actions such as casting or targeting.

Throughout the addon, three specific terms are used to describe the configuration process, which
takes place in a sectioned configuration window accessible via "/segui config" or the Blizzard Interface
Options menu:

Category / Subcategory -> Event -> Action

Simply put, a category is a group of similarly-themed events (such as a mage's Fire spell tab, or combat
events pertaining to killing blows), and for each event there can be many actions configured. Each action
pertains to what to do (speak, emote, or run a script), how to do it (which chat channel, whether to speak
in your second language, etcetera), and when it is allowed to happen. This last configuration property is
where variety and limitations can be created, with options such as randomization, repeat delays, and, where
pertinent, what parts of a cast can trigger the action (start of cast, end of cast, etcetera). There is no limit to
the number of actions which can trigger from a single occurence of an event. See the Examples.txt file for
some examples of how to configure Segui, or read the help panel of the configuration window for a general
overview.

Aside from the full configuration window, there is also a simple slash command available to temporarily
ignore all events, thus stopping all actions. Use "/segui ignore" to toggle this state.


Unit IDs:
	Read this section if you want to use <unit> action text substitution tokens. WoW uses special IDs to
	represent units, as they relate to the player. The <unit> token allows you to dynamically substitute
	the name of a given unit into the text of an action each time it triggers. An exhaustive list can be
	found in the "Targeting in Macros" section of this page: http://www.worldofwarcraft.com/info/basics/macroguide-one.html
	You can also use macro-style conditional expressions to dynamically evaluate the unit token to use.
	For instance,
		<unit [target=mouseover,exists] mouseover; target>
	will evaluate to the name of the mouseover unit if it exists, or otherwise the name of the target unit.


Lua String Patterns:
	If you need to read about Lua string patterns, powerful text matching tools, so that you can set up
	more elaborate event configurations for chat messages or combat events, or use <argpattern> action
	text substitution tokens, view the Lua manual: http://www.lua.org/manual/5.1/manual.html#5.4.1
	
	To test these out for yourself, try this handy debug script:
	
	/script local text = "your test text here"; local pattern = "your test pattern here";
		local result = text:match(pattern); DEFAULT_CHAT_FRAME:AddMessage(tostring(result));
		
	Fill in the test text and the test pattern with your respective values, and run the /script. It'll print out
	the result of matching the pattern against the text. Remember that the text is just normal text, while
	the pattern can contain the special characters and formats specified in the Lua manual.