Mercurial > wow > reaction
diff README.html @ 10:f3a7bfebc283
Version 0.33
| author | Flick <flickerstreak@gmail.com> |
|---|---|
| date | Tue, 20 Mar 2007 21:37:38 +0000 |
| parents | 650f75d08952 |
| children | 2735edcf9ab7 |
line wrap: on
line diff
--- a/README.html Tue Mar 20 21:35:57 2007 +0000 +++ b/README.html Tue Mar 20 21:37:38 2007 +0000 @@ -2,14 +2,21 @@ <head> <title>ReAction: README</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<style type="text/css"> +<!-- +body { background-color: #FFFFCC; list-style-type: none} +p { margin-top: 0px; margin-bottom: 18px} +ul { line-height: 110%} +--> +</style> </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.32 (alpha)<br> - Released: 03 Feb 2007</font><font size="2"><br> - WoW Version Compatibility/TOC: 2.0.6 / TOC 20003</font></p> +<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> <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> @@ -23,7 +30,8 @@ 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>Point and click keybinding interface. You can bind keys to left-click or + right-click independently.</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> @@ -80,18 +88,30 @@ 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> + interface. They're even greyed out in the keybinding menu to remind you.</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 + 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 - if you are in combat, and is automatically cancelled if you enter combat.</p> + 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> +<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 "trying out" certain layouts + briefly, but can also be a serious gotcha — if you just hit 'Escape,' or + alt-click the ReAction Control Button, or enter combat while in keybinding mode, + your bindings will revert to their previous state.</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 @@ -114,8 +134,9 @@ 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 for the XP - bar, bag bar, or micro menu bar (although the hotkeys for them still work)</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> </ul> <h2>Known Issues</h2> <ul> @@ -127,16 +148,12 @@ 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> + entering configuration mode, and when first enabling keybinding mode. More + investigation is necessary.</li> </ul> <h2>Future Plans</h2> <ul> - <li>Use override bindings for the keybindings, and automatically switch with - profiles. Also "steal" 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> @@ -156,6 +173,23 @@ <li>Localization</li> </ul> <h2>Version History</h2> +<p>Version 0.33:</p> +<ul> + <li>Rewrote the keybinding interface (again). I think I finally like this version. + Keybindings are now saved and loaded with the profile, and honor the "character-specific + keybindings" setting in the Blizzard Keybinding pane. The default keybindings + for action bars are now greyed out in Blizzard's interface to remind you to + use ReAction to set bindings for action bars.</li> + <li>Moved the Action ID label on the buttons to the center of the button.</li> + <li>Added support for binding right-clicks to hotkeys on the main action buttons + only (no pet buttons). There is also an option (off by default) to display + and specify the location for right-click binding labels.</li> + <li>Tweaked the ordering of the bar menus. Some options will automatically show/hide + when they are relevant.</li> + <li>Converted the core of the keybinding code to an Ace2-style library: ReBound-1.0</li> + <li>Did a little bit of code cleanup in main.lua</li> + <li>Converted to MIT license</li> +</ul> <p>Version 0.32:</p> <ul> <li>Fixed a bug with displaying cooldowns generating slews of errors</li> @@ -207,26 +241,28 @@ <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>, + 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>Finally, thanks to my alpha testers and stalwart adventuring companions: Deor, Nogrim, Sorabel, and Yngvi.</p> -<h2>Copyright</h2> -<p>ReAction © 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> +<h2>Copyright & License</h2> +<p>ReAction is distributed under the MIT license.</p> +<p>ReAction Copyright © 2007 Ryan Findley.</p> +<p>Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation the + rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the Software is furnished + to do so, subject to the following conditions:</p> +<p>The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software.</p> +<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS + OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR + IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p> <p>World of Warcraft is a registered trademark of Blizzard Entertainment, Inc.</p> </body> </html>