diff README.html @ 12:2735edcf9ab7

Version 0.34
author Flick <flickerstreak@gmail.com>
date Wed, 21 Mar 2007 00:13:27 +0000
parents f3a7bfebc283
children 1b9323256a1b
line wrap: on
line diff
--- a/README.html	Tue Mar 20 21:38:47 2007 +0000
+++ b/README.html	Wed Mar 21 00:13:27 2007 +0000
@@ -14,9 +14,9 @@
 <body bgcolor="#FFFFFF" text="#000000">
 <h1 align="center">ReAction</h1>
 <h3 align="center">AddOn for World of Warcraft</h3>
-<p><font size="2">Current Version: 0.33 (alpha)<br>
-  Released: 02 Mar 2007</font><font size="2"><br>
-  WoW Version Compatibility/TOC: 2.0.8 / TOC 20003</font></p>
+<p><font size="2">Current Version: 0.34 (alpha)<br>
+  Released: 09 Mar 2007</font><font size="2"><br>
+  WoW Version Compatibility: v2.0.10 / TOC 20003</font></p>
 <h2>The Basics</h2>
 <p>ReAction is a replacement for the default Blizzard action bars. It allows you 
   redefine your action button layout any way you like.</p>
@@ -44,13 +44,12 @@
   development framework.</p>
 <h2>Using ReAction</h2>
 <h3>Installation</h3>
-<p>To install ReAction, drag the ReAction folder to World of Warcraft/Interface/AddOns. 
-  Exit World of Warcraft if it's running, then restart.</p>
+<p>To install ReAction, drag the ReAction folder to your World of Warcraft/Interface/AddOns 
+  folder. Exit World of Warcraft if it's running, then restart.</p>
 <h3>Welcome to ReAction</h3>
 <p>When you first enter World of Warcraft with ReAction installed, it will look 
   very similar to the default Blizzard UI, depending on what other AddOns are 
-  installed. Any keybindings you have made to the action bars, however, are not 
-  in effect. Also, only the main menu bar is shown by default. Other bars can 
+  installed. However, only the main menu bar is shown by default. Other bars can 
   be created as desired.</p>
 <p>If you have FuBar installed, on the left side you should see the ReAction plugin 
   icon and label. If not, there should be a button on your minimap. In either 
@@ -62,6 +61,8 @@
   <li>Configuration (&quot;unlocked&quot;)</li>
   <li>Keybinding</li>
 </ul>
+<p>(Technically it's 4 modes, because Config and Keybinding modes can both be 
+  active at the same time).</p>
 <p>You can toggle Configuration mode by shift-clicking the ReAction Control Button 
   and toggle Keybinding mode by alt-clicking the button. Global configuration 
   options are also available by right-clicking the ReAction button. There are 
@@ -88,24 +89,34 @@
   mode by alt-clicking the ReAction Control Button (or choosing 'keybinding mode' 
   from the right-click menu). <b>ReAction button keybindings are not available 
   from the standard keybindings menu!</b> You <i>must</i> use the ReAction keybinding 
-  interface. They're even greyed out in the keybinding menu to remind you.</p>
+  interface. They're even greyed out in the keybinding menu with a textual reminder, 
+  so there's no excuse!</p>
 <p>Like configuration mode, normal button operation is disabled while in keybinding 
-  mode (though again, any hotkeys you have assigned will work).</p>
-<p>With the keybinding interface out, you can mouseover any ReAction button to 
-  see what its current keybinding is. You can set the keybinding on a button by 
-  clicking the button, then pressing the key. To clear a keybinding from a ReAction 
-  button, shift-click the button. Tooltips will remind you of this interface. 
-  You can also right-click/shift-right-click to set/clear a right-click hotkey, 
-  which will simulate right-clicking the button (useful for complex macros, typically 
-  to save screen real estate). If you've set up bars with multiple pages, you 
-  can also bind a key to the page up/down buttons on a per-bar basis. Just make 
-  sure the buttons are showing (they can be hidden later) and assign the keybinding 
-  like any other ReAction button.</p>
-<p>Keybindings are saved on a per-character basis. Keybinding mode is not available 
+  mode (though again, any hotkeys you have assigned will work). With the keybinding 
+  interface out, you can mouseover any ReAction button to see what its current 
+  keybinding is. You can set the keybinding on a button by clicking the button, 
+  then pressing the key. To clear a keybinding from a ReAction button, shift-click 
+  the button. Tooltips will remind you of this interface. You can also right-click/shift-right-click 
+  to set/clear a right-click hotkey, which will simulate right-clicking the button 
+  (useful for complex macro actions, typically to save screen real estate). If 
+  you've set up bars with multiple pages, you can also bind a key to the page 
+  up/down buttons on a per-bar basis. Just make sure the buttons are showing (they 
+  can be hidden later) and assign the keybinding like any other ReAction button.</p>
+<p>Keybindings are saved on a per-profile basis. Keybinding mode is not available 
   if you are in combat, and is automatically cancelled if you enter combat. When 
