flickerstreak@7: flickerstreak@7: flickerstreak@7: ReAction: README flickerstreak@7: flickerstreak@10: flickerstreak@7: flickerstreak@7: flickerstreak@7: flickerstreak@7:

ReAction

flickerstreak@7:

AddOn for World of Warcraft

flickerstreak@12:

Current Version: 0.34 (alpha)
flickerstreak@12: Released: 09 Mar 2007
flickerstreak@12: WoW Version Compatibility: v2.0.10 / TOC 20003

flickerstreak@7:

The Basics

flickerstreak@7:

ReAction is a replacement for the default Blizzard action bars. It allows you flickerstreak@7: redefine your action button layout any way you like.

flickerstreak@7:

Features

flickerstreak@7:

Move, resize, create, and arrange as many action bars as you want. Each flickerstreak@7: bar can contain any number of buttons arranged in a grid layout of any size flickerstreak@7: and spacing. The full complement of 120 action slots is supported.
Works with all types of actions, including abilities, items, and macros
Layout is done with the mouse, by dragging bars and bar edges on screen. flickerstreak@7: Automatically anchor bars to each other or the screen edges by holding shift flickerstreak@7: down as you drag.
Context menus provide independent configuration options for each bar.
Point and click keybinding interface. You can bind keys to left-click or flickerstreak@10: right-click independently.
Supports multiple 'pages' per bar, configured independently. Automatic stance, flickerstreak@7: form, and stealth switching among pages is supported, including Shadowform.
Pet action bar is fully supported and configurable.
Settings can be saved per account, realm, character, class, or independent flickerstreak@7: profile.
Compatible with OmniCC
Various configurable display options

flickerstreak@7:

ReAction is built using the Ace2 flickerstreak@7: development framework.

flickerstreak@7:

Using ReAction

flickerstreak@7:

Installation

flickerstreak@12:

To install ReAction, drag the ReAction folder to your World of Warcraft/Interface/AddOns flickerstreak@12: folder. Exit World of Warcraft if it's running, then restart.

flickerstreak@7:

Welcome to ReAction

flickerstreak@7:

When you first enter World of Warcraft with ReAction installed, it will look flickerstreak@7: very similar to the default Blizzard UI, depending on what other AddOns are flickerstreak@12: installed. However, only the main menu bar is shown by default. Other bars can flickerstreak@8: be created as desired.

flickerstreak@7:

If you have FuBar installed, on the left side you should see the ReAction plugin flickerstreak@7: icon and label. If not, there should be a button on your minimap. In either flickerstreak@7: case, that button (the ReAction Control Button) is the gateway to configuring flickerstreak@7: ReAction.

flickerstreak@7:

ReAction has three modes of operation:

flickerstreak@7:

Normal ("locked")
Configuration ("unlocked")
Keybinding

flickerstreak@12:

