VgerMods/Gyro
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Gyro: Get Your Raid On!</title> <link rel="stylesheet" type="text/css" href="VgerCore/VgerCore.css" /> </head> <body> <h1>Gyro: Get Your Raid On!</h1> <p> Gyro lets you set up macros (lists of commands) to be run whenever you join or leave a raid, for convenience or laziness. You can, for example, enable raid UI mods only when you're actually in a raid, disabling them when you're done.</p> <h2> Installing Gyro</h2> <p> Gyro is installed like pretty much every other World of Warcraft mod on the planet. Extract the contents of the zip file to your Add-ons folder, generally located here:</p> <p class="codeblock"> <code>C:\Program Files\World of Warcraft\Interface\Addons</code></p> <h2>Getting started</h2> <p><i>If you're quite familiar with macros already, you might want to skip this section and go straight to "Gyro setup guide for l33t macro masters."</i></p> <p>When you first log in after installing and enabling Gyro, you won't notice anything different. Gyro doesn't know what you want yet, so it won't do anything. Gyro is controlled through slash commands, which work very much like the emotes, such as /dance. To see what options Gyro has, type the following command in your chat window:</p> <p class="codeblock"> <code>/gyro</code></p> <p>This will list all of the different commands you can use with Gyro. The first thing you want to do is set up the Gyro macros, so type this command:</p> <p class="codeblock"> <code>/gyro macros</code></p> <p>This will open up the Macros UI. If you haven't see this window before, macros are batches of commands that can be run all at once. Normally you do this so that you can assign things you commonly say and do to a single button on your action bar, but Gyro also uses macros to control its behavior. The Macros window has two tabs at the top: the one on the left contains macros shared by all of your characters, and the one on the right contains macros that are specific to the character you're currently playing. Click that tab.</p> <p>You should see two macros here: one with a red minus sign called GyroEndRaid, and one with a blue plus sign called GyroStartRaid. All of the commands in GyroStartRaid will be run each time that you enter a raid, and all of the commands in GyroEndRaid will be run when you leave a raid, and when you first log in. Right now, all that's in each macro is a helpful instruction.</p> <p>Now you need to decide what you want each macro to do. Click on GyroStartRaid (the blue plus sign). Replace the macro that Gyro created for you with the following text:</p> <p class="codeblock"> <code>/s Hey everyone, I just entered a raid!</code></p> <p>Note that this looks exactly like something that you'd normally type into the chat window. If this is what your GyroStartRaid macro contains and you're invited to a raid group, you'll say "Hey everyone, I just entered a raid!" to everyone around you. Annoying and not very useful, but it's a start.</p> <p>Now, to test this out, you can ask a friend to invite you to a raid. If you don't have any friends, there's another way to test your new macro out. Type the following command into the chat window (close the Macros window if you still have it open):</p> <p class="codeblock"> <code>/gyro on</code></p> <p>This command makes Gyro act as if you're in a raid, even if you're not. When you type that command, notice that you just told everyone around you that you entered a raid. How embarrassing. Gyro isn't very useful if you force it on all the time, so let's put it back into the normal "automatic" mode by typing this command:</p> <p class="codeblock"> <code>/gyro auto</code></p> <p>So, neat, perhaps, but still not very useful. Now it's time to decide what you really want to happen when you join or leave a raid. Personally, I use Gyro to disable and hide some of my mods when I'm not in a raid and I don't need them. For example, I can use Gyro to turn off Hear Kitty when I'm not in a raid, and turn it back on when I join one.</p> <p class="codeblock"> <b>GyroStartRaid:</b><br /> <code>/hearkitty on</code></p> <p class="codeblock"> <b>GyroEndRaid:</b><br /> <code>/hearkitty off</code></p> <p>You probably had something else in mind when you downloaded this mod. Go ahead and set up your two macros to do whatever you like now. It's okay to leave one of them blank, if, for example, you only want to do something when joining a raid, but not when leaving a raid.</p> <p><b>Important: Gyro macros can't be used to cast spells or use items.</b> This is a restriction that Blizzard puts on mods to prevent botting and automated play. If you put a restricted action in one of your Gyro macros, Gyro will skip that action and warn you about this in the chat window.</p> <p>Once you've gotten more familiar with Gyro, you'll want to check out the section titled "More Gyro options."</p> <p>Enjoy!</p> <h2>Gyro setup guide for l33t macro masters</h2> <p>Already know a lot about macros, and you already skipped the previous section? Great. I'll keep this short. Type this command at a chat window:</p> <p class="codeblock"> <code>/gyro macros</code></p> <p>This will automatically create two character-specific macros for you, <strong>GyroStartRaid</strong> and <strong>GyroEndRaid</strong>. The former will be executed whenever you join a raid, and the latter will be executed whenever you leave one. Write these like you would any other macros. Easy as that. Type "/gyro" at the chat window for more options.</p> <p><b>Important: Gyro macros can't be used to cast spells or use items.</b> This is a restriction that Blizzard puts on mods to prevent botting and automated play. If you put a restricted action in one of your Gyro macros, Gyro will skip that action and warn you about this in the chat window.</p> <h2>More Gyro options</h2> <p>Gyro is pretty simple, but it does have a few options that you can set.</p> <h3>Forcing Gyro in or out of raid mode</h3> <p>Normally, Gyro automatically detects whether or not you're in a raid, and runs the appropriate macro for your situation. However, when testing out your macros, or in certain other circumstances, you might want to override this. Gyro has handy options for doing just that.</p> <p class="codeblock"> <code>/gyro auto</code> <br /><code>/gyro on</code> <br /><code>/gyro off</code> </p> <p>The default is <b>auto</b>, which detects whether or not you're in a raid for you. You can use <b>/gyro on</b> to be in raid mode even when you're not in a raid, or <b>/gyro off</b> to be in non-raid mode even when you're in a raid.</p> <h3>Do battleground raids count as raids?</h3> <p>Some people consider PVP battlegrounds as raids, and some people don't. You can decide whether Gyro counts a battleground raid as a raid ("on") or not ("off") with these commands:</p> <p class="codeblock"> <code>/gyro bg on</code> <br /><code>/gyro bg off</code> </p> <h2>Suggestions</h2> <h3>Reminding yourself to repair and buy reagents before raids</h3> <p>You can use Gyro to remind yourself to get reagents and repair before raids.</p> <p class="codeblock"> <b>GyroStartRaid:</b><br /> <code>/w Vger Don't forget to repair and buy reagents!</code></p> <p>Replacing "Vger" with your own character's name, of course.</p> <h2>Using Gyro with your favorite mods</h2> <p>Here are some tips for using Gyro with other mods.</p> <h3>Hear Kitty</h3> <p class="codeblock"> <b>GyroStartRaid:</b><br /> <code>/hearkitty on</code></p> <p class="codeblock"> <b>GyroEndRaid:</b><br /> <code>/hearkitty off</code></p> <h3>KLHThreatMeter (KTM)</h3> <p class="codeblock"> <b>GyroStartRaid:</b><br /> <code>/ktm g s</code></p> <p class="codeblock"> <b>GyroEndRaid:</b><br /> <code>/ktm g h</code></p> <h3>Omen</h3> <p>As of writing, Omen has a slash command to toggle the display, but not to explicitly turn it on or off. But, there's a workaround.</p> <p class="codeblock"> <b>GyroStartRaid:</b><br /> <code>/script Omen:Toggle(true)</code></p> <p class="codeblock"> <b>GyroEndRaid:</b><br /> <code>/script Omen:Toggle(false)</code></p> <h3>Grid</h3> <p class="codeblock"> <b>GyroStartRaid:</b><br /> <code>/script GridLayoutFrame:Show()</code></p> <p class="codeblock"> <b>GyroEndRaid:</b><br /> <code>/script GridLayoutFrame:Hide()</code></p> <h3>Spirit Versus Intellect UI</h3> <p class="codeblock"> <b>GyroStartRaid:</b><br /> <code>/sviui show</code></p> <p class="codeblock"> <b>GyroEndRaid:</b><br /> <code>/sviui hide</code></p> <h2>Final notes</h2> <p>I hope you find Gyro useful. I welcome feedback, suggestions, bug reports, and the like. The easiest way to reach me is the <a target="_blank" href="http://www.curse.com/downloads/details/4576/">Gyro page on Curse</a>. You can also contact me through in-game mail: Vger on Azjol-Nerub (US, Horde). (If you contact me via in-game mail, make sure you check your in-game mail for a reply!) Also, check out my <a target="_blank" href="http://www.vgermods.com/">official site</a>, with links to my other mods.</p> <h2>Release history</h2> <h3>Version 1.2.1</h3> <ul> <li>Additional changes for Mists of Pandaria and patch 5.0. This version of Gyro will not work on old versions of World of Warcraft.</li> </ul> <h3>Version 1.2</h3> <ul> <li>Updated for Mists of Pandaria and patch 5.0.</li> </ul> <h3>Version 1.1</h3> <ul> <li>Updated for patch 4.3.</li> </ul> <h3>Version 1.0.10</h3> <ul> <li>Incredibly minor update for patch 4.1.</li> </ul> <h3>Version 1.0.9</h3> <ul> <li>Update for Cataclysm.</li> <li>Some unnecessarily spammy messages ("Entering raid") were removed.</li> </ul> <h3>Version 1.0.8</h3> <ul> <li>Update for patch 3.3.5.</li> </ul> <h3>Version 1.0.7</h3> <ul> <li>Incredibly minor update for patch 3.2.</li> </ul> <h3>Version 1.0.6</h3> <ul> <li>Updated the default macro icons for patch 3.1.</li> </ul> <h3>Version 1.0.5</h3> <ul> <li>Removed the "Gyro is loaded" message that appears when logging in.</li> <li>Updated the default macro icons for patch 3.0.2.</li> </ul> <h3>Version 1.0.4</h3> <ul> <li>Updated the default macro icons for patch 2.4.2.</li> </ul> <h3>Version 1.0.3</h3> <ul> <li>Added some hints to the readme to help you get started using Gyro with a few popular mods, such as Omen.</li> <li>Updated the default macro icons for patch 2.4.</li> </ul> <h3>Version 1.0.2</h3> <ul> <li>Updated the macro icons for patch 2.3.</li> </ul> <h3>Version 1.0.1</h3> <ul> <li>Now displays a more readable error message when the embedded mod VgerCore is missing or failed to load.</li> </ul> <h3>Version 1.0</h3> <ul> <li>Gyro is now at version 1.0! It includes VgerCore embedded within the mod, so you no longer need a VgerCore folder inside of your AddOns folder.</li> <li>Gyro's English text has been separated into a different file, Localization.lua, to ease translation into other languages.</li> </ul> <h3>Version 0.2.2</h3> <ul> <li>Gyro now checks for a valid version of VgerCore when it starts up.</li> </ul> <h3>Version 0.2.1</h3> <ul> <li>Updated for World of Warcraft: The Burning Crusade (patch 2.0.3).</li> <li>VgerCore 0.3.1: The latest version of VgerCore allows Gyro to block forbidden commands such as /cast from macros, which prevents the game from warning you about VgerCore and asking if you want to disable it.</li> </ul> <h3>Version 0.2</h3> <ul> <li>Updated for patch 2.0.</li> <li>Removed the unnecessary "entering raid" and "leaving raid" text that appeared in the top center of the screen. It will now show up only in the combat log.</li> </ul> <h3>Version 0.1</h3> <ul> <li>First version publicly released.</li> </ul> <h2>Known issues</h2> <ul> <li>In battlegrounds, it appears that your macros don't run until someone else leaves or joins the battleground after you join.</li> </ul> <h2>Future versions</h2> <ul> <li>Support for parties as well as raids would be another good option. And it's been requested to add the capability to do some things only for normal/heroic raids and not LFR raids. (For example, <b>/gyro lfr off</b>.)</li> <li>I should make a UI to set the Gyro options in the Interface Options dialog.</li> <li>Gyro doesn't actually need the various commands it runs to be in macros; I could move them out to a separate location so that it doesn't take up two macro slots.</li> </ul> <h2>The fine print</h2> <p>© 2006-2024 Green Eclipse. This mod is released under the Creative Commons <a href="http://creativecommons.org/licenses/by-nc-nd/3.0/" target="_blank"> Attribution-NonCommercial-NoDerivs 3.0</a> license. In short, this means that you can use it, copy it, and share it, but you can't sell it or distribute your own altered versions without permission. By using the mod you agree to the terms of the license. For more information, click the link.</p> </body></html>