-  you first log in with ReAction, it steals the keybindings from the default main 
-  action bar (buttons 1-12) and assigns them to the corresponding buttons on the 
-  default ReAction bar.</p>
+  you first log in with ReAction, it steals the current keybindings from the default 
+  main action bar (buttons 1-12) and assigns them to the corresponding buttons 
+  on the default ReAction bar. This means that if you install ReAction, run with 
+  it, and then disable it, your main bar will no longer have any keybindings and 
+  they'll need to be reset. If you later enable ReAction again, it will remember 
+  its own keybindings.</p>
+<p>If a profile assigns a keybinding to a ReAction button, switching away from 
+  that profile will clear the binding but will <b>not</b> restore the binding 
+  to its previous state. If the new profile assigns that binding then, of course, 
+  it will be in use. What this means is that any 'standard' keybinding action 
+  that's bound to a key will become unbound when switching to a profile that uses 
+  the key, and will have to be manually rebound later if you switch away from 
+  that profile.</p>
 <p><b>Remember to click the 'Save' button to save your keybindings! </b>If you 
   do not, they will automatically revert to the previous bindings when exiting 
   keybinding mode. This can be useful for &quot;trying out&quot; certain layouts 
@@ -121,12 +132,10 @@
   a new skill that doesn't fit on your current layout.</p>
 <h2>Limitations</h2>
 <ul>
-  <li>Due to a lack of certain functionality being made available by Blizzard, 
-    dragging and dropping actions onto action bars while in combat is a little 
-    funky. You have to click the destination button rather than just release drag 
-    on it.</li>
-  <li>You can't configure the pet bar unless you actually have a pet out at the 
-    moment. </li>
+  <li>Due to a lack of certain functionality made available by Blizzard, dragging 
+    and dropping actions onto action bars while in combat is a little funky. You 
+    have to click the destination button rather than just release drag on it.</li>
+  <li>You can't configure the pet bar unless you actually have a pet out. </li>
   <li>No support for shapeshift/stance bar (yet)</li>
   <li>If you have a bar with empty buttons, even though they're invisible they 
     still block mouse input from reaching whatever might be under the button. 
@@ -134,9 +143,10 @@
     during combat. This workaround can be disabled via a configuration option, 
     but then you can't drag and drop actions onto slots during combat. Pick your 
     poison, it's a limitation of Blizzard's protection scheme.</li>
-  <li>If you hide the default main menu bar, there is no substitute provided for 
-    the XP bar, bag bar, or micro menu bar (although the hotkeys for them still 
-    work). Other addons can provide these features until ReAction supports them.</li>
+  <li>If you hide the default main menu bar, there is no substitute provided (yet) 
+    for the XP bar, bag bar, or micro menu bar (although the hotkeys for them 
+    still work). Other addons can provide these features until ReAction supports 
+    them.</li>
 </ul>
 <h2>Known Issues</h2>
 <ul>
@@ -145,12 +155,15 @@
     a hunter to get Eyes of the Beast :-P) is required.</li>
   <li>The initial mapping of action IDs for shapeshift forms doesn't exactly match 
     Blizzard's mapping. When first starting up as a warrior, druid, or rogue, 
-    you will probably need to move your actions around.</li>
+    you will probably need to move your actions around, and it will likely screw 
+    up your layout if you swap back to the default UI.</li>
   <li>Action IDs may not always be laid out in sequence, meaning that similar 
-    layouts on different machines may put the actions in a different order.</li>
+    layouts on different machines may put the actions in a different order. For 
+    best results, copy the WTF/Account/&lt;AccountName&gt;/SavedVariables/ReAction.lua 
+    from one computer to the other, when you get a setup you like.</li>
   <li>There seems to be a big performance hit when first dragging a bar after 
-    entering configuration mode, and when first enabling keybinding mode. More 
-    investigation is necessary.</li>
+    entering configuration mode, and when first enabling keybinding mode, if there 
+    are several bars and a lot of buttons out. More investigation is necessary.</li>
 </ul>
 <h2>Future Plans</h2>
 <ul>
@@ -170,9 +183,15 @@
     bars) </li>
   <li>Yet more configurable button display options (disable cooldown flash, different 
     borders, etc)</li>
+  <li>Button styles (Dreamlayout, CyCircled)</li>
   <li>Localization</li>
 </ul>
 <h2>Version History</h2>
+<p>Version 0.34:</p>
+<ul>
+  <li>Fixed some bugs in the keybinding code, and further refined the ReBound 
+    library. </li>
+</ul>
 <p>Version 0.33:</p>
 <ul>
   <li>Rewrote the keybinding interface (again). I think I finally like this version. 
@@ -244,8 +263,13 @@
   the success of this addon. Similarly, enormous credit goes to <a href="http://ckknight.wowinterface.com">ckknight</a>, 
   whose Dewdrop menuing system and FuBar plugin system are ridiculously easy to 
   use.</p>
+<p>Thanks to the authors of certain action bar mods that came before ReAction: 
+  Bartender3, Bongos, FlexBar 2, and Trinity Bars. While I didn't steal any code 
+  directly from you guys, your addons provided inspiration for various features 
+  and options. Hopefully ReAction differentiates itself sufficiently that it's 
+  not seen as simply a clone.</p>
 <p>Finally, thanks to my alpha testers and stalwart adventuring companions: Deor, 
-  Nogrim, Sorabel, and Yngvi.</p>
+  Nogrim, Sorabel, and Yngvi (or, more to the point, their alts :-P).</p>
 <h2>Copyright &amp; License</h2>
 <p>ReAction is distributed under the MIT license.</p>
 <p>ReAction Copyright &copy; 2007 Ryan Findley.</p>