Livestock: For all your companion needs
Now that your pets and mounts don't take up space in your bags, Livestock lets you manage them intelligently. This addon sorts your companions into land mounts, flying mounts, and vanity pets. Then, with the push of a button, you can randomly summon any of the three, or designate a favorite pet to have out on command. You can also have Livestock always keep a pet by your side, and have it dismiss your vanity pet when you are in PVP battle and it would give away your position.
You can even tell Livestock to put you on a random land or flying mount depending on whether the area you're in lets you fly or not.
You can summon critters, land mounts, and flying mounts in various ways - see below for details.
Planned Updates and Localization Help
Because I am getting lots of suggestions and bug reports from users, I have a section of the FAQ (at http://www.wowinterface.com/portal.php?id=474&a=faq&faqid=345) devoted to seeing what's in store for the next version. If you're wondering if I'm working on something, that is the place to check. I will try to keep it as up-to-date as possible!
Livestock currently only completely works for the enUS, deDE, and frFR clients. If you are on another client, Livestock will work but will show all English strings. However, it will classify all your mounts as land mounts and slow mounts - defeating much of the purpose of using the addon. If you are willing to help localize the addon for your language, please let me know - you'd only need to provide some simple translations and I'd do the rest.
Slash Commands:
- Use "/livestock" to bring up the main menu bar.
- Use "/livestock reset" to move the four Livestock Buttons (described below) back to their default positions.
- Use "/livestock scale <scale>" to change the size of the Livestock Buttons (described below). They will be reset to the lower center of the screen and resized. If you use scales larger than 1.5, the buttons might be pushed off the screen by the rescaling before you can move them manually. You have been warned.
- Use "/livestock redo" to force Livestock to reset and rewrite your menus. This is helpful if you are seeing nothing in your menus at all, or you learned a new mount and it's not showing up correctly. It should restore your menus with all visible mounts checked and remind you to go through and uncheck any you don't want to include.
Livestock Options:
You can find the options for Livestock in the Addons tab of the Blizzard Interface options menu. The "Livestock" tab has the major options, while the "Livestock Preferences" tab has tweaks to customize Livestock's behavior. You can read more about the preferences in the FAQ at http://www.wowinterface.com/portal.php?id=474&a=faq
Building Your Summon Checklists
Before you randomly summon a vanity pet (critter) or mount, you must build its checklist first. If you try to use Livestock to randomly summon an animal before you do this, it will prompt you to build the checklists.
Open the Livestock menu bar and click one of the three buttons to open a list of the critters, land mounts, and flying mounts you can summon. You will notice that your slow and epic mounts appear in your mount menus. If you wish to hide slow mounts, you can do so by accessing the Filter Options in the Livestock Options frame.
As you move your mouse over the animals in the menus, you will see them appear in the 3D model window if you've enabled it in the main menu. (The slider at the bottom of the viewer controls how fast your animal rotates so you can view it from all angles. Excessive rotation speed may result in animal complaints.)
Select the animals you want for each checklist by clicking on them individually or by clicking "Select / Unselect All" at the bottom. If you are in the vanity pets menu, you can designate a favorite pet by right-clicking it.
Random Summons
Once you've made your checklist, you can summon your pets and mounts randomly through unique Livestock buttons, keybinds, or macros (action buttons).
Livestock Keybinds: Open the WoW keybinding menu and assign keybinds to the various functions you want. You can assign keybinds to random pets, random mounts, dismiss whichever pet you have out, or summon your random pet.
Livestock Buttons: In the options menu, choose which buttons you would like to show/hide in the first set of options. The critter button resembles a pet carrier, the land mount a horseshoe, the flying mount a winged boot, and smart mounting (described below) a running brain. These can be placed anywhere on the screen, can be scaled with /livestock scale <scale>, and can be reset to the center with /livestock reset. To move them, hold down Ctrl, Alt, or Shift and drag the button to its desired location.
For the Critter button, you can summon a guaranteed different critter by left-clicking, or dismiss your current critter by right-clicking. You can summon your favorite pet by holding down Alt, Shift, or Ctrl and clicking the button.
Livestock Macros: Make sure your macro window is closed first! Open the options menu and click any of the three top macro buttons to create a macro that will summon a random animal. These macros will go in your individual character macros and can be placed on your action bars. The bottom macro button creates a smart mount macro (explained below).
For the Critter macro, you can summon a guaranteed different critter by left-clicking, or dismiss your current critter by right-clicking.
To have a macro that summons your favorite pet, you can use "/run Livestock.SummonFavoritePet()" in a macro of your choosing.
Smart Mounting
The most sophisticated part of Livestock is its "Smart Mount" feature. When you activate Smart Mounting through macro, button, or keybind, the addon checks to see where you are, if you're in combat or not, and what class you are. It then mounts you up using the following logic:
- If you're in combat, then it does nothing unless you're a druid or a shaman. If you are, it toggles Travel Form or casts Ghost Wolf, respectively.
- If you're already on a land mount, then you will dismount. If you're already on a flying mount, then you will only dismount if the flying mount is on the ground. If you're in the air, nothing happens (unless you've told Livestock otherwise in the preferences).
- If you're not in combat, the addon puts you on a land or flying mount based on where you are and if you've learned Cold Weather Flying:
- Azeroth - summons a random land mount.
- Outlands - summons a random flying mount, unless you have no flying mounts. Then it summons a random land mount.
- Northrend - summons a random land mount, unless you have Cold Weather Flying. Then, it summons a random flying mount. In Wintergrasp, you will be restricted to summoning land mounts. In Dalaran, you can only summon land mounts unless you're in the Sewer Exit Pipe or Krasus' Landing. In those two areas only, you can summon a flying mount.
- If you're a druid, you have the option to incorporate Swift Flight Form and Flight Form into Smart Mounting. You can toggle this option Livestock Preferences panel. If you do include Flight Forms, then whenever you are in a flying area (including Northrend but only with Cold Weather Flying), Livestock will use Swift Flight Form as top priority, then epic flying mounts, then (normal) Flight Form, then slow flying mounts.
Druids will also use Aquatic Form when they are swimming with Smart Mounting.
Bugs Reports and Feature Requests
If you find unexpected behavior in Livestock, especially in locales other than enUS, please check the FAQ at http://www.wowinterface.com/portal.php?id=474&a=faq first to see if it has been addressed and if there is a possible fix.
Please report any bugs you find with Livestock -- or feature requests you'd like to see -- using the "Tickets on Curseforge" link above the comments section.
If you are reporting a bug, the following information is helpful: Any error messages that you saw, where you were (if you can give coordinates, that's excellent), what you were trying to do, what your menus looked like, and what class you play.
Thanks!
Well-deserved credit goes to the following people:
- Khanthal (Uldum), for the original idea and being our MT so often!
- A BIG thank you to Sbo (UI and Macros forum, Live) who helped me figure out what was the issue with Dalaran and Wintergrasp as well as suggesting the way to get around it.
- Grimgear (UI and Macros forum, Live) for helping troubleshoot a bug, pointing me to keybindings, and suggesting rotation speed. Also for pointing out how best to adjust my GUI to compensate for localization.
- Lunessa (UI and Macros forum, Live) for pointing me to Blizzard's instructions on creating panels in the Interface menu.
- Xelron (UI and Macros forum, Live) for helping construct debug messages to get more information and indirectly convincing me to make my own dropdowns.
- Ro (UI and Macros forum, Beta) for the 3D model viewer idea. Ro also originally suggested making my own custom dropdowns, which I thought was beyond me!
- Elloria and Tgulics (WoWInterface) for helping spread the word and test the addon in its earliest stages and for suggesting highlighting the buttons when they're clicked.
- The MVPs (UI and Macros forum) for providing the resources needed to accomplish this one as well as stepping in and answering my questions from time to time. Special thanks to Alestane and Iriel for helping me with secure handlers.
- kdkunde (WoWInterface) for helping translate this mod into German so far!
- Vastilia (WoWInterface) and Yorgl (Curse) for helping translate into French!
- Certainly not least, Brenkite (Uldum) for being my personal troubleshooter and moral support.
Version 1.1:
- Livestock is now free software under the Gnu GPLv3. This mainly means you are free to modify it as you like without needing to ask my permission. You may also distribute any modified versions as you see fit, provided that you release your versions under the Gnu GPLv3 as well. For further details, see the gpl.txt file.
- Smart Mounting functionality should be restored in Northrend - i.e. using Smart Mounting when you don't have Cold Weather Flying should summon a land mount. I haven't gotten a level 77 character to test it yet, but the code is taken from an earlier version which worked fine in the Beta. Long story short: I think it should be fine; if it's not, please let me know.
- Livestock should no longer "automatically" summon a vanity pet under the following conditions: when you are channeling a spell, when you are eating or drinking, or when you have Stealth / Prowl / Shadowmeld / Vanish / Invisiblity on.
- Added a new preference option for Shamans to have Smart Mounting cast Water Walking when underwater.
- Added a new preference option to disable "automatic" pet summoning whenever you are flagged for PVP.
- Double-clicking a pet or mount in the Livestock dropdown menus will summon that pet or mount. (Unless you're a druid in a shapeshift form and you try to get on a mount.)
Version 1.0.7a:
- Small code tweak: v1.0.7 had a bug where if you didn't have the checkbox checked for automatically summoning a pet, you'd still summon a pet until you checked and unchecked the box. This was because of a change in the automatic-summoning code from v1.0.6.5 to v1.0.7 but is now fixed.
- Fixed an error that was causing some night elves to not have access to the option for dismissing a pet when you enter Stealth, which includes Shadowmeld. All night elves, regardless of class, should now have access to this option.
- Fixed an issue where characters without pets would get spammed to select a pet to summon even if they had the "automatically summon" option unchecked.
- Livestock now lets you designate a favorite pet. You indicate the pet by right-clicking it in the dropdown menu, and can then summon it with a separate keybind or by ALT-, CTRL-, or SHIFT-clicking the Livestock critters button. See the macro section for how to make a macro to access the favorite button.
- Added a suboption for "summon a pet on moving" that lets you instead summon your favorite pet when you move.
- Added a suboption for "dismiss a pet when you stealth" that restricts your dismissing a pet to only occur when you are PVP flagged. If for some reason you notice that your pet is NOT dismissing when you stealth and are flagged, please submit a bug report that lets me know your class, race, what spell you were using (Stealth, Prowl, Vanish, FD, Invis, or Shadowmeld), and how you became flagged (Arena, Battleground, typed /pvp, on a PVP server in a contested/hostile zone, you weren't flagged and you attacked someone who was, etc.)
- When you are on the Shattered Sun daily quest "Blast the Gateway" you should no longer see a random pet / favorite pet replace the 'Living Flare' companion if you have an automatic summon option checked. Your random pet / favorite pet summoning should resume when your Living Flare successfully destroys the gateway. This fix is currently only localized for the enUS client.
Version 1.0.6.5:
- Minor change to the code to adjust for the fact that the tooltip parser was not reading non-English tooltips appropriately. (Thanks, Vastilia at WoWInterface!)
- Change log up to this version removed from hosting site and included in the .zip file instead.
Installation Guide
- Exit "World of Warcraft" completely
- Download the mod you want to install
- Make a folder on your desktop called "My Mods"
- Save the .zip/.rar files to this folder.
- If, when you try to download the file, it automatically "opens" it... you need to RIGHT click on the link and "save as..." or "Save Target As".
- Extract the file - commonly known as 'unzipping'
Do this ONE FILE AT A TIME!
- Windows
- Windows XP has a built in ZIP extractor. Double click on the file to open it, inside should be the file or folders needed. Copy these outside to the "My Mods" folder.
- WinRAR: Right click the file, select "Extract Here"
- WinZip: You MUST make sure the option to "Use Folder Names" is CHECKED or it will just extract the files and not make the proper folders how the Authors designed
- Mac Users
- StuffitExpander: Double click the archive to extract it to a folder in the current directory.
- Verify your WoW Installation Path
That is where you are running WoW from and THAT is where you need to install your mods.
- Move to the Addon folder
- Open your World of Warcraft folder. (default is C:\Program Files\World of Warcraft\)
- Go into the "Interface" folder.
- Go into the "AddOns" folder.
- In a new window, open the "My Mods" folder.
- The "My Mods" folder should have the "Addonname" folder in it.
- Move the "Addonname" folder into the "AddOns" folder
- Start World of Warcraft
- Make sure AddOns are installed
- Log in
- At the Character Select screen, look in lower left corner for the "addons" button.
- If button is there: make sure all the mods you installed are listed and make sure "load out of date addons" is checked.
- If the button is NOT there: means you did not install the addons properly. Look at the above screenshots. Try repeating the steps or getting someone who knows more about computers than you do to help.
Translations
When you download a mod, please be sure that the mod is compatible with your translation of wow. Some mods only work on the US versions, while some only work on some of the various European versions. These variations are called "Localizations".
TOC Numbers (Out of Date Mods)
When Blizzard patches WoW, they change the Interface number. This means that all mods will be "out of date" unless or until the author releases a new version for that interface. Some people go into the .toc files and update the numbers themselves, but this is STRONGLY advised against as it will cause problems locating possible incompatibilities addons. When you log into WoW after a patch, you DO NOT have to delete your interface directory. All you have to do is simply tell WoW to ignore the interface numbers and load all the mods anyway. All you have to do is, while at the "character select" screen, look in the lower left corner and click on the "addons" button. A window will pop up listing all your installed mods.
If you look in the upper left corner of that window there should be a box that says "Load Out of Date AddOns". You want to CHECK this box. Now simply go into WoW normally and all your mods should load. As of the 1.9 patch, you will have to do this after EVERY patch/update that Blizzard posts! If you encounter any problems with a mod after a patch, please be sure to let the author of the mod know so they can fix it.
See also: About "Out Of Date AddOns"
Mac Support
WoW addons are not platformed based. As such, they can be used on either Mac or PC. You can extract both .zip and .rar files on a Mac using StuffitExpander.
Directory Structure
World of Warcraft
|_ Interface
|_AddOns
|_*AddonName*
|_ *AddonName*.toc
|_ *AddonName*.xml
|_ *AddonName*.lua
|_ (possibly others as well)...