Mercurial > wow > reaction

view README.html @ 7:f920db5fc6b1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
version 0.3
author Flick <flickerstreak@gmail.com>
date Tue, 20 Mar 2007 21:25:29 +0000
parents
children c05fd3e18b4f
line wrap: on
line source
<html>
<head>
<title>ReAction: README</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>

<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.3 (beta)<br>
  Released: 29 Jan 2007</font><font size="2"><br>
  WoW Version Compatibility/TOC: 2.0.6 / 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>
<h2>Features</h2>
<ul>
  <li>Move, resize, create, and arrange as many action bars as you want. Each 
    bar can contain any number of buttons arranged in a grid layout of any size 
    and spacing. The full complement of 120 action slots is supported.</li>
  <li>Works with all types of actions, including abilities, items, and macros</li>
  <li>Layout is done with the mouse, by dragging bars and bar edges on screen. 
    Automatically anchor bars to each other or the screen edges by holding shift 
    down as you drag.</li>
  <li>Context menus provide independent configuration options for each bar.</li>
  <li>Point and click keybinding interface.</li>
  <li>Supports multiple 'pages' per bar, configured independently. Automatic stance, 
    form, and stealth switching among pages is supported, including Shadowform.</li>
  <li>Pet action bar is fully supported and configurable.</li>
  <li>Settings can be saved per account, realm, character, class, or independent 
    profile. </li>
  <li>Compatible with OmniCC</li>
</ul>
<p>ReAction is built using the <a href="http://www.wowace.com/Wiki/Ace2">Ace2</a> 
  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>
<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. The bottom left, 
  bottom right, and two right action bars are hidden.</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 
  case, that button (the ReAction Control Button) is the gateway to configuring 
  ReAction.</p>
<p>ReAction has three modes of operation:</p>
<ul>
  <li>Normal (&quot;locked&quot;)</li>
  <li>Configuration (&quot;unlocked&quot;)</li>
  <li>Keybinding</li>
</ul>
<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 
  also a limited set of console commands that can be accessed with the &quot;/reaction&quot; 
  or &quot;/rxn&quot; slash-commands. Type /rxn in the chat box to print a list 
  of commands.</p>
<p>You can also set key bindings to toggle Configuration and Keybinding modes, 
  in the standard UI keybindings panel.</p>
<h3>Configuring ReAction</h3>
<p>Start by shift-clicking the ReAction button to enter Configuration mode. All 
  bars, including hidden bars, are shown in this mode and <b>normal button click 
  operation is disabled </b>(though keybindings still work). Mouse over the bars, 
  edges, and corners to see tooltip instructions for moving, resizing, and rearranging 
  them. Right click each bar for a menu of options pertaining to that bar. For 
  example, to change a hidden bar to a visible bar, right-click on a bar and choose 
  Visibility -&gt; Always Visible. Tooltips for each menu option provide details.</p>
<p>When you're done configuring ReAction, shift-click the ReAction button again 
  to go back to Normal mode.</p>
<p>Configuration mode is not available if you are in combat, and is automatically 
  cancelled if you enter combat.</p>
<h3>Setting Keybindings</h3>
<p><b>ReAction buttons don't use the regular keybindings of the default UI.</b> 
  In order to get your buttons to use hotkeys, enter ReAction Keybinding Setup 
  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.</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 
  pressing the key, then clicking the button. To clear a keybinding from a ReAction 
  button, right-click the button. 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 
  if you are in combat, and is automatically cancelled if you enter combat.</p>
<h3>Playing with ReAction</h3>
<p>Once you get your keybindings and configuration set up, you're ready to go. 
  The buttons behave just like regular Blizzard buttons. However, at any time 
  when you're not in combat, you can quickly switch to configuration mode and 
  create a new bar, rearrange bars, hide/show a special-use bar, etc. Perfect 
  for when you get some goofy quest item that has to be used temporarily, or get 
  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>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. 
    This is a workaround so that you can drag and drop actions onto hidden slots 
    during combat.</li>
  <li>If you hide the default main menu bar, there is no substitute for the XP 
    bar, bag bar, or micro menu bar (although the hotkeys for them still work)</li>
  <li>The pet bar, by default, appears underneath bar #6 (lower left). You'll 
    have to move bar 6 out of the way if you want to move the pet bar. Also, it 
    does not</li>
</ul>
<h2>Known Issues</h2>
<ul>
  <li>There may or may not be a particular case in which turning off a pet's attack 
    while using Eyes of the Beast doesn't work. Further investigation (and leveling 
    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>
  <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>
  <li>Keybindings are only saved per character, which causes problems when switching 
    profiles.</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.</li>
</ul>
<h2>Future Plans</h2>
<ul>
  <li>Use override bindings for the keybindings, and automatically switch with 
    profiles. Also &quot;steal&quot; bindings from the default UI on first run 
    so that they're populated with something reasonable.</li>
  <li>Add support for bag bar, shapeshift bar, and micro menu bar. May also add 
    XP bar to default unit frames for those who don't want to use a unit frame 
    addon to get the XP bar back.</li>
  <li>More dynamic bar support: auto show/hide/fade on stance switch, in combat, 
    key pressed, etc.</li>
  <li>&quot;pop-up&quot; bar support, in which a single button shows/hides a bar 
    when moused over</li>
  <li>Better and more flexible interface for defining page transitions on stance/form 
    shift </li>
  <li>Provide a method for normalizing the action ID layout, permitting better 
    compatibility when used on different computers.</li>
  <li>Provide some additional console commands so that enterprising users can 
    macro certain configuration functionality (notably hiding and showing individual 
    bars) </li>
  <li>Yet more configurable button display options (disable cooldown flash, different 
    borders, etc)</li>
  <li>Localization</li>
</ul>
<h2>Version History</h2>
<p>Version 0.3</p>
<ul>
  <li>Complete rewrite of the innards for better modularity</li>
  <li>Lots of bug fixes</li>
  <li>Multi-paged bar support</li>
  <li>Pet bar support</li>
  <li>Auto stance/form/stealth switching</li>
  <li>Lots and lots of new configuration options</li>
</ul>
<p>Version 0.2</p>
<ul>
  <li>Bug fixes from 0.1</li>
  <li>new keybinding interface</li>
</ul>
<p>Version 0.1</p>
<ul>
  <li>Initial concept, button arrangement</li>
</ul>
<h2>Credits</h2>
<p>Huge credit to the <a href="http://www.wowace.com">Ace 2</a> development team, 
  whose framework provides a level of functionality that I consider critical to 
  the success of this addon.</p>
<p>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>Finally, thanks to my alpha testers and stalwart adventuring companions: Deor, 
  Nogrim, Sorabel, and Yngvi.</p>
<h2>Copyright</h2>
<p>ReAction &copy; 2007 by Ryan Findley.</p>
<p>You are free to distribute this AddOn package without notice to the author, 
  as long as the package is unmodified, this readme.html file accompanies the 
  distribution, and no claim of authorship of the contents of the package is made. 
  Derived works are expressly permitted but must be clearly labeled as not the 
  work of the original author and packaged separately, with credit given to the 
  original author. Inclusion of this package within a compilation is expressly 
  permitted.</p>
<p>The author expressly disclaims any warranty of any kind for the material contained 
  in this package. USE AT YOUR OWN RISK.</p>
<p>All files in this package under the 'libs/' directory are libraries made available 
  by <a href="http://www.wowace.com">WoWAce</a>, and are not the work of this 
  author.</p>
<p>World of Warcraft is a registered trademark of Blizzard Entertainment, Inc.</p>
</body>
</html>