|
flickerstreak@7
|
1 <html>
|
|
flickerstreak@7
|
2 <head>
|
|
flickerstreak@7
|
3 <title>ReAction: README</title>
|
|
flickerstreak@7
|
4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
flickerstreak@10
|
5 <style type="text/css">
|
|
flickerstreak@10
|
6 <!--
|
|
flickerstreak@10
|
7 body { background-color: #FFFFCC; list-style-type: none}
|
|
flickerstreak@10
|
8 p { margin-top: 0px; margin-bottom: 18px}
|
|
flickerstreak@10
|
9 ul { line-height: 110%}
|
|
flickerstreak@10
|
10 -->
|
|
flickerstreak@10
|
11 </style>
|
|
flickerstreak@7
|
12 </head>
|
|
flickerstreak@7
|
13
|
|
flickerstreak@7
|
14 <body bgcolor="#FFFFFF" text="#000000">
|
|
flickerstreak@7
|
15 <h1 align="center">ReAction</h1>
|
|
flickerstreak@7
|
16 <h3 align="center">AddOn for World of Warcraft</h3>
|
|
flickerstreak@10
|
17 <p><font size="2">Current Version: 0.33 (alpha)<br>
|
|
flickerstreak@10
|
18 Released: 02 Mar 2007</font><font size="2"><br>
|
|
flickerstreak@10
|
19 WoW Version Compatibility/TOC: 2.0.8 / TOC 20003</font></p>
|
|
flickerstreak@7
|
20 <h2>The Basics</h2>
|
|
flickerstreak@7
|
21 <p>ReAction is a replacement for the default Blizzard action bars. It allows you
|
|
flickerstreak@7
|
22 redefine your action button layout any way you like.</p>
|
|
flickerstreak@7
|
23 <h2>Features</h2>
|
|
flickerstreak@7
|
24 <ul>
|
|
flickerstreak@7
|
25 <li>Move, resize, create, and arrange as many action bars as you want. Each
|
|
flickerstreak@7
|
26 bar can contain any number of buttons arranged in a grid layout of any size
|
|
flickerstreak@7
|
27 and spacing. The full complement of 120 action slots is supported.</li>
|
|
flickerstreak@7
|
28 <li>Works with all types of actions, including abilities, items, and macros</li>
|
|
flickerstreak@7
|
29 <li>Layout is done with the mouse, by dragging bars and bar edges on screen.
|
|
flickerstreak@7
|
30 Automatically anchor bars to each other or the screen edges by holding shift
|
|
flickerstreak@7
|
31 down as you drag.</li>
|
|
flickerstreak@7
|
32 <li>Context menus provide independent configuration options for each bar.</li>
|
|
flickerstreak@10
|
33 <li>Point and click keybinding interface. You can bind keys to left-click or
|
|
flickerstreak@10
|
34 right-click independently.</li>
|
|
flickerstreak@7
|
35 <li>Supports multiple 'pages' per bar, configured independently. Automatic stance,
|
|
flickerstreak@7
|
36 form, and stealth switching among pages is supported, including Shadowform.</li>
|
|
flickerstreak@7
|
37 <li>Pet action bar is fully supported and configurable.</li>
|
|
flickerstreak@7
|
38 <li>Settings can be saved per account, realm, character, class, or independent
|
|
flickerstreak@7
|
39 profile. </li>
|
|
flickerstreak@7
|
40 <li>Compatible with OmniCC</li>
|
|
flickerstreak@8
|
41 <li>Various configurable display options</li>
|
|
flickerstreak@7
|
42 </ul>
|
|
flickerstreak@7
|
43 <p>ReAction is built using the <a href="http://www.wowace.com/Wiki/Ace2">Ace2</a>
|
|
flickerstreak@7
|
44 development framework.</p>
|
|
flickerstreak@7
|
45 <h2>Using ReAction</h2>
|
|
flickerstreak@7
|
46 <h3>Installation</h3>
|
|
flickerstreak@7
|
47 <p>To install ReAction, drag the ReAction folder to World of Warcraft/Interface/AddOns.
|
|
flickerstreak@7
|
48 Exit World of Warcraft if it's running, then restart.</p>
|
|
flickerstreak@7
|
49 <h3>Welcome to ReAction</h3>
|
|
flickerstreak@7
|
50 <p>When you first enter World of Warcraft with ReAction installed, it will look
|
|
flickerstreak@7
|
51 very similar to the default Blizzard UI, depending on what other AddOns are
|
|
flickerstreak@7
|
52 installed. Any keybindings you have made to the action bars, however, are not
|
|
flickerstreak@8
|
53 in effect. Also, only the main menu bar is shown by default. Other bars can
|
|
flickerstreak@8
|
54 be created as desired.</p>
|
|
flickerstreak@7
|
55 <p>If you have FuBar installed, on the left side you should see the ReAction plugin
|
|
flickerstreak@7
|
56 icon and label. If not, there should be a button on your minimap. In either
|
|
flickerstreak@7
|
57 case, that button (the ReAction Control Button) is the gateway to configuring
|
|
flickerstreak@7
|
58 ReAction.</p>
|
|
flickerstreak@7
|
59 <p>ReAction has three modes of operation:</p>
|
|
flickerstreak@7
|
60 <ul>
|
|
flickerstreak@7
|
61 <li>Normal ("locked")</li>
|
|
flickerstreak@7
|
62 <li>Configuration ("unlocked")</li>
|
|
flickerstreak@7
|
63 <li>Keybinding</li>
|
|
flickerstreak@7
|
64 </ul>
|
|
flickerstreak@7
|
65 <p>You can toggle Configuration mode by shift-clicking the ReAction Control Button
|
|
flickerstreak@7
|
66 and toggle Keybinding mode by alt-clicking the button. Global configuration
|
|
flickerstreak@7
|
67 options are also available by right-clicking the ReAction button. There are
|
|
flickerstreak@7
|
68 also a limited set of console commands that can be accessed with the "/reaction"
|
|
flickerstreak@7
|
69 or "/rxn" slash-commands. Type /rxn in the chat box to print a list
|
|
flickerstreak@7
|
70 of commands.</p>
|
|
flickerstreak@7
|
71 <p>You can also set key bindings to toggle Configuration and Keybinding modes,
|
|
flickerstreak@7
|
72 in the standard UI keybindings panel.</p>
|
|
flickerstreak@7
|
73 <h3>Configuring ReAction</h3>
|
|
flickerstreak@7
|
74 <p>Start by shift-clicking the ReAction button to enter Configuration mode. All
|
|
flickerstreak@7
|
75 bars, including hidden bars, are shown in this mode and <b>normal button click
|
|
flickerstreak@7
|
76 operation is disabled </b>(though keybindings still work). Mouse over the bars,
|
|
flickerstreak@7
|
77 edges, and corners to see tooltip instructions for moving, resizing, and rearranging
|
|
flickerstreak@7
|
78 them. Right click each bar for a menu of options pertaining to that bar. For
|
|
flickerstreak@7
|
79 example, to change a hidden bar to a visible bar, right-click on a bar and choose
|
|
flickerstreak@7
|
80 Visibility -> Always Visible. Tooltips for each menu option provide details.</p>
|
|
flickerstreak@7
|
81 <p>When you're done configuring ReAction, shift-click the ReAction button again
|
|
flickerstreak@7
|
82 to go back to Normal mode.</p>
|
|
flickerstreak@7
|
83 <p>Configuration mode is not available if you are in combat, and is automatically
|
|
flickerstreak@7
|
84 cancelled if you enter combat.</p>
|
|
flickerstreak@7
|
85 <h3>Setting Keybindings</h3>
|
|
flickerstreak@7
|
86 <p><b>ReAction buttons don't use the regular keybindings of the default UI.</b>
|
|
flickerstreak@7
|
87 In order to get your buttons to use hotkeys, enter ReAction Keybinding Setup
|
|
flickerstreak@7
|
88 mode by alt-clicking the ReAction Control Button (or choosing 'keybinding mode'
|
|
flickerstreak@7
|
89 from the right-click menu). <b>ReAction button keybindings are not available
|
|
flickerstreak@7
|
90 from the standard keybindings menu!</b> You <i>must</i> use the ReAction keybinding
|
|
flickerstreak@10
|
91 interface. They're even greyed out in the keybinding menu to remind you.</p>
|
|
flickerstreak@7
|
92 <p>Like configuration mode, normal button operation is disabled while in keybinding
|
|
flickerstreak@7
|
93 mode (though again, any hotkeys you have assigned will work).</p>
|
|
flickerstreak@7
|
94 <p>With the keybinding interface out, you can mouseover any ReAction button to
|
|
flickerstreak@7
|
95 see what its current keybinding is. You can set the keybinding on a button by
|
|
flickerstreak@10
|
96 clicking the button, then pressing the key. To clear a keybinding from a ReAction
|
|
flickerstreak@10
|
97 button, shift-click the button. Tooltips will remind you of this interface.
|
|
flickerstreak@10
|
98 You can also right-click/shift-right-click to set/clear a right-click hotkey,
|
|
flickerstreak@10
|
99 which will simulate right-clicking the button (useful for complex macros, typically
|
|
flickerstreak@10
|
100 to save screen real estate). If you've set up bars with multiple pages, you
|
|
flickerstreak@7
|
101 can also bind a key to the page up/down buttons on a per-bar basis. Just make
|
|
flickerstreak@7
|
102 sure the buttons are showing (they can be hidden later) and assign the keybinding
|
|
flickerstreak@7
|
103 like any other ReAction button.</p>
|
|
flickerstreak@7
|
104 <p>Keybindings are saved on a per-character basis. Keybinding mode is not available
|
|
flickerstreak@10
|
105 if you are in combat, and is automatically cancelled if you enter combat. When
|
|
flickerstreak@10
|
106 you first log in with ReAction, it steals the keybindings from the default main
|
|
flickerstreak@10
|
107 action bar (buttons 1-12) and assigns them to the corresponding buttons on the
|
|
flickerstreak@10
|
108 default ReAction bar.</p>
|
|
flickerstreak@10
|
109 <p><b>Remember to click the 'Save' button to save your keybindings! </b>If you
|
|
flickerstreak@10
|
110 do not, they will automatically revert to the previous bindings when exiting
|
|
flickerstreak@10
|
111 keybinding mode. This can be useful for "trying out" certain layouts
|
|
flickerstreak@10
|
112 briefly, but can also be a serious gotcha — if you just hit 'Escape,' or
|
|
flickerstreak@10
|
113 alt-click the ReAction Control Button, or enter combat while in keybinding mode,
|
|
flickerstreak@10
|
114 your bindings will revert to their previous state.</p>
|
|
flickerstreak@7
|
115 <h3>Playing with ReAction</h3>
|
|
flickerstreak@7
|
116 <p>Once you get your keybindings and configuration set up, you're ready to go.
|
|
flickerstreak@7
|
117 The buttons behave just like regular Blizzard buttons. However, at any time
|
|
flickerstreak@7
|
118 when you're not in combat, you can quickly switch to configuration mode and
|
|
flickerstreak@7
|
119 create a new bar, rearrange bars, hide/show a special-use bar, etc. Perfect
|
|
flickerstreak@7
|
120 for when you get some goofy quest item that has to be used temporarily, or get
|
|
flickerstreak@7
|
121 a new skill that doesn't fit on your current layout.</p>
|
|
flickerstreak@7
|
122 <h2>Limitations</h2>
|
|
flickerstreak@7
|
123 <ul>
|
|
flickerstreak@7
|
124 <li>Due to a lack of certain functionality being made available by Blizzard,
|
|
flickerstreak@7
|
125 dragging and dropping actions onto action bars while in combat is a little
|
|
flickerstreak@7
|
126 funky. You have to click the destination button rather than just release drag
|
|
flickerstreak@7
|
127 on it.</li>
|
|
flickerstreak@7
|
128 <li>You can't configure the pet bar unless you actually have a pet out at the
|
|
flickerstreak@7
|
129 moment. </li>
|
|
flickerstreak@7
|
130 <li>No support for shapeshift/stance bar (yet)</li>
|
|
flickerstreak@7
|
131 <li>If you have a bar with empty buttons, even though they're invisible they
|
|
flickerstreak@7
|
132 still block mouse input from reaching whatever might be under the button.
|
|
flickerstreak@7
|
133 This is a workaround so that you can drag and drop actions onto hidden slots
|
|
flickerstreak@8
|
134 during combat. This workaround can be disabled via a configuration option,
|
|
flickerstreak@8
|
135 but then you can't drag and drop actions onto slots during combat. Pick your
|
|
flickerstreak@8
|
136 poison, it's a limitation of Blizzard's protection scheme.</li>
|
|
flickerstreak@10
|
137 <li>If you hide the default main menu bar, there is no substitute provided for
|
|
flickerstreak@10
|
138 the XP bar, bag bar, or micro menu bar (although the hotkeys for them still
|
|
flickerstreak@10
|
139 work). Other addons can provide these features until ReAction supports them.</li>
|
|
flickerstreak@7
|
140 </ul>
|
|
flickerstreak@7
|
141 <h2>Known Issues</h2>
|
|
flickerstreak@7
|
142 <ul>
|
|
flickerstreak@7
|
143 <li>There may or may not be a particular case in which turning off a pet's attack
|
|
flickerstreak@7
|
144 while using Eyes of the Beast doesn't work. Further investigation (and leveling
|
|
flickerstreak@7
|
145 a hunter to get Eyes of the Beast :-P) is required.</li>
|
|
flickerstreak@7
|
146 <li>The initial mapping of action IDs for shapeshift forms doesn't exactly match
|
|
flickerstreak@7
|
147 Blizzard's mapping. When first starting up as a warrior, druid, or rogue,
|
|
flickerstreak@7
|
148 you will probably need to move your actions around.</li>
|
|
flickerstreak@7
|
149 <li>Action IDs may not always be laid out in sequence, meaning that similar
|
|
flickerstreak@7
|
150 layouts on different machines may put the actions in a different order.</li>
|
|
flickerstreak@7
|
151 <li>There seems to be a big performance hit when first dragging a bar after
|
|
flickerstreak@10
|
152 entering configuration mode, and when first enabling keybinding mode. More
|
|
flickerstreak@10
|
153 investigation is necessary.</li>
|
|
flickerstreak@7
|
154 </ul>
|
|
flickerstreak@7
|
155 <h2>Future Plans</h2>
|
|
flickerstreak@7
|
156 <ul>
|
|
flickerstreak@7
|
157 <li>Add support for bag bar, shapeshift bar, and micro menu bar. May also add
|
|
flickerstreak@7
|
158 XP bar to default unit frames for those who don't want to use a unit frame
|
|
flickerstreak@7
|
159 addon to get the XP bar back.</li>
|
|
flickerstreak@7
|
160 <li>More dynamic bar support: auto show/hide/fade on stance switch, in combat,
|
|
flickerstreak@7
|
161 key pressed, etc.</li>
|
|
flickerstreak@7
|
162 <li>"pop-up" bar support, in which a single button shows/hides a bar
|
|
flickerstreak@7
|
163 when moused over</li>
|
|
flickerstreak@7
|
164 <li>Better and more flexible interface for defining page transitions on stance/form
|
|
flickerstreak@7
|
165 shift </li>
|
|
flickerstreak@7
|
166 <li>Provide a method for normalizing the action ID layout, permitting better
|
|
flickerstreak@7
|
167 compatibility when used on different computers.</li>
|
|
flickerstreak@7
|
168 <li>Provide some additional console commands so that enterprising users can
|
|
flickerstreak@7
|
169 macro certain configuration functionality (notably hiding and showing individual
|
|
flickerstreak@7
|
170 bars) </li>
|
|
flickerstreak@7
|
171 <li>Yet more configurable button display options (disable cooldown flash, different
|
|
flickerstreak@7
|
172 borders, etc)</li>
|
|
flickerstreak@7
|
173 <li>Localization</li>
|
|
flickerstreak@7
|
174 </ul>
|
|
flickerstreak@7
|
175 <h2>Version History</h2>
|
|
flickerstreak@10
|
176 <p>Version 0.33:</p>
|
|
flickerstreak@10
|
177 <ul>
|
|
flickerstreak@10
|
178 <li>Rewrote the keybinding interface (again). I think I finally like this version.
|
|
flickerstreak@10
|
179 Keybindings are now saved and loaded with the profile, and honor the "character-specific
|
|
flickerstreak@10
|
180 keybindings" setting in the Blizzard Keybinding pane. The default keybindings
|
|
flickerstreak@10
|
181 for action bars are now greyed out in Blizzard's interface to remind you to
|
|
flickerstreak@10
|
182 use ReAction to set bindings for action bars.</li>
|
|
flickerstreak@10
|
183 <li>Moved the Action ID label on the buttons to the center of the button.</li>
|
|
flickerstreak@10
|
184 <li>Added support for binding right-clicks to hotkeys on the main action buttons
|
|
flickerstreak@10
|
185 only (no pet buttons). There is also an option (off by default) to display
|
|
flickerstreak@10
|
186 and specify the location for right-click binding labels.</li>
|
|
flickerstreak@10
|
187 <li>Tweaked the ordering of the bar menus. Some options will automatically show/hide
|
|
flickerstreak@10
|
188 when they are relevant.</li>
|
|
flickerstreak@10
|
189 <li>Converted the core of the keybinding code to an Ace2-style library: ReBound-1.0</li>
|
|
flickerstreak@10
|
190 <li>Did a little bit of code cleanup in main.lua</li>
|
|
flickerstreak@10
|
191 <li>Converted to MIT license</li>
|
|
flickerstreak@10
|
192 </ul>
|
|
flickerstreak@9
|
193 <p>Version 0.32:</p>
|
|
flickerstreak@9
|
194 <ul>
|
|
flickerstreak@9
|
195 <li>Fixed a bug with displaying cooldowns generating slews of errors</li>
|
|
flickerstreak@9
|
196 </ul>
|
|
flickerstreak@8
|
197 <p>Version 0.31:</p>
|
|
flickerstreak@8
|
198 <ul>
|
|
flickerstreak@8
|
199 <li>Fixed a bug where action IDs > 120 were being configured and allocated
|
|
flickerstreak@8
|
200 in certain cases</li>
|
|
flickerstreak@8
|
201 <li>Fixed a bug where hidden paging controls were reappearing when switching
|
|
flickerstreak@8
|
202 pages</li>
|
|
flickerstreak@8
|
203 <li>Fixed a script error that was popping up in certain conditions when starting
|
|
flickerstreak@8
|
204 keybinding mode, and causing some buttons not to be bindable</li>
|
|
flickerstreak@8
|
205 <li>Applied a fix that will (hopefully?) eliminate errors saying ACTIONBAR_UPDATE_STATE
|
|
flickerstreak@8
|
206 was not registered (be on the lookout for recurrences of that one). Hopefully
|
|
flickerstreak@8
|
207 this fix will eliminate several other intermittent errors that I think are
|
|
flickerstreak@8
|
208 part of the same cause.</li>
|
|
flickerstreak@8
|
209 <li>Added new options for controlling the opacity of buttons (which should now
|
|
flickerstreak@8
|
210 actually work). Previous opacity settings (if any) will be lost and will need
|
|
flickerstreak@8
|
211 to be re-applied after updating. There is also now a toggle to hide (rather
|
|
flickerstreak@8
|
212 than alpha-zero) empty buttons, at the expense of not being able to drag actions
|
|
flickerstreak@8
|
213 onto them during combat.</li>
|
|
flickerstreak@8
|
214 <li>Action IDs now appear/disappear automatically when bars are unlocked. There
|
|
flickerstreak@8
|
215 is no longer a menu item to show/hide them.</li>
|
|
flickerstreak@8
|
216 <li>Changed the default startup bar configuration to only be the paged main
|
|
flickerstreak@8
|
217 bar. This allows a default startup to create new bars without having to delete
|
|
flickerstreak@8
|
218 some first. Will probably simplify even further in a future patch. Note this
|
|
flickerstreak@8
|
219 doesn't fix the action-rearrangement setup headaches with warriors, druids,
|
|
flickerstreak@8
|
220 and rogues.</li>
|
|
flickerstreak@9
|
221 <li>Cooldowns can now be hidden - either all cooldowns or just global cooldowns.</li>
|
|
flickerstreak@8
|
222 </ul>
|
|
flickerstreak@7
|
223 <p>Version 0.3</p>
|
|
flickerstreak@7
|
224 <ul>
|
|
flickerstreak@7
|
225 <li>Complete rewrite of the innards for better modularity</li>
|
|
flickerstreak@7
|
226 <li>Lots of bug fixes</li>
|
|
flickerstreak@7
|
227 <li>Multi-paged bar support</li>
|
|
flickerstreak@7
|
228 <li>Pet bar support</li>
|
|
flickerstreak@7
|
229 <li>Auto stance/form/stealth switching</li>
|
|
flickerstreak@7
|
230 <li>Lots and lots of new configuration options</li>
|
|
flickerstreak@7
|
231 </ul>
|
|
flickerstreak@7
|
232 <p>Version 0.2</p>
|
|
flickerstreak@7
|
233 <ul>
|
|
flickerstreak@7
|
234 <li>Bug fixes from 0.1</li>
|
|
flickerstreak@7
|
235 <li>new keybinding interface</li>
|
|
flickerstreak@7
|
236 </ul>
|
|
flickerstreak@7
|
237 <p>Version 0.1</p>
|
|
flickerstreak@7
|
238 <ul>
|
|
flickerstreak@7
|
239 <li>Initial concept, button arrangement</li>
|
|
flickerstreak@7
|
240 </ul>
|
|
flickerstreak@7
|
241 <h2>Credits</h2>
|
|
flickerstreak@7
|
242 <p>Huge credit to the <a href="http://www.wowace.com">Ace 2</a> development team,
|
|
flickerstreak@7
|
243 whose framework provides a level of functionality that I consider critical to
|
|
flickerstreak@10
|
244 the success of this addon. Similarly, enormous credit goes to <a href="http://ckknight.wowinterface.com">ckknight</a>,
|
|
flickerstreak@7
|
245 whose Dewdrop menuing system and FuBar plugin system are ridiculously easy to
|
|
flickerstreak@7
|
246 use.</p>
|
|
flickerstreak@7
|
247 <p>Finally, thanks to my alpha testers and stalwart adventuring companions: Deor,
|
|
flickerstreak@7
|
248 Nogrim, Sorabel, and Yngvi.</p>
|
|
flickerstreak@10
|
249 <h2>Copyright & License</h2>
|
|
flickerstreak@10
|
250 <p>ReAction is distributed under the MIT license.</p>
|
|
flickerstreak@10
|
251 <p>ReAction Copyright © 2007 Ryan Findley.</p>
|
|
flickerstreak@10
|
252 <p>Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
flickerstreak@10
|
253 of this software and associated documentation files (the "Software"),
|
|
flickerstreak@10
|
254 to deal in the Software without restriction, including without limitation the
|
|
flickerstreak@10
|
255 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
flickerstreak@10
|
256 sell copies of the Software, and to permit persons to whom the Software is furnished
|
|
flickerstreak@10
|
257 to do so, subject to the following conditions:</p>
|
|
flickerstreak@10
|
258 <p>The above copyright notice and this permission notice shall be included in
|
|
flickerstreak@10
|
259 all copies or substantial portions of the Software.</p>
|
|
flickerstreak@10
|
260 <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
flickerstreak@10
|
261 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
flickerstreak@10
|
262 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
flickerstreak@10
|
263 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
flickerstreak@10
|
264 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
|
|
flickerstreak@10
|
265 IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
|
|
flickerstreak@7
|
266 <p>World of Warcraft is a registered trademark of Blizzard Entertainment, Inc.</p>
|
|
flickerstreak@7
|
267 </body>
|
|
flickerstreak@7
|
268 </html>
|
