Mercurial > wow > reaction

comparison README.html @ 22:1b9323256a1b

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