Mercurial > wow > reaction

comparison README.html @ 12:2735edcf9ab7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Version 0.34
author Flick <flickerstreak@gmail.com>
date Wed, 21 Mar 2007 00:13:27 +0000
parents f3a7bfebc283
children 1b9323256a1b
comparison
equal deleted inserted replaced
11:88df7235ad8b 12:2735edcf9ab7
12 </head> 12 </head>
13 13
14 <body bgcolor="#FFFFFF" text="#000000"> 14 <body bgcolor="#FFFFFF" text="#000000">
15 <h1 align="center">ReAction</h1> 15 <h1 align="center">ReAction</h1>
16 <h3 align="center">AddOn for World of Warcraft</h3> 16 <h3 align="center">AddOn for World of Warcraft</h3>
17 <p><font size="2">Current Version: 0.33 (alpha)<br> 17 <p><font size="2">Current Version: 0.34 (alpha)<br>
18 Released: 02 Mar 2007</font><font size="2"><br> 18 Released: 09 Mar 2007</font><font size="2"><br>
19 WoW Version Compatibility/TOC: 2.0.8 / TOC 20003</font></p> 19 WoW Version Compatibility: v2.0.10 / TOC 20003</font></p>
20 <h2>The Basics</h2> 20 <h2>The Basics</h2>
21 <p>ReAction is a replacement for the default Blizzard action bars. It allows you 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> 22 redefine your action button layout any way you like.</p>
23 <h2>Features</h2> 23 <h2>Features</h2>
24 <ul> 24 <ul>
42 </ul> 42 </ul>
43 <p>ReAction is built using the <a href="http://www.wowace.com/Wiki/Ace2">Ace2</a> 43 <p>ReAction is built using the <a href="http://www.wowace.com/Wiki/Ace2">Ace2</a>
44 development framework.</p> 44 development framework.</p>
45 <h2>Using ReAction</h2> 45 <h2>Using ReAction</h2>
46 <h3>Installation</h3> 46 <h3>Installation</h3>
47 <p>To install ReAction, drag the ReAction folder to World of Warcraft/Interface/AddOns. 47 <p>To install ReAction, drag the ReAction folder to your World of Warcraft/Interface/AddOns
48 Exit World of Warcraft if it's running, then restart.</p> 48 folder. Exit World of Warcraft if it's running, then restart.</p>
49 <h3>Welcome to ReAction</h3> 49 <h3>Welcome to ReAction</h3>
50 <p>When you first enter World of Warcraft with ReAction installed, it will look 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 51 very similar to the default Blizzard UI, depending on what other AddOns are
52 installed. Any keybindings you have made to the action bars, however, are not 52 installed. However, only the main menu bar is shown by default. Other bars can
53 in effect. Also, only the main menu bar is shown by default. Other bars can
54 be created as desired.</p> 53 be created as desired.</p>
55 <p>If you have FuBar installed, on the left side you should see the ReAction plugin 54 <p>If you have FuBar installed, on the left side you should see the ReAction plugin
56 icon and label. If not, there should be a button on your minimap. In either 55 icon and label. If not, there should be a button on your minimap. In either
57 case, that button (the ReAction Control Button) is the gateway to configuring 56 case, that button (the ReAction Control Button) is the gateway to configuring
58 ReAction.</p> 57 ReAction.</p>
60 <ul> 59 <ul>
61 <li>Normal (&quot;locked&quot;)</li> 60 <li>Normal (&quot;locked&quot;)</li>
62 <li>Configuration (&quot;unlocked&quot;)</li> 61 <li>Configuration (&quot;unlocked&quot;)</li>
63 <li>Keybinding</li> 62 <li>Keybinding</li>
64 </ul> 63 </ul>
64 <p>(Technically it's 4 modes, because Config and Keybinding modes can both be
65 active at the same time).</p>
65 <p>You can toggle Configuration mode by shift-clicking the ReAction Control Button 66 <p>You can toggle Configuration mode by shift-clicking the ReAction Control Button
66 and toggle Keybinding mode by alt-clicking the button. Global configuration 67 and toggle Keybinding mode by alt-clicking the button. Global configuration
67 options are also available by right-clicking the ReAction button. There are 68 options are also available by right-clicking the ReAction button. There are
68 also a limited set of console commands that can be accessed with the &quot;/reaction&quot; 69 also a limited set of console commands that can be accessed with the &quot;/reaction&quot;
69 or &quot;/rxn&quot; slash-commands. Type /rxn in the chat box to print a list 70 or &quot;/rxn&quot; slash-commands. Type /rxn in the chat box to print a list
86 <p><b>ReAction buttons don't use the regular keybindings of the default UI.</b> 87 <p><b>ReAction buttons don't use the regular keybindings of the default UI.</b>
87 In order to get your buttons to use hotkeys, enter ReAction Keybinding Setup 88 In order to get your buttons to use hotkeys, enter ReAction Keybinding Setup
88 mode by alt-clicking the ReAction Control Button (or choosing 'keybinding mode' 89 mode by alt-clicking the ReAction Control Button (or choosing 'keybinding mode'
89 from the right-click menu). <b>ReAction button keybindings are not available 90 from the right-click menu). <b>ReAction button keybindings are not available
90 from the standard keybindings menu!</b> You <i>must</i> use the ReAction keybinding 91 from the standard keybindings menu!</b> You <i>must</i> use the ReAction keybinding
91 interface. They're even greyed out in the keybinding menu to remind you.</p> 92 interface. They're even greyed out in the keybinding menu with a textual reminder,
93 so there's no excuse!</p>
92 <p>Like configuration mode, normal button operation is disabled while in keybinding 94 <p>Like configuration mode, normal button operation is disabled while in keybinding
93 mode (though again, any hotkeys you have assigned will work).</p> 95 mode (though again, any hotkeys you have assigned will work). With the keybinding
94 <p>With the keybinding interface out, you can mouseover any ReAction button to 96 interface out, you can mouseover any ReAction button to see what its current
95 see what its current keybinding is. You can set the keybinding on a button by 97 keybinding is. You can set the keybinding on a button by clicking the button,
96 clicking the button, then pressing the key. To clear a keybinding from a ReAction 98 then pressing the key. To clear a keybinding from a ReAction button, shift-click
97 button, shift-click the button. Tooltips will remind you of this interface. 99 the button. Tooltips will remind you of this interface. You can also right-click/shift-right-click
98 You can also right-click/shift-right-click to set/clear a right-click hotkey, 100 to set/clear a right-click hotkey, which will simulate right-clicking the button
99 which will simulate right-clicking the button (useful for complex macros, typically 101 (useful for complex macro actions, typically to save screen real estate). If
100 to save screen real estate). If you've set up bars with multiple pages, you 102 you've set up bars with multiple pages, you can also bind a key to the page
101 can also bind a key to the page up/down buttons on a per-bar basis. Just make 103 up/down buttons on a per-bar basis. Just make sure the buttons are showing (they
102 sure the buttons are showing (they can be hidden later) and assign the keybinding 104 can be hidden later) and assign the keybinding like any other ReAction button.</p>
103 like any other ReAction button.</p> 105 <p>Keybindings are saved on a per-profile basis. Keybinding mode is not available
104 <p>Keybindings are saved on a per-character basis. Keybinding mode is not available
105 if you are in combat, and is automatically cancelled if you enter combat. When 106 if you are in combat, and is automatically cancelled if you enter combat. When
106 you first log in with ReAction, it steals the keybindings from the default main 107 you first log in with ReAction, it steals the current keybindings from the default
107 action bar (buttons 1-12) and assigns them to the corresponding buttons on the 108 main action bar (buttons 1-12) and assigns them to the corresponding buttons
108 default ReAction bar.</p> 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>
109 <p><b>Remember to click the 'Save' button to save your keybindings! </b>If you 120 <p><b>Remember to click the 'Save' button to save your keybindings! </b>If you
110 do not, they will automatically revert to the previous bindings when exiting 121 do not, they will automatically revert to the previous bindings when exiting
111 keybinding mode. This can be useful for &quot;trying out&quot; certain layouts 122 keybinding mode. This can be useful for &quot;trying out&quot; certain layouts
112 briefly, but can also be a serious gotcha &#151; if you just hit 'Escape,' or 123 briefly, but can also be a serious gotcha &#151; if you just hit 'Escape,' or
113 alt-click the ReAction Control Button, or enter combat while in keybinding mode, 124 alt-click the ReAction Control Button, or enter combat while in keybinding mode,
119 create a new bar, rearrange bars, hide/show a special-use bar, etc. Perfect 130 create a new bar, rearrange bars, hide/show a special-use bar, etc. Perfect
120 for when you get some goofy quest item that has to be used temporarily, or get 131 for when you get some goofy quest item that has to be used temporarily, or get
121 a new skill that doesn't fit on your current layout.</p> 132 a new skill that doesn't fit on your current layout.</p>
122 <h2>Limitations</h2> 133 <h2>Limitations</h2>
123 <ul> 134 <ul>
124 <li>Due to a lack of certain functionality being made available by Blizzard, 135 <li>Due to a lack of certain functionality made available by Blizzard, dragging
125 dragging and dropping actions onto action bars while in combat is a little 136 and dropping actions onto action bars while in combat is a little funky. You
126 funky. You have to click the destination button rather than just release drag 137 have to click the destination button rather than just release drag on it.</li>
127 on it.</li> 138 <li>You can't configure the pet bar unless you actually have a pet out. </li>
128 <li>You can't configure the pet bar unless you actually have a pet out at the
129 moment. </li>
130 <li>No support for shapeshift/stance bar (yet)</li> 139 <li>No support for shapeshift/stance bar (yet)</li>
131 <li>If you have a bar with empty buttons, even though they're invisible they 140 <li>If you have a bar with empty buttons, even though they're invisible they
132 still block mouse input from reaching whatever might be under the button. 141 still block mouse input from reaching whatever might be under the button.
133 This is a workaround so that you can drag and drop actions onto hidden slots 142 This is a workaround so that you can drag and drop actions onto hidden slots
134 during combat. This workaround can be disabled via a configuration option, 143 during combat. This workaround can be disabled via a configuration option,
135 but then you can't drag and drop actions onto slots during combat. Pick your 144 but then you can't drag and drop actions onto slots during combat. Pick your
136 poison, it's a limitation of Blizzard's protection scheme.</li> 145 poison, it's a limitation of Blizzard's protection scheme.</li>
137 <li>If you hide the default main menu bar, there is no substitute provided for 146 <li>If you hide the default main menu bar, there is no substitute provided (yet)
138 the XP bar, bag bar, or micro menu bar (although the hotkeys for them still 147 for the XP bar, bag bar, or micro menu bar (although the hotkeys for them
139 work). Other addons can provide these features until ReAction supports them.</li> 148 still work). Other addons can provide these features until ReAction supports
149 them.</li>
140 </ul> 150 </ul>
141 <h2>Known Issues</h2> 151 <h2>Known Issues</h2>
142 <ul> 152 <ul>
143 <li>There may or may not be a particular case in which turning off a pet's attack 153 <li>There may or may not be a particular case in which turning off a pet's attack
144 while using Eyes of the Beast doesn't work. Further investigation (and leveling 154 while using Eyes of the Beast doesn't work. Further investigation (and leveling
145 a hunter to get Eyes of the Beast :-P) is required.</li> 155 a hunter to get Eyes of the Beast :-P) is required.</li>
146 <li>The initial mapping of action IDs for shapeshift forms doesn't exactly match 156 <li>The initial mapping of action IDs for shapeshift forms doesn't exactly match
147 Blizzard's mapping. When first starting up as a warrior, druid, or rogue, 157 Blizzard's mapping. When first starting up as a warrior, druid, or rogue,
148 you will probably need to move your actions around.</li> 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>
149 <li>Action IDs may not always be laid out in sequence, meaning that similar 160 <li>Action IDs may not always be laid out in sequence, meaning that similar
150 layouts on different machines may put the actions in a different order.</li> 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>
151 <li>There seems to be a big performance hit when first dragging a bar after 164 <li>There seems to be a big performance hit when first dragging a bar after
152 entering configuration mode, and when first enabling keybinding mode. More 165 entering configuration mode, and when first enabling keybinding mode, if there
153 investigation is necessary.</li> 166 are several bars and a lot of buttons out. More investigation is necessary.</li>
154 </ul> 167 </ul>
155 <h2>Future Plans</h2> 168 <h2>Future Plans</h2>
156 <ul> 169 <ul>
157 <li>Add support for bag bar, shapeshift bar, and micro menu bar. May also add 170 <li>Add support for bag bar, shapeshift bar, and micro menu bar. May also add
158 XP bar to default unit frames for those who don't want to use a unit frame 171 XP bar to default unit frames for those who don't want to use a unit frame
168 <li>Provide some additional console commands so that enterprising users can 181 <li>Provide some additional console commands so that enterprising users can
169 macro certain configuration functionality (notably hiding and showing individual 182 macro certain configuration functionality (notably hiding and showing individual
170 bars) </li> 183 bars) </li>
171 <li>Yet more configurable button display options (disable cooldown flash, different 184 <li>Yet more configurable button display options (disable cooldown flash, different
172 borders, etc)</li> 185 borders, etc)</li>
186 <li>Button styles (Dreamlayout, CyCircled)</li>
173 <li>Localization</li> 187 <li>Localization</li>
174 </ul> 188 </ul>
175 <h2>Version History</h2> 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>
176 <p>Version 0.33:</p> 195 <p>Version 0.33:</p>
177 <ul> 196 <ul>
178 <li>Rewrote the keybinding interface (again). I think I finally like this version. 197 <li>Rewrote the keybinding interface (again). I think I finally like this version.
179 Keybindings are now saved and loaded with the profile, and honor the &quot;character-specific 198 Keybindings are now saved and loaded with the profile, and honor the &quot;character-specific
180 keybindings&quot; setting in the Blizzard Keybinding pane. The default keybindings 199 keybindings&quot; setting in the Blizzard Keybinding pane. The default keybindings
242 <p>Huge credit to the <a href="http://www.wowace.com">Ace 2</a> development team, 261 <p>Huge credit to the <a href="http://www.wowace.com">Ace 2</a> development team,
243 whose framework provides a level of functionality that I consider critical to 262 whose framework provides a level of functionality that I consider critical to
244 the success of this addon. Similarly, enormous credit goes to <a href="http://ckknight.wowinterface.com">ckknight</a>, 263 the success of this addon. Similarly, enormous credit goes to <a href="http://ckknight.wowinterface.com">ckknight</a>,
245 whose Dewdrop menuing system and FuBar plugin system are ridiculously easy to 264 whose Dewdrop menuing system and FuBar plugin system are ridiculously easy to
246 use.</p> 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>
247 <p>Finally, thanks to my alpha testers and stalwart adventuring companions: Deor, 271 <p>Finally, thanks to my alpha testers and stalwart adventuring companions: Deor,
248 Nogrim, Sorabel, and Yngvi.</p> 272 Nogrim, Sorabel, and Yngvi (or, more to the point, their alts :-P).</p>
249 <h2>Copyright &amp; License</h2> 273 <h2>Copyright &amp; License</h2>
250 <p>ReAction is distributed under the MIT license.</p> 274 <p>ReAction is distributed under the MIT license.</p>
251 <p>ReAction Copyright &copy; 2007 Ryan Findley.</p> 275 <p>ReAction Copyright &copy; 2007 Ryan Findley.</p>
252 <p>Permission is hereby granted, free of charge, to any person obtaining a copy 276 <p>Permission is hereby granted, free of charge, to any person obtaining a copy
253 of this software and associated documentation files (the &quot;Software&quot;), 277 of this software and associated documentation files (the &quot;Software&quot;),