annotate README.html @ 7:f920db5fc6b1

version 0.3
author Flick <flickerstreak@gmail.com>
date Tue, 20 Mar 2007 21:25:29 +0000
parents
children c05fd3e18b4f
rev   line source
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@7 5 </head>
flickerstreak@7 6
flickerstreak@7 7 <body bgcolor="#FFFFFF" text="#000000">
flickerstreak@7 8 <h1 align="center">ReAction</h1>
flickerstreak@7 9 <h3 align="center">AddOn for World of Warcraft</h3>
flickerstreak@7 10 <p><font size="2">Current Version: 0.3 (beta)<br>
flickerstreak@7 11 Released: 29 Jan 2007</font><font size="2"><br>
flickerstreak@7 12 WoW Version Compatibility/TOC: 2.0.6 / TOC 20003</font></p>
flickerstreak@7 13 <h2>The Basics</h2>
flickerstreak@7 14 <p>ReAction is a replacement for the default Blizzard action bars. It allows you
flickerstreak@7 15 redefine your action button layout any way you like.</p>
flickerstreak@7 16 <h2>Features</h2>
flickerstreak@7 17 <ul>
flickerstreak@7 18 <li>Move, resize, create, and arrange as many action bars as you want. Each
flickerstreak@7 19 bar can contain any number of buttons arranged in a grid layout of any size
flickerstreak@7 20 and spacing. The full complement of 120 action slots is supported.</li>
flickerstreak@7 21 <li>Works with all types of actions, including abilities, items, and macros</li>
flickerstreak@7 22 <li>Layout is done with the mouse, by dragging bars and bar edges on screen.
flickerstreak@7 23 Automatically anchor bars to each other or the screen edges by holding shift
flickerstreak@7 24 down as you drag.</li>
flickerstreak@7 25 <li>Context menus provide independent configuration options for each bar.</li>
flickerstreak@7 26 <li>Point and click keybinding interface.</li>
flickerstreak@7 27 <li>Supports multiple 'pages' per bar, configured independently. Automatic stance,
flickerstreak@7 28 form, and stealth switching among pages is supported, including Shadowform.</li>
flickerstreak@7 29 <li>Pet action bar is fully supported and configurable.</li>
flickerstreak@7 30 <li>Settings can be saved per account, realm, character, class, or independent
flickerstreak@7 31 profile. </li>
flickerstreak@7 32 <li>Compatible with OmniCC</li>
flickerstreak@7 33 </ul>
flickerstreak@7 34 <p>ReAction is built using the <a href="http://www.wowace.com/Wiki/Ace2">Ace2</a>
flickerstreak@7 35 development framework.</p>
flickerstreak@7 36 <h2>Using ReAction</h2>
flickerstreak@7 37 <h3>Installation</h3>
flickerstreak@7 38 <p>To install ReAction, drag the ReAction folder to World of Warcraft/Interface/AddOns.
flickerstreak@7 39 Exit World of Warcraft if it's running, then restart.</p>
flickerstreak@7 40 <h3>Welcome to ReAction</h3>
flickerstreak@7 41 <p>When you first enter World of Warcraft with ReAction installed, it will look
flickerstreak@7 42 very similar to the default Blizzard UI, depending on what other AddOns are
flickerstreak@7 43 installed. Any keybindings you have made to the action bars, however, are not
flickerstreak@7 44 in effect. Also, only the main menu bar is shown by default. The bottom left,
flickerstreak@7 45 bottom right, and two right action bars are hidden.</p>
flickerstreak@7 46 <p>If you have FuBar installed, on the left side you should see the ReAction plugin
flickerstreak@7 47 icon and label. If not, there should be a button on your minimap. In either
flickerstreak@7 48 case, that button (the ReAction Control Button) is the gateway to configuring
flickerstreak@7 49 ReAction.</p>
flickerstreak@7 50 <p>ReAction has three modes of operation:</p>
flickerstreak@7 51 <ul>
flickerstreak@7 52 <li>Normal (&quot;locked&quot;)</li>
flickerstreak@7 53 <li>Configuration (&quot;unlocked&quot;)</li>
flickerstreak@7 54 <li>Keybinding</li>
flickerstreak@7 55 </ul>
flickerstreak@7 56 <p>You can toggle Configuration mode by shift-clicking the ReAction Control Button
flickerstreak@7 57 and toggle Keybinding mode by alt-clicking the button. Global configuration
flickerstreak@7 58 options are also available by right-clicking the ReAction button. There are
flickerstreak@7 59 also a limited set of console commands that can be accessed with the &quot;/reaction&quot;
flickerstreak@7 60 or &quot;/rxn&quot; slash-commands. Type /rxn in the chat box to print a list
flickerstreak@7 61 of commands.</p>
flickerstreak@7 62 <p>You can also set key bindings to toggle Configuration and Keybinding modes,
flickerstreak@7 63 in the standard UI keybindings panel.</p>
flickerstreak@7 64 <h3>Configuring ReAction</h3>
flickerstreak@7 65 <p>Start by shift-clicking the ReAction button to enter Configuration mode. All
flickerstreak@7 66 bars, including hidden bars, are shown in this mode and <b>normal button click
flickerstreak@7 67 operation is disabled </b>(though keybindings still work). Mouse over the bars,
flickerstreak@7 68 edges, and corners to see tooltip instructions for moving, resizing, and rearranging
flickerstreak@7 69 them. Right click each bar for a menu of options pertaining to that bar. For
flickerstreak@7 70 example, to change a hidden bar to a visible bar, right-click on a bar and choose
flickerstreak@7 71 Visibility -&gt; Always Visible. Tooltips for each menu option provide details.</p>
flickerstreak@7 72 <p>When you're done configuring ReAction, shift-click the ReAction button again
flickerstreak@7 73 to go back to Normal mode.</p>
flickerstreak@7 74 <p>Configuration mode is not available if you are in combat, and is automatically
flickerstreak@7 75 cancelled if you enter combat.</p>
flickerstreak@7 76 <h3>Setting Keybindings</h3>
flickerstreak@7 77 <p><b>ReAction buttons don't use the regular keybindings of the default UI.</b>
flickerstreak@7 78 In order to get your buttons to use hotkeys, enter ReAction Keybinding Setup
flickerstreak@7 79 mode by alt-clicking the ReAction Control Button (or choosing 'keybinding mode'
flickerstreak@7 80 from the right-click menu). <b>ReAction button keybindings are not available
flickerstreak@7 81 from the standard keybindings menu!</b> You <i>must</i> use the ReAction keybinding
flickerstreak@7 82 interface.</p>
flickerstreak@7 83 <p>Like configuration mode, normal button operation is disabled while in keybinding
flickerstreak@7 84 mode (though again, any hotkeys you have assigned will work).</p>
flickerstreak@7 85 <p>With the keybinding interface out, you can mouseover any ReAction button to
flickerstreak@7 86 see what its current keybinding is. You can set the keybinding on a button by
flickerstreak@7 87 pressing the key, then clicking the button. To clear a keybinding from a ReAction
flickerstreak@7 88 button, right-click the button. If you've set up bars with multiple pages, you
flickerstreak@7 89 can also bind a key to the page up/down buttons on a per-bar basis. Just make
flickerstreak@7 90 sure the buttons are showing (they can be hidden later) and assign the keybinding
flickerstreak@7 91 like any other ReAction button.</p>
flickerstreak@7 92 <p>Keybindings are saved on a per-character basis. Keybinding mode is not available
flickerstreak@7 93 if you are in combat, and is automatically cancelled if you enter combat.</p>
flickerstreak@7 94 <h3>Playing with ReAction</h3>
flickerstreak@7 95 <p>Once you get your keybindings and configuration set up, you're ready to go.
flickerstreak@7 96 The buttons behave just like regular Blizzard buttons. However, at any time
flickerstreak@7 97 when you're not in combat, you can quickly switch to configuration mode and
flickerstreak@7 98 create a new bar, rearrange bars, hide/show a special-use bar, etc. Perfect
flickerstreak@7 99 for when you get some goofy quest item that has to be used temporarily, or get
flickerstreak@7 100 a new skill that doesn't fit on your current layout.</p>
flickerstreak@7 101 <h2>Limitations</h2>
flickerstreak@7 102 <ul>
flickerstreak@7 103 <li>Due to a lack of certain functionality being made available by Blizzard,
flickerstreak@7 104 dragging and dropping actions onto action bars while in combat is a little
flickerstreak@7 105 funky. You have to click the destination button rather than just release drag
flickerstreak@7 106 on it.</li>
flickerstreak@7 107 <li>You can't configure the pet bar unless you actually have a pet out at the
flickerstreak@7 108 moment. </li>
flickerstreak@7 109 <li>No support for shapeshift/stance bar (yet)</li>
flickerstreak@7 110 <li>If you have a bar with empty buttons, even though they're invisible they
flickerstreak@7 111 still block mouse input from reaching whatever might be under the button.
flickerstreak@7 112 This is a workaround so that you can drag and drop actions onto hidden slots
flickerstreak@7 113 during combat.</li>
flickerstreak@7 114 <li>If you hide the default main menu bar, there is no substitute for the XP
flickerstreak@7 115 bar, bag bar, or micro menu bar (although the hotkeys for them still work)</li>
flickerstreak@7 116 <li>The pet bar, by default, appears underneath bar #6 (lower left). You'll
flickerstreak@7 117 have to move bar 6 out of the way if you want to move the pet bar. Also, it
flickerstreak@7 118 does not</li>
flickerstreak@7 119 </ul>
flickerstreak@7 120 <h2>Known Issues</h2>
flickerstreak@7 121 <ul>
flickerstreak@7 122 <li>There may or may not be a particular case in which turning off a pet's attack
flickerstreak@7 123 while using Eyes of the Beast doesn't work. Further investigation (and leveling
flickerstreak@7 124 a hunter to get Eyes of the Beast :-P) is required.</li>
flickerstreak@7 125 <li>The initial mapping of action IDs for shapeshift forms doesn't exactly match
flickerstreak@7 126 Blizzard's mapping. When first starting up as a warrior, druid, or rogue,
flickerstreak@7 127 you will probably need to move your actions around.</li>
flickerstreak@7 128 <li>Action IDs may not always be laid out in sequence, meaning that similar
flickerstreak@7 129 layouts on different machines may put the actions in a different order.</li>
flickerstreak@7 130 <li>Keybindings are only saved per character, which causes problems when switching
flickerstreak@7 131 profiles.</li>
flickerstreak@7 132 <li>There seems to be a big performance hit when first dragging a bar after
flickerstreak@7 133 entering configuration mode, and when first enabling keybinding mode.</li>
flickerstreak@7 134 </ul>
flickerstreak@7 135 <h2>Future Plans</h2>
flickerstreak@7 136 <ul>
flickerstreak@7 137 <li>Use override bindings for the keybindings, and automatically switch with
flickerstreak@7 138 profiles. Also &quot;steal&quot; bindings from the default UI on first run
flickerstreak@7 139 so that they're populated with something reasonable.</li>
flickerstreak@7 140 <li>Add support for bag bar, shapeshift bar, and micro menu bar. May also add
flickerstreak@7 141 XP bar to default unit frames for those who don't want to use a unit frame
flickerstreak@7 142 addon to get the XP bar back.</li>
flickerstreak@7 143 <li>More dynamic bar support: auto show/hide/fade on stance switch, in combat,
flickerstreak@7 144 key pressed, etc.</li>
flickerstreak@7 145 <li>&quot;pop-up&quot; bar support, in which a single button shows/hides a bar
flickerstreak@7 146 when moused over</li>
flickerstreak@7 147 <li>Better and more flexible interface for defining page transitions on stance/form
flickerstreak@7 148 shift </li>
flickerstreak@7 149 <li>Provide a method for normalizing the action ID layout, permitting better
flickerstreak@7 150 compatibility when used on different computers.</li>
flickerstreak@7 151 <li>Provide some additional console commands so that enterprising users can
flickerstreak@7 152 macro certain configuration functionality (notably hiding and showing individual
flickerstreak@7 153 bars) </li>
flickerstreak@7 154 <li>Yet more configurable button display options (disable cooldown flash, different
flickerstreak@7 155 borders, etc)</li>
flickerstreak@7 156 <li>Localization</li>
flickerstreak@7 157 </ul>
flickerstreak@7 158 <h2>Version History</h2>
flickerstreak@7 159 <p>Version 0.3</p>
flickerstreak@7 160 <ul>
flickerstreak@7 161 <li>Complete rewrite of the innards for better modularity</li>
flickerstreak@7 162 <li>Lots of bug fixes</li>
flickerstreak@7 163 <li>Multi-paged bar support</li>
flickerstreak@7 164 <li>Pet bar support</li>
flickerstreak@7 165 <li>Auto stance/form/stealth switching</li>
flickerstreak@7 166 <li>Lots and lots of new configuration options</li>
flickerstreak@7 167 </ul>
flickerstreak@7 168 <p>Version 0.2</p>
flickerstreak@7 169 <ul>
flickerstreak@7 170 <li>Bug fixes from 0.1</li>
flickerstreak@7 171 <li>new keybinding interface</li>
flickerstreak@7 172 </ul>
flickerstreak@7 173 <p>Version 0.1</p>
flickerstreak@7 174 <ul>
flickerstreak@7 175 <li>Initial concept, button arrangement</li>
flickerstreak@7 176 </ul>
flickerstreak@7 177 <h2>Credits</h2>
flickerstreak@7 178 <p>Huge credit to the <a href="http://www.wowace.com">Ace 2</a> development team,
flickerstreak@7 179 whose framework provides a level of functionality that I consider critical to
flickerstreak@7 180 the success of this addon.</p>
flickerstreak@7 181 <p>Similarly, enormous credit goes to <a href="http://ckknight.wowinterface.com">ckknight</a>,
flickerstreak@7 182 whose Dewdrop menuing system and FuBar plugin system are ridiculously easy to
flickerstreak@7 183 use.</p>
flickerstreak@7 184 <p>Finally, thanks to my alpha testers and stalwart adventuring companions: Deor,
flickerstreak@7 185 Nogrim, Sorabel, and Yngvi.</p>
flickerstreak@7 186 <h2>Copyright</h2>
flickerstreak@7 187 <p>ReAction &copy; 2007 by Ryan Findley.</p>
flickerstreak@7 188 <p>You are free to distribute this AddOn package without notice to the author,
flickerstreak@7 189 as long as the package is unmodified, this readme.html file accompanies the
flickerstreak@7 190 distribution, and no claim of authorship of the contents of the package is made.
flickerstreak@7 191 Derived works are expressly permitted but must be clearly labeled as not the
flickerstreak@7 192 work of the original author and packaged separately, with credit given to the
flickerstreak@7 193 original author. Inclusion of this package within a compilation is expressly
flickerstreak@7 194 permitted.</p>
flickerstreak@7 195 <p>The author expressly disclaims any warranty of any kind for the material contained
flickerstreak@7 196 in this package. USE AT YOUR OWN RISK.</p>
flickerstreak@7 197 <p>All files in this package under the 'libs/' directory are libraries made available
flickerstreak@7 198 by <a href="http://www.wowace.com">WoWAce</a>, and are not the work of this
flickerstreak@7 199 author.</p>
flickerstreak@7 200 <p>World of Warcraft is a registered trademark of Blizzard Entertainment, Inc.</p>
flickerstreak@7 201 </body>
flickerstreak@7 202 </html>