Currently being maintained by LordFarlander
Synopsis
There are a number of events that trigger the loss of your companion. This addon reminds you to summon a new one, either by displaying a text warning and/or flashing the MiniPet button. You can drag and position the MiniPet button wherever it's most convenient for your UI.
Events That Trigger Alerts
- Entering the game
- Entering an instance
- Resurrecting (works most times, but not all)
- Using a Taxi Service
- Teleporting/Hearthing
Usage & Commands
- Click the MiniPet button to summon a random companion!
- Right-click the MiniPet button to hide it.
- Type /MiniPet options [command] or /mp options [command]
Options and Commands:
- gui
- Opens the graphical configuration.
- options
- list
- Shows a list of all the companions on your character.
- relist
- Forces a refresh of the list of companions on your character.
- toggleTextWarning
- Shows text alerts to warn you to summon a companion.
- Text alerts are ENABLED by default.
- Flash or don't flash the button to warn you to summon a companion.
- Flashing is ENABLED by default.
- toggleAutoHideButton
- Hide or don't hide the button after it's clicked.
- Hide on-click is ENABLED by default.
- toggleBg
- Show MiniPet alerts while in a battleground.
- Text alerts in BGs are ENABLED by default.
- toggleMountWarning
- Shows alerts when dismounting a personal flying mount.
- Text alerts when dismounting are ENABLED by default.
- suggestOnlySoulbound
- Sets whether only soulbound companions will be suggested.
- Only soulbound companions are suggested by default.
- reagentCheck
- Sets whether companions that require a reagent to summon will be suggested ONLY if the reagent is currently in your inventory.
- Companions that require a reagent will only be suggested if you have the reagent by default.
- equipmentCheck
- Sets whether companions that are summoned from equipment will be suggested when the item is not equipped.
- MiniPets from equipment will only be suggested when the item is equipped by default.
- forceQuestPet
- Sets whether only companions that are part of a quest will be suggested if they are in your bags.
- Quest companions will be suggested by default.
- button
- toggleButton
- Show or hide the MiniPet button.
- Button is ENABLED by default.
- lockButton
- Locks the position of the MiniPet button.
- The button is not locked by default.
- alpha
- The normal transparency of the button.
- The normal transparency is 100% (1.0) by default.
- fadeOut
- Fades the button out when it is not the cursor is not over it.
- Fading is off by default.
- fadeOutInsteadHide
- Fades the button out instead of hiding it.
- Fading instead instead of hiding is off by default.
- fadeOutCancelInCombat
- Don't fade the button if in combat.
- Fading is stopped if in combat by default.
- fadeOutCancelOnShift
- Don't fade the button if Shift is being held down.
- Fading is not stopped by holding down Shift by default.
- fadeOutCancelOnCtrl
- Don't fade the button if Control is being held down.
- Fading is not stopped by holding down Control by default.
- fadeOutCancelOnAlt
- Don't fade the button if Alt is being held down.
- Fading is not stopped by holding down Alt by default.
- fadeOutTime
- How long it should take to completely fade out the button.
- It will take 0.5 seconds by default.
- fadeOutDelay
- Amount of time to wait before fading out the button.
- It will wait 0.5 seconds by default.
- fadeOutAlpha
- Final transparancy of the button when faded out.
- The final transparancy is 20% (0.2) by default.
- favorites
- list
- Show a list with all of your favorite companions.
- zoneFavorites
- list
- Show a list with all of your zone favorite companions.
Some options can only be set by using WoW's Interface->Addons dialog, which can also be brought up by entering /mp gui.
MiniPet supports ButtonFacade, use /bf to configure the skin and color settings for the button if you have it installed.
MiniPet supports LibKeyBound, use /kb to enter key binding mode.
MiniPet's button will stick to other frames that support LibStickyFrames.
MiniPet outputs the current item it will use using LibDataBroker-1.1. Note that clicking on the item in a Broker addon will not activate the item. You must have MiniPet bound to a key to use it in a Broker addon and hide its own button.
Known Issues
- Alerts do not work when entering non-instanced portals, such as the portal in the Stormwind mage tower.
- Changes to the randomizer means that it will sometimes pick the same companion many times in a row. This is intentional.
Translations
Only the English translation is currently being maintained. While French and German translations exist, they are not being regularly updated.
German translation by Plinius; updated by CrispyRoll.
French translation by Faerian.
Future Plans
------------------------------------------------------------------------
r180 | LordFarlander | 2009-06-05 01:46:43 +0000 (Fri, 05 Jun 2009) | 2 lines
Changed paths:
M /trunk/MiniPet.lua
MiniPet:
- Change paths to use [[]] string format
------------------------------------------------------------------------
r179 | LordFarlander | 2009-06-04 20:27:08 +0000 (Thu, 04 Jun 2009) | 2 lines
Changed paths:
M /trunk/MiniPet.lua
MiniPet:
- Moved FirstSeen to char storage from profile
------------------------------------------------------------------------
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)...
