vanilla-wow-addons – Blame information for rev 1

Subversion Repositories:
Rev:
Rev Author Line No. Line
1 office 1 MobInfo-2 is a World of Warcraft AddOn that provides you with useful additional information about Mobs (ie. opponents/monsters). It adds new information to the game's Tooltip whenever you hover with your mouse over a mob. It also adds a numeric display of the Mobs health and mana (current and max) to the Mob target frame. MobInfo-2 is the continuation of the now abandoned "MobInfo" by Dizzarian combined with the original "MobHealth2" by Wyv.
2  
3 [[ IMPORTANT NOTE FOR DEVELOPERS OF OTHER ADDONS: ]]
4 [[ Please read the informatin in "ReadMe_MobInfo_API.txt" ! ]]
5  
6  
7 *****************************
8 *** MobInfo-2 Data ***
9  
10 MobInfo collects data whenever you fight a Mob. It starts off with an empty database, which fills up automatically the more you fight and play. The data it collects is used for enhancing the game tooltip and the game target frame. It is also available to other AddOns (mostly the mob/target health values).
11  
12 NEW FEATURE: The MobInfo database has become searchable. You can do a search for the 12 most profitable Mobs. You will find the "Search" button on the "Database" page of the options dialog.
13  
14  
15 ******************************************
16 *** Extra Information For Game Tooltip ***
17  
18 The extra information available to show on the game tooltip is:
19  
20 Class - class of mob
21 Health - current and total health of the mob
22 Mana - current and total mana of the mob
23 Damage - min/max damage range of Mob against you (stored per char)
24 DPS - your DPS (damage per second) against the Mob (stored per char)
25 Kills - number of times you have killed the mob (stored per char)
26 Total Looted - number of times you have looted the mob
27 Empty Loots - number of times you found empty loot on the mob
28 XP - actual LAST xp amount you gained from the mob
29 # to Level - number of kills of this mob neede to gain a level
30 Quality - the quality of items that are dropped by the mob
31 Cloth drops - the number of times cloth has dropped on the mob
32 Avg Coin Drop - average amount of money dropped by the mob
33 Avg Item Value - average vendor value of items dropped by mob
34 Total Mob Value - total sum of avg coin drop and avg item value
35  
36 Note that MobInfo offers a "Combined Mode" where the data of Mobs with the same name that only differ in level gets combined (added up) into one tooltip. This mode can be enabled through the options dialog
37  
38  
39 ***************************************
40 *** Target Frame Health/Mana Values ***
41  
42 MobInfo can display the numeric and percentage values for your current targets health and mana right on the target frame (formerly known as MobHealth functionality). This display is highly configurable through the MobInfo options dialog (position, font, size, etc).
43  
44  
45 ******************************
46 *** MobInfo Options Dialog ***
47  
48 Type "/mi2" or "/mobinfo2" on the chat prompt to open the MobInfo2 options dialog. This dialog gives you full interactive control over EVERYTHING that MobInfo can do. All options take immediate effect. Simply try them all out. Decent defaults get set when you start MobInfo for the first time. Note that the 3 main categories "Tooltip", "Mob Health/Mana", and "Database Maintenance" have separate dedicated options pages within the options dialog.
49  
50 Note that everything in the options dialog has an associated help text that explains to you what the option does. The help texts are shown automatically as a tooltip.
51  
52 **NEW FEATURES** : Have a look at the "Database" page of the options dialog. Several new features have been added here, like "Clear" buttons and a "Search" button for finding the most profitable Mobs.
53  
54  
55 **********************
56 *** How to Install ***
57  
58 Unpack the ZIP file and copy the folder 'MobInfo2' into your 'World of Warcraft\Interface\AddOns' folder. MobInfo-2 will automatically load the next time you login with one of your chars. When starting the first time you might get a message that a separate MobHealth AddOn was detected. If so please remove it, or at least disable it. You will find that it is no longer needed, because MobInfo-2 is a full featured and fully compatible replacement.
59  
60  
61 **********************************************
62 *** IMPORT of an External MobInfo Database ***
63 **********************************************
64  
65 MobInfo can import externally supplied MobInfo databases. This can be a database from a friend of yours or a database that you have downloaded somewhere. WARNING : the database that you import MUST be from someone who uses exactly the same WoW localization as you do (ie. the same WoW client language). Importing a MobInfo database rom someone using a different WoW language will NOT work and might destroy your own database.
66  
67 First of all before importing data you should make a backup of your own database. It never hurts to be able to restore your original data in case you are unhappy with the import result. The entire MobInfo database is contained within this file:
68 \World of Warcraft\WTF\Account\<your_account_name>\SavedVariables\MobInfo2.lua
69  
70 Make a copy of that exact file to a save location. This is also the file that you must pass on if you want to give your MobInfo database to someone else. Which of course means it is also the file you receive when someone else gives you his MobInfo database.
71  
72 Here are the detailed import instructions:
73  
74 1) Close your WoW client
75  
76 2) Backup your MobInfo database as explained above
77  
78 3) Rename the database file that you want to import from "MobInfo2.lua" to "MI2_Import.lua"
79  
80 4) Copy the file "MI2_Import.lua" into this folder:
81 \World of Warcraft\Interface\AddOns\MobInfo2\
82 (that is the folder where the AddOn has been installed)
83  
84 5) Start WoW and login with one of your chars
85  
86 6) Open the MobInfo options (enter "/mi2" at the chat prompt) and go to the "Database" options page. Near the bottom of the page you should now see whether the AddOn has found valid data to be imported. If you did everything correctly the "Import" button should be clickable.
87  
88 7) Choose whether you want to import only unknown Mobs, otherwise all Mobs will get imported. If a Mob already exists in your database and you choose to import it the data of the new Mob will get added to the data of the existing Mob. Now click the Import button to star the database import operation. In your normal chat window you will see a summary of the import results.
89  
90 8) Logout to cause WoW to save your now extended MobInfo database file. You should now delete the file "MI2_Import.lua". It is no longer needed and it will waste memory as long as it exists.
91  
92 TIP : use the "import only unknown Mobs" if you know that there is a large amount of overlap between your current database and the imported database. For instance if you import data from the same source again (because he released a newer version).
93  
94 TIP2 : You can also use this Import feature to import databases of the "MobHealth" AddOn. Use the instructions exactly as listed above, but in step 2 rename "MobHealth.lua" (the MobHealth database file from "savedvariables" folder) to "MI2_Import.lua".
95  
96  
97 *****************************************
98 *** Conversion of DropRate Database ***
99 *****************************************
100  
101 The integrated DropRate converter can convert the contents of a DropRate database into MobInfo database entries. Yet in order for the converter to work an additional item database must be installed. THIS IS ABSOLUTELY MANDATORY !
102  
103 Right now the DropRate conversion supports the following item database tools: ItemSync (from Derkyle), LootLink and LootLink Enhanced (from Telo and Brodrick) and KS_Items (from Kaelten). You MUST have one of these AddOns installed and you MUST have a sufficiently large database. Why is this so important ? Because DropRate recorded only the item names, which is highly inefficient. All modern tools use instead mainly the item ID code. Yet name to code conversion is tricky, because the WoW client does not support this. Instead an item database is required that knows item names and that can convert a given item name into an item ID code. The AddOns that MobInfo currently supports all offer this feature.
104  
105 Right now Using LootLink is recommended for the conversion because AddOns sites like "http://ui.worldofwar.net" host huge downloadable LootLink item databases that ensure a high conversion success rate. After successful conversion LootLink (or any other item database tool) can be uninstalled, if you dont want to keep it.
106  
107 Note that whenever the item database AddOn does not know an item from the DropRate database this item can NOT be converted into the MobInfo database. Therefore Mobs with unknown items can only be partially converted. The unknown items will be missing from the Mobs when looking at their MobInfo data.
108  
109 Here is how to make the conversion:
110  
111 1) You must have the following AddOns installed and active: MobInfo, DropRate, and either ItemSync or KC_Items. I'd like to mention that I made all my tests with ItemSync and it worked very well.
112  
113 2) Backup your MobInfo database as explained in the "IMPORT" chapter. Similarely backup your DropRate database. The conversion will modify both databases ! Therefore it is very important to have backups of the originals so that you can go back to the state before the conversion, in case you encounter a problem, or in case you are not happy with the result
114  
115 3) To start the conversion enter "/mi2 convertDropRate" at the chat prompt. The conversion result will appear in the standard chat log window.
116  
117 4) Logout from WoW to make WoW save your modified database files.
118  
119 5) Now have a look at the file "savedvariables/DropRate.lua" (this is the DropRate database in the "savedvariables" folder). This database has been modified by the converter. All data that was converted successfully has been removed from the database called "drdb". All entries that still exist in "drdb" represent data (Mobs or other stuff) that the converter has not converted. Non Mob data will always remain because MobInfo does not support this (chests, mining, etc). If Mobs remain it means that the Mob references unknown and thus unconvertable items.
120  
121 6) If the conversion result is OK you can simply leave things as they are. If very many items were not converted then you should try to obtain a larger items database and start the conversion again from step 3. You can repeat the conversion as often as you like because the converted removes all successfully converted data from the DropRate database.
122  
123 NOTE: During normal game play you should NEVER (!) have both DropRate and MobInfo running. Doing so will result in incorrect data when you start the converter. Both AddOns will record the same data and starting the converter will copy the DropRate data into the MobInfo database, which will incorrectly double some of the data for the Mob. You should ONLY have both AddOns active at the same time for the purpose of doing a conversion.
124  
125 7) If the conversion encounters an error, or in case you are unhappy with the result of the conversion, please use the backups you made in step 2 to go back to your previous databases. To restore your databases you MUST first exit WoW. Then simply copy the backups of "MobInfo2.lua" and "DropRate.lua" into your "savedvariables" folder. Start WoW again and you should have your old data back. Please observe the NOTE above and NEVER play with MobInfo and DropRate active at the same time.
126  
127  
128  
129  
130 ***-----------------------------------------------***
131 ***-----------------------------------------------***
132 F. A. Q. - Frequently Asked Questions
133 ***-----------------------------------------------***
134 ***-----------------------------------------------***
135  
136  
137 ******************************************************
138 ** Where do the health values come from ?
139 ** Why do max health values change so much at first ?
140  
141 WoW itself does not allow AddOns to see the numeric health value of a Mob or other players. Instead WoW reports only a percentage value. To obtain an absolute health value this value must be calculated, or more correctly approximated. Thats what MobInfo does. In order to do this you must fight the creature. During the fight the damage you do is reported as actual damage points. The current health of the Mob is reported as percentage values. What MobInfo does is add up the damage numbers and calculate the corresponding difference in health percentage. The result is the number of points-per-percent (PPP) for the Mob. PPP times 100 thus is the maximum health value for the Mob. PPP allows calculating the numeric health value of a Mob from the Mobs health percentage.
142  
143 The data collected during one fight is not sufficient to get a good reliable PPP value. It needs accumulation of the data for at least 5 to 10 fights to get a reliable stable PPP value and thus a reliable and stable max health value for the Mob. In fact MobInfo will accumulate the data for 100 fights to obtain the best possible health approximation for a Mob. If you do not like to see a changing maximum health value for a Mob during a fight you can use the MobInfo obtion "Show stable Health Max". The health max will only get updated in between fights when activating this.
144  
145 The method described above for approximating a Mobs health was first developed by "Telo" for his AddOn "MobHealth". It was then refined by "Wyv" for his own AddOn "MobHealth2". The MobInfo implementation is based on "MobHealth2" with kind approval of Wyv.
146  
147 ******************************************************************
148 ** How do I change tooltip position or tooltip popup behaviour ?
149  
150 MobInfo only adds information to the tooltip, but it does not modify where or how the tooltip appears. To change this there are a large number of real good tooltip controll AddOns available. I can't list them all here, but some of the better and more popular ones are: TipBuddy (http://ui.worldofwar.net/ui.php?id=607), AF Tooltip Extreme (http://ui.worldofwar.net/ui.php?id=2416), or TooltipsKhaos (part of Cosmos compilation: http://www.cosmosui.org/).
151  
152  
153  
154 ***-----------------------------------------------***
155 ***-----------------------------------------------***
156 MobInfo-2 Version History
157 ***-----------------------------------------------***
158 ***-----------------------------------------------***
159  
160 ver 2.97
161 - updated to comply with newest WoW version 1.11
162 - show items on search options page in correct item color
163 - search options page again shows result list size
164 - fixed bug in search for Mobs that drop a certain item
165  
166 2.96
167 - new feature: store health value obtained through Beast Lore in health database
168 - new feature: added chinese translation submitted by Andyca Chiou
169 - fixed nil error for items with legendary and artifact rarity
170  
171 2.95
172 - bugfix release : fixes wrong max health display
173  
174 2.94
175 - huge update of MobInfo vendor sell price table (over 1000 new prices)
176 - DropRate conversion now supports LootLink databases
177 - fixed: DropRate conversion nil bug "Mobinfo2.lua Line: 383"
178 - fixed bug where health was displayed wrong after using "BeastLore" on Mob
179  
180 2.93
181 - new feature: implemented DropRate database converter from NakorNH
182 - bugfix: correctly import locations for mobs in instances
183 - added new items (loot from Silithus) to MobInfo item price table
184 - several new skinning loot items added to skinning loot detection table
185  
186 2.92
187 - new feature: you can choose to import only unknown (ie. new) Mobs
188 - improved item colors in Mob tooltip for better readability
189 - fixed all health/mana updating issues for unit frame and tooltip
190 - fixed max health not increasing correctly for group member targets
191  
192 2.91
193 - new feature: importing of externally supplied MobInfo databases
194 - new feature: option to delete all Mobs shown in search result
195 - added Turtle Scales to skinning loot detection table
196 - show all "green hills of Strangle" pages on one tooltip line
197 - item list on search page: show all items if item name field is empty
198 - fixed: mob name search errors on special chars
199 - fixed: correct independant show/hide of basic loot items
200  
201 2.90
202 - added separate tooltip option for cloth and skinning loot
203 - show drop percentages for items in Mob tooltip
204 - calculate skinning loot percantage based on skinned counter
205 - rearranged tooltips options page
206 - new skinning loot support for Shiny Fish Scales and Red Whelp Scales
207  
208 2.89
209 - reinserted missing spaces in tooltip health
210 - abbreviate long tooltip item names instead of using 2 lines
211 - fixed to correctly call original GameTooltip:OnShow()
212  
213 2.88
214 - fixed ItemSync support to behave properly
215 - fix for stack overflow caused by CastParty AddOn
216 - internal event handling improvements
217  
218 2.87
219 - bugfix for NIL bug "MI2_Events.lua:100"
220  
221 2.86
222 - fixed to support newest version 12 of ItemSync
223 - fixed health updating during combat within Mob tooltip
224 - improved and extended Spanish localization (thanks to Pyrgus Malvae)
225 - fixed: show correct health updates for group member targets
226  
227 2.85
228 - fixed Spanish localization: should work now
229  
230 2.84
231 - fixed incorrect counting of item quantities
232 (special thanks to Nakor for finding all those tricky item bugs)
233 - basic spanish localization for MobInfo (thanks to Pyrgus Malvae)
234  
235 2.83
236 - feature: added keybinding for MobInfo
237 - feature: always show mana/rage/energy value if available
238 - bugfix: incorrect health percentage for party members
239  
240 2.82
241 - bugfix: not counting skinning loot correctly
242 - bugfix: quest items getting counted in quality overview
243 - bugfix: health not updating when Mob health itself
244 - updated french localisation (thanks to Sasmira)
245  
246 2.81
247 - drastically improved French translation (many thanks to Sasmira!)
248 - fixed NIL bug for "Mobinfo2.lua:1432"
249 - improved MI2_Browser data import and error checking
250  
251 2.80
252 - updated version number for WoW 1.10 compatibility
253 - new feature separate "skinned" counter
254 - new feature: mob location recording
255 - addded mob location to tooltip and options
256 - automatic conversion of MI2-Browser location data
257 - sort "Dropped By" list also by reliability of percentage
258 - reduced database size by storing char names in separate table
259 - combined basic mob data with quality overview data
260 - bugfix: empty loot counting should now always work
261 - bugfix: improved health calculation accuracy
262 - bugfix: do not count quest items in quality overview
263 - improved compatibility with TipBuddy 2.10 Compact Mode
264  
265  
266 (for previous version info or any questions regarding MobInfo-2 please visit http://www.dizzarian.com/forums/viewforum.php?f=16)
267