(Technically it's 4 modes, because Config and Keybinding modes can both be flickerstreak@12: active at the same time).

flickerstreak@7:

You can toggle Configuration mode by shift-clicking the ReAction Control Button flickerstreak@7: and toggle Keybinding mode by alt-clicking the button. Global configuration flickerstreak@7: options are also available by right-clicking the ReAction button. There are flickerstreak@7: also a limited set of console commands that can be accessed with the "/reaction" flickerstreak@7: or "/rxn" slash-commands. Type /rxn in the chat box to print a list flickerstreak@7: of commands.

flickerstreak@7:

You can also set key bindings to toggle Configuration and Keybinding modes, flickerstreak@7: in the standard UI keybindings panel.

flickerstreak@7:

Configuring ReAction

flickerstreak@7:

Start by shift-clicking the ReAction button to enter Configuration mode. All flickerstreak@7: bars, including hidden bars, are shown in this mode and normal button click flickerstreak@7: operation is disabled (though keybindings still work). Mouse over the bars, flickerstreak@7: edges, and corners to see tooltip instructions for moving, resizing, and rearranging flickerstreak@7: them. Right click each bar for a menu of options pertaining to that bar. For flickerstreak@7: example, to change a hidden bar to a visible bar, right-click on a bar and choose flickerstreak@7: Visibility -> Always Visible. Tooltips for each menu option provide details.

flickerstreak@7:

When you're done configuring ReAction, shift-click the ReAction button again flickerstreak@7: to go back to Normal mode.

flickerstreak@7:

Configuration mode is not available if you are in combat, and is automatically flickerstreak@7: cancelled if you enter combat.

flickerstreak@7:

Setting Keybindings

flickerstreak@7:

ReAction buttons don't use the regular keybindings of the default UI. flickerstreak@7: In order to get your buttons to use hotkeys, enter ReAction Keybinding Setup flickerstreak@7: mode by alt-clicking the ReAction Control Button (or choosing 'keybinding mode' flickerstreak@7: from the right-click menu). ReAction button keybindings are not available flickerstreak@7: from the standard keybindings menu! You must use the ReAction keybinding flickerstreak@12: interface. They're even greyed out in the keybinding menu with a textual reminder, flickerstreak@12: so there's no excuse!

flickerstreak@7:

Like configuration mode, normal button operation is disabled while in keybinding flickerstreak@12: mode (though again, any hotkeys you have assigned will work). With the keybinding flickerstreak@12: interface out, you can mouseover any ReAction button to see what its current flickerstreak@12: keybinding is. You can set the keybinding on a button by clicking the button, flickerstreak@12: then pressing the key. To clear a keybinding from a ReAction button, shift-click flickerstreak@12: the button. Tooltips will remind you of this interface. You can also right-click/shift-right-click flickerstreak@12: to set/clear a right-click hotkey, which will simulate right-clicking the button flickerstreak@12: (useful for complex macro actions, typically to save screen real estate). If flickerstreak@12: you've set up bars with multiple pages, you can also bind a key to the page flickerstreak@12: up/down buttons on a per-bar basis. Just make sure the buttons are showing (they flickerstreak@12: can be hidden later) and assign the keybinding like any other ReAction button.

flickerstreak@12:

Keybindings are saved on a per-profile basis. Keybinding mode is not available flickerstreak@10: if you are in combat, and is automatically cancelled if you enter combat. When flickerstreak@12: you first log in with ReAction, it steals the current keybindings from the default flickerstreak@12: main action bar (buttons 1-12) and assigns them to the corresponding buttons flickerstreak@12: on the default ReAction bar. This means that if you install ReAction, run with flickerstreak@12: it, and then disable it, your main bar will no longer have any keybindings and flickerstreak@12: they'll need to be reset. If you later enable ReAction again, it will remember flickerstreak@12: its own keybindings.

flickerstreak@12:

If a profile assigns a keybinding to a ReAction button, switching away from flickerstreak@12: that profile will clear the binding but will not restore the binding flickerstreak@12: to its previous state. If the new profile assigns that binding then, of course, flickerstreak@12: it will be in use. What this means is that any 'standard' keybinding action flickerstreak@12: that's bound to a key will become unbound when switching to a profile that uses flickerstreak@12: the key, and will have to be manually rebound later if you switch away from flickerstreak@12: that profile.

flickerstreak@10:

Remember to click the 'Save' button to save your keybindings! If you flickerstreak@10: do not, they will automatically revert to the previous bindings when exiting flickerstreak@10: keybinding mode. This can be useful for "trying out" certain layouts flickerstreak@10: briefly, but can also be a serious gotcha — if you just hit 'Escape,' or flickerstreak@10: alt-click the ReAction Control Button, or enter combat while in keybinding mode, flickerstreak@10: your bindings will revert to their previous state.

flickerstreak@7:

Playing with ReAction

flickerstreak@7:

Once you get your keybindings and configuration set up, you're ready to go. flickerstreak@7: The buttons behave just like regular Blizzard buttons. However, at any time flickerstreak@7: when you're not in combat, you can quickly switch to configuration mode and flickerstreak@7: create a new bar, rearrange bars, hide/show a special-use bar, etc. Perfect flickerstreak@7: for when you get some goofy quest item that has to be used temporarily, or get flickerstreak@7: a new skill that doesn't fit on your current layout.

flickerstreak@7:

Limitations

flickerstreak@7:

Due to a lack of certain functionality made available by Blizzard, dragging flickerstreak@12: and dropping actions onto action bars while in combat is a little funky. You flickerstreak@12: have to click the destination button rather than just release drag on it.
You can't configure the pet bar unless you actually have a pet out.
No support for shapeshift/stance bar (yet)
If you have a bar with empty buttons, even though they're invisible they flickerstreak@7: still block mouse input from reaching whatever might be under the button. flickerstreak@7: This is a workaround so that you can drag and drop actions onto hidden slots flickerstreak@8: during combat. This workaround can be disabled via a configuration option, flickerstreak@8: but then you can't drag and drop actions onto slots during combat. Pick your flickerstreak@8: poison, it's a limitation of Blizzard's protection scheme.
If you hide the default main menu bar, there is no substitute provided (yet) flickerstreak@12: for the XP bar, bag bar, or micro menu bar (although the hotkeys for them flickerstreak@12: still work). Other addons can provide these features until ReAction supports flickerstreak@12: them.

flickerstreak@7:

Known Issues

flickerstreak@7:

There may or may not be a particular case in which turning off a pet's attack flickerstreak@7: while using Eyes of the Beast doesn't work. Further investigation (and leveling flickerstreak@7: a hunter to get Eyes of the Beast :-P) is required.
The initial mapping of action IDs for shapeshift forms doesn't exactly match flickerstreak@7: Blizzard's mapping. When first starting up as a warrior, druid, or rogue, flickerstreak@12: you will probably need to move your actions around, and it will likely screw flickerstreak@12: up your layout if you swap back to the default UI.
Action IDs may not always be laid out in sequence, meaning that similar flickerstreak@12: layouts on different machines may put the actions in a different order. For flickerstreak@12: best results, copy the WTF/Account/<AccountName>/SavedVariables/ReAction.lua flickerstreak@12: from one computer to the other, when you get a setup you like.
There seems to be a big performance hit when first dragging a bar after flickerstreak@12: entering configuration mode, and when first enabling keybinding mode, if there flickerstreak@12: are several bars and a lot of buttons out. More investigation is necessary.

flickerstreak@7:

Future Plans

flickerstreak@7:

Add support for bag bar, shapeshift bar, and micro menu bar. May also add flickerstreak@7: XP bar to default unit frames for those who don't want to use a unit frame flickerstreak@7: addon to get the XP bar back.
More dynamic bar support: auto show/hide/fade on stance switch, in combat, flickerstreak@7: key pressed, etc.
"pop-up" bar support, in which a single button shows/hides a bar flickerstreak@7: when moused over
Better and more flexible interface for defining page transitions on stance/form flickerstreak@7: shift
Provide a method for normalizing the action ID layout, permitting better flickerstreak@7: compatibility when used on different computers.
Provide some additional console commands so that enterprising users can flickerstreak@7: macro certain configuration functionality (notably hiding and showing individual flickerstreak@7: bars)
Yet more configurable button display options (disable cooldown flash, different flickerstreak@7: borders, etc)
Button styles (Dreamlayout, CyCircled)
Localization

flickerstreak@7:

Version History

flickerstreak@12:

Version 0.34:

flickerstreak@12:

Fixed some bugs in the keybinding code, and further refined the ReBound flickerstreak@12: library.

flickerstreak@10:

Version 0.33:

flickerstreak@10:

Rewrote the keybinding interface (again). I think I finally like this version. flickerstreak@10: Keybindings are now saved and loaded with the profile, and honor the "character-specific flickerstreak@10: keybindings" setting in the Blizzard Keybinding pane. The default keybindings flickerstreak@10: for action bars are now greyed out in Blizzard's interface to remind you to flickerstreak@10: use ReAction to set bindings for action bars.
Moved the Action ID label on the buttons to the center of the button.
Added support for binding right-clicks to hotkeys on the main action buttons flickerstreak@10: only (no pet buttons). There is also an option (off by default) to display flickerstreak@10: and specify the location for right-click binding labels.
Tweaked the ordering of the bar menus. Some options will automatically show/hide flickerstreak@10: when they are relevant.
Converted the core of the keybinding code to an Ace2-style library: ReBound-1.0
Did a little bit of code cleanup in main.lua
Converted to MIT license

flickerstreak@9:

Version 0.32:

flickerstreak@9:

Fixed a bug with displaying cooldowns generating slews of errors

flickerstreak@8:

Version 0.31:

flickerstreak@8:

Fixed a bug where action IDs > 120 were being configured and allocated flickerstreak@8: in certain cases
Fixed a bug where hidden paging controls were reappearing when switching flickerstreak@8: pages
Fixed a script error that was popping up in certain conditions when starting flickerstreak@8: keybinding mode, and causing some buttons not to be bindable
Applied a fix that will (hopefully?) eliminate errors saying ACTIONBAR_UPDATE_STATE flickerstreak@8: was not registered (be on the lookout for recurrences of that one). Hopefully flickerstreak@8: this fix will eliminate several other intermittent errors that I think are flickerstreak@8: part of the same cause.
Added new options for controlling the opacity of buttons (which should now flickerstreak@8: actually work). Previous opacity settings (if any) will be lost and will need flickerstreak@8: to be re-applied after updating. There is also now a toggle to hide (rather flickerstreak@8: than alpha-zero) empty buttons, at the expense of not being able to drag actions flickerstreak@8: onto them during combat.
Action IDs now appear/disappear automatically when bars are unlocked. There flickerstreak@8: is no longer a menu item to show/hide them.
Changed the default startup bar configuration to only be the paged main flickerstreak@8: bar. This allows a default startup to create new bars without having to delete flickerstreak@8: some first. Will probably simplify even further in a future patch. Note this flickerstreak@8: doesn't fix the action-rearrangement setup headaches with warriors, druids, flickerstreak@8: and rogues.
Cooldowns can now be hidden - either all cooldowns or just global cooldowns.

flickerstreak@7:

Version 0.3

flickerstreak@7:

Complete rewrite of the innards for better modularity
Lots of bug fixes
Multi-paged bar support
Pet bar support
Auto stance/form/stealth switching
Lots and lots of new configuration options

flickerstreak@7:

Version 0.2

flickerstreak@7:

Bug fixes from 0.1
new keybinding interface

flickerstreak@7:

Version 0.1

flickerstreak@7:

Initial concept, button arrangement

flickerstreak@7:

Credits

flickerstreak@7:

Huge credit to the Ace 2 development team, flickerstreak@7: whose framework provides a level of functionality that I consider critical to flickerstreak@10: the success of this addon. Similarly, enormous credit goes to ckknight, flickerstreak@7: whose Dewdrop menuing system and FuBar plugin system are ridiculously easy to flickerstreak@7: use.

flickerstreak@12:

Thanks to the authors of certain action bar mods that came before ReAction: flickerstreak@12: Bartender3, Bongos, FlexBar 2, and Trinity Bars. While I didn't steal any code flickerstreak@12: directly from you guys, your addons provided inspiration for various features flickerstreak@12: and options. Hopefully ReAction differentiates itself sufficiently that it's flickerstreak@12: not seen as simply a clone.

flickerstreak@7:

Finally, thanks to my alpha testers and stalwart adventuring companions: Deor, flickerstreak@12: Nogrim, Sorabel, and Yngvi (or, more to the point, their alts :-P).

flickerstreak@10:

Copyright & License

flickerstreak@10:

ReAction is distributed under the MIT license.

flickerstreak@10:

Permission is hereby granted, free of charge, to any person obtaining a copy flickerstreak@10: of this software and associated documentation files (the "Software"), flickerstreak@10: to deal in the Software without restriction, including without limitation the flickerstreak@10: rights to use, copy, modify, merge, publish, distribute, sublicense, and/or flickerstreak@10: sell copies of the Software, and to permit persons to whom the Software is furnished flickerstreak@10: to do so, subject to the following conditions:

flickerstreak@10:

The above copyright notice and this permission notice shall be included in flickerstreak@10: all copies or substantial portions of the Software.

flickerstreak@10:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS flickerstreak@10: OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, flickerstreak@10: FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE flickerstreak@10: AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, flickerstreak@10: WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR flickerstreak@10: IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

flickerstreak@7:

World of Warcraft is a registered trademark of Blizzard Entertainment, Inc.

flickerstreak@7: flickerstreak@7: