Mercurial > wow > reaction

comparison README.html @ 10:f3a7bfebc283

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Version 0.33
author Flick <flickerstreak@gmail.com>
date Tue, 20 Mar 2007 21:37:38 +0000
parents 650f75d08952
children 2735edcf9ab7
comparison
equal deleted inserted replaced
9:650f75d08952 10:f3a7bfebc283
1 <html> 1 <html>
2 <head> 2 <head>
3 <title>ReAction: README</title> 3 <title>ReAction: README</title>
4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> 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>
5 </head> 12 </head>
6 13
7 <body bgcolor="#FFFFFF" text="#000000"> 14 <body bgcolor="#FFFFFF" text="#000000">
8 <h1 align="center">ReAction</h1> 15 <h1 align="center">ReAction</h1>
9 <h3 align="center">AddOn for World of Warcraft</h3> 16 <h3 align="center">AddOn for World of Warcraft</h3>
10 <p><font size="2">Current Version: 0.32 (alpha)<br> 17 <p><font size="2">Current Version: 0.33 (alpha)<br>
11 Released: 03 Feb 2007</font><font size="2"><br> 18 Released: 02 Mar 2007</font><font size="2"><br>
12 WoW Version Compatibility/TOC: 2.0.6 / TOC 20003</font></p> 19 WoW Version Compatibility/TOC: 2.0.8 / TOC 20003</font></p>
13 <h2>The Basics</h2> 20 <h2>The Basics</h2>
14 <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
15 redefine your action button layout any way you like.</p> 22 redefine your action button layout any way you like.</p>
16 <h2>Features</h2> 23 <h2>Features</h2>
17 <ul> 24 <ul>
21 <li>Works with all types of actions, including abilities, items, and macros</li> 28 <li>Works with all types of actions, including abilities, items, and macros</li>
22 <li>Layout is done with the mouse, by dragging bars and bar edges on screen. 29 <li>Layout is done with the mouse, by dragging bars and bar edges on screen.
23 Automatically anchor bars to each other or the screen edges by holding shift 30 Automatically anchor bars to each other or the screen edges by holding shift
24 down as you drag.</li> 31 down as you drag.</li>
25 <li>Context menus provide independent configuration options for each bar.</li> 32 <li>Context menus provide independent configuration options for each bar.</li>
26 <li>Point and click keybinding interface.</li> 33 <li>Point and click keybinding interface. You can bind keys to left-click or
34 right-click independently.</li>
27 <li>Supports multiple 'pages' per bar, configured independently. Automatic stance, 35 <li>Supports multiple 'pages' per bar, configured independently. Automatic stance,
28 form, and stealth switching among pages is supported, including Shadowform.</li> 36 form, and stealth switching among pages is supported, including Shadowform.</li>
29 <li>Pet action bar is fully supported and configurable.</li> 37 <li>Pet action bar is fully supported and configurable.</li>
30 <li>Settings can be saved per account, realm, character, class, or independent 38 <li>Settings can be saved per account, realm, character, class, or independent
31 profile. </li> 39 profile. </li>
78 <p><b>ReAction buttons don't use the regular keybindings of the default UI.</b> 86 <p><b>ReAction buttons don't use the regular keybindings of the default UI.</b>
79 In order to get your buttons to use hotkeys, enter ReAction Keybinding Setup 87 In order to get your buttons to use hotkeys, enter ReAction Keybinding Setup
80 mode by alt-clicking the ReAction Control Button (or choosing 'keybinding mode' 88 mode by alt-clicking the ReAction Control Button (or choosing 'keybinding mode'
81 from the right-click menu). <b>ReAction button keybindings are not available 89 from the right-click menu). <b>ReAction button keybindings are not available
82 from the standard keybindings menu!</b> You <i>must</i> use the ReAction keybinding 90 from the standard keybindings menu!</b> You <i>must</i> use the ReAction keybinding
83 interface.</p> 91 interface. They're even greyed out in the keybinding menu to remind you.</p>
84 <p>Like configuration mode, normal button operation is disabled while in keybinding 92 <p>Like configuration mode, normal button operation is disabled while in keybinding
85 mode (though again, any hotkeys you have assigned will work).</p> 93 mode (though again, any hotkeys you have assigned will work).</p>
86 <p>With the keybinding interface out, you can mouseover any ReAction button to 94 <p>With the keybinding interface out, you can mouseover any ReAction button to
87 see what its current keybinding is. You can set the keybinding on a button by 95 see what its current keybinding is. You can set the keybinding on a button by
88 pressing the key, then clicking the button. To clear a keybinding from a ReAction 96 clicking the button, then pressing the key. To clear a keybinding from a ReAction
89 button, right-click the button. If you've set up bars with multiple pages, you 97 button, shift-click the button. Tooltips will remind you of this interface.
98 You can also right-click/shift-right-click to set/clear a right-click hotkey,
99 which will simulate right-clicking the button (useful for complex macros, typically
100 to save screen real estate). If you've set up bars with multiple pages, you
90 can also bind a key to the page up/down buttons on a per-bar basis. Just make 101 can also bind a key to the page up/down buttons on a per-bar basis. Just make
91 sure the buttons are showing (they can be hidden later) and assign the keybinding 102 sure the buttons are showing (they can be hidden later) and assign the keybinding
92 like any other ReAction button.</p> 103 like any other ReAction button.</p>
93 <p>Keybindings are saved on a per-character basis. Keybinding mode is not available 104 <p>Keybindings are saved on a per-character basis. Keybinding mode is not available
94 if you are in combat, and is automatically cancelled if you enter combat.</p> 105 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 action bar (buttons 1-12) and assigns them to the corresponding buttons on the
108 default ReAction bar.</p>
109 <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
111 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
113 alt-click the ReAction Control Button, or enter combat while in keybinding mode,
114 your bindings will revert to their previous state.</p>
95 <h3>Playing with ReAction</h3> 115 <h3>Playing with ReAction</h3>
96 <p>Once you get your keybindings and configuration set up, you're ready to go. 116 <p>Once you get your keybindings and configuration set up, you're ready to go.
97 The buttons behave just like regular Blizzard buttons. However, at any time 117 The buttons behave just like regular Blizzard buttons. However, at any time
98 when you're not in combat, you can quickly switch to configuration mode and 118 when you're not in combat, you can quickly switch to configuration mode and
99 create a new bar, rearrange bars, hide/show a special-use bar, etc. Perfect 119 create a new bar, rearrange bars, hide/show a special-use bar, etc. Perfect
112 still block mouse input from reaching whatever might be under the button. 132 still block mouse input from reaching whatever might be under the button.
113 This is a workaround so that you can drag and drop actions onto hidden slots 133 This is a workaround so that you can drag and drop actions onto hidden slots
114 during combat. This workaround can be disabled via a configuration option, 134 during combat. This workaround can be disabled via a configuration option,
115 but then you can't drag and drop actions onto slots during combat. Pick your 135 but then you can't drag and drop actions onto slots during combat. Pick your
116 poison, it's a limitation of Blizzard's protection scheme.</li> 136 poison, it's a limitation of Blizzard's protection scheme.</li>
117 <li>If you hide the default main menu bar, there is no substitute for the XP 137 <li>If you hide the default main menu bar, there is no substitute provided for
118 bar, bag bar, or micro menu bar (although the hotkeys for them still work)</li> 138 the XP bar, bag bar, or micro menu bar (although the hotkeys for them still
139 work). Other addons can provide these features until ReAction supports them.</li>
119 </ul> 140 </ul>
120 <h2>Known Issues</h2> 141 <h2>Known Issues</h2>
121 <ul> 142 <ul>
122 <li>There may or may not be a particular case in which turning off a pet's attack 143 <li>There may or may not be a particular case in which turning off a pet's attack
123 while using Eyes of the Beast doesn't work. Further investigation (and leveling 144 while using Eyes of the Beast doesn't work. Further investigation (and leveling
125 <li>The initial mapping of action IDs for shapeshift forms doesn't exactly match 146 <li>The initial mapping of action IDs for shapeshift forms doesn't exactly match
126 Blizzard's mapping. When first starting up as a warrior, druid, or rogue, 147 Blizzard's mapping. When first starting up as a warrior, druid, or rogue,
127 you will probably need to move your actions around.</li> 148 you will probably need to move your actions around.</li>
128 <li>Action IDs may not always be laid out in sequence, meaning that similar 149 <li>Action IDs may not always be laid out in sequence, meaning that similar
129 layouts on different machines may put the actions in a different order.</li> 150 layouts on different machines may put the actions in a different order.</li>
130 <li>Keybindings are only saved per character, which causes problems when switching
131 profiles.</li>
132 <li>There seems to be a big performance hit when first dragging a bar after 151 <li>There seems to be a big performance hit when first dragging a bar after
133 entering configuration mode, and when first enabling keybinding mode.</li> 152 entering configuration mode, and when first enabling keybinding mode. More
153 investigation is necessary.</li>
134 </ul> 154 </ul>
135 <h2>Future Plans</h2> 155 <h2>Future Plans</h2>
136 <ul> 156 <ul>
137 <li>Use override bindings for the keybindings, and automatically switch with
138 profiles. Also &quot;steal&quot; bindings from the default UI on first run
139 so that they're populated with something reasonable.</li>
140 <li>Add support for bag bar, shapeshift bar, and micro menu bar. May also add 157 <li>Add support for bag bar, shapeshift bar, and micro menu bar. May also add
141 XP bar to default unit frames for those who don't want to use a unit frame 158 XP bar to default unit frames for those who don't want to use a unit frame
142 addon to get the XP bar back.</li> 159 addon to get the XP bar back.</li>
143 <li>More dynamic bar support: auto show/hide/fade on stance switch, in combat, 160 <li>More dynamic bar support: auto show/hide/fade on stance switch, in combat,
144 key pressed, etc.</li> 161 key pressed, etc.</li>
154 <li>Yet more configurable button display options (disable cooldown flash, different 171 <li>Yet more configurable button display options (disable cooldown flash, different
155 borders, etc)</li> 172 borders, etc)</li>
156 <li>Localization</li> 173 <li>Localization</li>
157 </ul> 174 </ul>
158 <h2>Version History</h2> 175 <h2>Version History</h2>
176 <p>Version 0.33:</p>
177 <ul>
178 <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
180 keybindings&quot; setting in the Blizzard Keybinding pane. The default keybindings
181 for action bars are now greyed out in Blizzard's interface to remind you to
182 use ReAction to set bindings for action bars.</li>
183 <li>Moved the Action ID label on the buttons to the center of the button.</li>
184 <li>Added support for binding right-clicks to hotkeys on the main action buttons
185 only (no pet buttons). There is also an option (off by default) to display
186 and specify the location for right-click binding labels.</li>
187 <li>Tweaked the ordering of the bar menus. Some options will automatically show/hide
188 when they are relevant.</li>
189 <li>Converted the core of the keybinding code to an Ace2-style library: ReBound-1.0</li>
190 <li>Did a little bit of code cleanup in main.lua</li>
191 <li>Converted to MIT license</li>
192 </ul>
159 <p>Version 0.32:</p> 193 <p>Version 0.32:</p>
160 <ul> 194 <ul>
161 <li>Fixed a bug with displaying cooldowns generating slews of errors</li> 195 <li>Fixed a bug with displaying cooldowns generating slews of errors</li>
162 </ul> 196 </ul>
163 <p>Version 0.31:</p> 197 <p>Version 0.31:</p>
205 <li>Initial concept, button arrangement</li> 239 <li>Initial concept, button arrangement</li>
206 </ul> 240 </ul>
207 <h2>Credits</h2> 241 <h2>Credits</h2>
208 <p>Huge credit to the <a href="http://www.wowace.com">Ace 2</a> development team, 242 <p>Huge credit to the <a href="http://www.wowace.com">Ace 2</a> development team,
209 whose framework provides a level of functionality that I consider critical to 243 whose framework provides a level of functionality that I consider critical to
210 the success of this addon.</p> 244 the success of this addon. Similarly, enormous credit goes to <a href="http://ckknight.wowinterface.com">ckknight</a>,
211 <p>Similarly, enormous credit goes to <a href="http://ckknight.wowinterface.com">ckknight</a>,
212 whose Dewdrop menuing system and FuBar plugin system are ridiculously easy to 245 whose Dewdrop menuing system and FuBar plugin system are ridiculously easy to
213 use.</p> 246 use.</p>
214 <p>Finally, thanks to my alpha testers and stalwart adventuring companions: Deor, 247 <p>Finally, thanks to my alpha testers and stalwart adventuring companions: Deor,
215 Nogrim, Sorabel, and Yngvi.</p> 248 Nogrim, Sorabel, and Yngvi.</p>
216 <h2>Copyright</h2> 249 <h2>Copyright &amp; License</h2>
217 <p>ReAction &copy; 2007 by Ryan Findley.</p> 250 <p>ReAction is distributed under the MIT license.</p>
218 <p>You are free to distribute this AddOn package without notice to the author, 251 <p>ReAction Copyright &copy; 2007 Ryan Findley.</p>
219 as long as the package is unmodified, this readme.html file accompanies the 252 <p>Permission is hereby granted, free of charge, to any person obtaining a copy
220 distribution, and no claim of authorship of the contents of the package is made. 253 of this software and associated documentation files (the &quot;Software&quot;),
221 Derived works are expressly permitted but must be clearly labeled as not the 254 to deal in the Software without restriction, including without limitation the
222 work of the original author and packaged separately, with credit given to the 255 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
223 original author. Inclusion of this package within a compilation is expressly 256 sell copies of the Software, and to permit persons to whom the Software is furnished
224 permitted.</p> 257 to do so, subject to the following conditions:</p>
225 <p>The author expressly disclaims any warranty of any kind for the material contained 258 <p>The above copyright notice and this permission notice shall be included in
226 in this package. USE AT YOUR OWN RISK.</p> 259 all copies or substantial portions of the Software.</p>
227 <p>All files in this package under the 'libs/' directory are libraries made available 260 <p>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS
228 by <a href="http://www.wowace.com">WoWAce</a>, and are not the work of this 261 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
229 author.</p> 262 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
263 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
264 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
265 IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
230 <p>World of Warcraft is a registered trademark of Blizzard Entertainment, Inc.</p> 266 <p>World of Warcraft is a registered trademark of Blizzard Entertainment, Inc.</p>
231 </body> 267 </body>
232 </html> 268 </html>