Download
(41 Kb)
Download
Updated: 01-30-07 08:48 AM
Pictures
File Info
Updated:01-30-07 08:48 AM
Created:unknown
Downloads:4,535
Favorites:38
MD5:
WoWKB
Version: 20003.6
by: ciphersimian [More]
!! BACK UP YOUR SavedVariables/WoWKB.lua !!

Enhancements were made to the import/merge code - you may want to re-import your MetaMap or old WoWKB data as it may pick up additional data (no duplicates will be created)


WoWKB README v20003.6

Released: January 30, 2007
Maintainer: ciphersimian
Original code: Arthesia
Contributors:
Kipple
Regan

Download from any of the following:
http://www.wowinterface.com/download...fo.php?id=4288
http://wow.curse-gaming.com/en/files/details/908/wowkb/
http://ui.worldofwar.net/ui.php?id=1525
http://www.wowguru.com/ui/174/wowkb/

Change Notes
[Version 20003.6]
  • Added a check for nil level from UnitLevel
  • Updated German localization
  • Corrected importing of data for non-english clients
  • Improved importing/merging of data in general
  • Changed handling of 0 coords - will be stored only if no other data is available
  • Removed upgrade functionality for legacy versions of WoWKB (versions before 1800.1 - ancient)
  • Removed 'Method B' import option which used an external lua script

Description

This AddOn stores the name, description, level, rarity and location of all the
NPCs/mobs you mouse over. The location is stored as a range to allow for
movement or various spawn points. The range is updated every time you find the
NPC in a different location. The WoWKB database is global - all your characters
on the same computer and account can access it.


Philosophy
This section is about what WoWKB is and what it is not. The first thing to
know is that it is not possible to precisely determine the location of an NPC
or mob in WoW. Early on they decided to disable the ability to get the
location of anything but yourself to disable range-checking AddOns.

As a result WoWKB doesn't actually keep track of NPC/mob locations - it keeps
track of the position at which you were standing when you moused-over a given
NPC/mob. For the most part, this works fine. The imporant thing to realize
though is that the locations are not going to be exact. In some cases, they
will be pretty far off all depending on how far away from a particular
NPC/mob you can be and mouse-over it.

To better visualize where things can be found I've implemented MapNotes and
Cartographer support which I strongly recommend you take advantage of. There's
an option in MapNotes (enabled by default) which will create a bounding box
with a center point on the map when you left-click an NPC/mob in the results
window. Cartographer supports only the center point as, at the time of this
writing, it has no way to draw lines on the map. This could get cluttered
pretty fast but the way I've intended WoWKB and MapNotes/Cartographer to be
used together makes notes you create on the map, or at least those created by
WoWKB, a very temporary thing. You create notes when you need them (i.e.
hunting a particular mob or looking for a particular NPC) and then when things
start to get cluttered you can remove the notes for a particular NPC/mob by
right-clicking it in the results window or remove all the WoWKB notes by
clicking the Clear Map Notes button.

Of course, I'm open to new ideas on how to best present the data that WoWKB
is able to gather so if you've got any ideas, let me know.


Features
[Slash Commands]

You can use the following commands to perform a search (ommiting search term
will list all records in the database):

/wowkb [search term]
or
/wkb [search term]

[User Interface]

The results are color-coded based on your location:
Green - Within the min/max range the NPC/mob was seen
Yellow - In the same zone as the NPC/mob
Red - In a different zone than the NPC/mob

There are two different formats for the coordinates listed after the name and
description of the NPC/mob.

(XX.XX, YY.YY) - This form means the range is less than three map units which
generally means the NPC/mob stays in the same spot or you
haven't seen it very many times. The X and Y coordinates are
expressed to the nearest 1/100th of a map unit.

(xx-XX), (yy-YY) - This form means the range is greater than or equal to three
map units and expresses the X and Y coordinates as a range
from min x to max X and min y to max Y.

You can sort the results by name, description, level, rarity, zone or
coordinates by clicking on the appropriate column heading. Clicking on the
same heading a second time will sort that column in reverse order. Sorting by
coordinates does a sort by distance for any results which are in the same zone
(green/yellow.)

The number of NPCs/mobs found as well as the number of zones they were found
across is displayed in the information bar. This bar will also display error
messages, etc.


[Other Features]

Remove unwanted entries from the database with <Shift>+<Ctrl>+Right-click

Insert the text from an entry into chat by opening the chat input bar and
then <Shift>+Left-clicking the entry you want to insert.

Import/Merge other WoWKB data files from friends, guildmates, etc. see the
section devoted to this topic below.


[Optional Map Notes Support*]

In the search results window:
Left-click - Add a map note (or a group of MapNotes, see the options below)
on the WorldMap and a MiniNote on the MiniMap for the entry
Right-click - Remove any map notes for the entry

From the main interface:
Clear Map Notes button - clears all the MapNotes/Cartographer Notes created by WoWKB

*Requires:
MapNotes v3.17.20000+ - http://www.wowinterface.com/download...otesFansUpdate
or
Cartographer r25291+ - http://www.wowinterface.com/download...tographer.html


Options
Show Only Local NPCs
Shows only the green and yellow entries when enabled

Show Updates
For debugging purposes, displays database changes (verbose)

Create MapNotes Bounding Box (MapNotes only)
Create four MapNotes with lines connecting them representing the NW,
NE, SW and SE bounds of the NPC/mob versus just a single MapNote marking
the center point

Add MiniNotes To MiniMap (MapNotes only)
Controls whether a MiniNote will be added to the MiniMap when MapNotes are
created by left-clicking an entry

Keep Only The Last MiniNote (MapNotes only)
Controls whether previous MiniNotes will be cleared before adding a new one
to the MiniMap (only in effect if the Add MiniNotes To MiniMap option is
enabled)


Importing/Merging Data
NOTE: MetaMapWKB data is automatically imported when WoWKB loads and detects
MetaMapWKB data so you need only enable both AddOns and enter the game.

NOTE: This feature is for combining multiple WoWKB data files, old versions of
your WoWKB data will be converted to the new data format automatically
when you log into the game with an old version.

1. Log out of WoW

2. BACKUP YOUR WoWKB.lua FILE!
./World of Warcraft/WTF/Account/USER/SavedVariables/WoWKB.lua

3. Open the file to import in a text editor, I'll call it WoWKB2.lua

4. Rename the WoWKB_Data table to WoWKB_ImportData

WoWKB_Data = {
...
}

becomes:

WoWKB_ImportData = {
...
}

5. Rename the WoWKB_State table to WoWKB_ImportState

6. Rename the WoWKB_UnknownZones table to WoWKB_ImportUnknownZones

7. Copy the entire contents of WoWKB2.lua (which contains WoWKB_ImportData,
WoWKB_ImportState and WoWKB_ImportUnknownZones) to the end of the
WoWKB.lua that you want to import it into. If you made the changes to
WoWKB2.lua above, you could accomplish this with the command:

Windows:
C:\> type WoWKB2.lua >> WoWKB.lua

OS X / Linux:
$ cat WoWKB2.lua >> WoWKB.lua

So you have a file like this:

WoWKB_Data = {
...
}

WoWKB_State = {
...
}

WoWKB_UnknownZones = {
...
}

WoWKB_ImportData = {
...
}

WoWKB_ImportState = {
...
}

WoWKB_ImportUnknownZones = {
...
}

8. Log in to WoW, you should see the message:

'<WoWKB>: WoWKB_ImportData merged successfully, added X entries and updated Y'
Post A Reply Comment Options
Unread 12-09-07, 12:21 PM  
stqn
A Deviate Faerie Dragon

Forum posts: 10
File comments: 76
Uploads: 0
[removed original post... was my fault.]

Oops, I had forgotten the "then" in my "fix"... and WowKB.lua thus wasn't loaded correctly.
Last edited by stqn : 12-14-07 at 02:42 PM.
stqn is offline Report comment to moderator  
Reply With Quote
Unread 11-22-07, 05:08 PM  
stqn
A Deviate Faerie Dragon

Forum posts: 10
File comments: 76
Uploads: 0
Thanks for the fix! I made a similar change but still had problems, so instead I inserted this at line 808:

if not description then
description = ""
end

(between:
local playerX, playerY = GetPlayerMapPosition("player")
and:
-- turn 0.123456 into 1234
)

It seems to work fine but I have only played half an hour for now.
Last edited by stqn : 12-14-07 at 02:40 PM.
stqn is offline Report comment to moderator  
Reply With Quote
Unread 10-14-07, 12:53 AM  
vincentgdg
A Murloc Raider

Forum posts: 8
File comments: 10
Uploads: 0
Error

Hello.

Since last patch I get an error whenever moving the mouse pointer over certain mobs.

I fixed it with:

Line 719:
--assert(false, "nil or invalid parameter to StripTextColors")

Line 842:
if description and string.find(description,TEXT(WOWKB_LEVEL),1,true) ~= nil then

Cheers
Vince
vincentgdg is offline Report comment to moderator  
Reply With Quote
Unread 07-22-07, 12:29 PM  
Dohram
A Defias Bandit

Forum posts: 3
File comments: 29
Uploads: 0
I dont suppose this mod has Better Way Points compatability, like the meta map version does, for the database and the bwp is teh onlyreson i used metamap, but it fails, bugs and eats way too much memory, cartographer rocks i liek it way better , and now that i got my database back, its got almost all i need the ability to click on a npc location and have bwp direct you rocks , ill play with these mods littlle more see how it works.
Dohram is offline Report comment to moderator  
Reply With Quote
Unread 07-14-07, 05:51 AM  
ghaxx
A Kobold Labourer

Forum posts: 0
File comments: 2
Uploads: 0
Search field focus

It would be nice to have search field autofocused and option for inline search (results show as you type, not when you press >enter<).
ghaxx is offline Report comment to moderator  
Reply With Quote
Unread 03-16-07, 01:16 AM  
playerwow
A Kobold Labourer

Forum posts: 0
File comments: 2
Uploads: 0
Note Sharing

I cannot seem to get the note sharing feature to work; no matter if the target is in my guild, group or their name is directly typed in.

playerwow is offline Report comment to moderator  
Reply With Quote
Unread 03-06-07, 10:40 PM  
jameyc
A Kobold Labourer

Forum posts: 1
File comments: 3
Uploads: 0
Thanks for the cartographer support. I stopped using Metamap a few months ago, so it's nice to see it back. That should get a few people converted in my guild whom wanted cartographer but didn't want to leave their MetamapWKB.

The thing I'm wondering about is that people commonly distribute metamap exported databases for the MetaMapWKB (the ones imported though MetamapCVT/MetaMapEXP.lua) - is there any way to easily import these into WKB, without my having to first disable cartographer/load metamap/import into metamap/import into WKB... merge the data, if import doesn't already merge with existing data. Then disable metamap and reenable cartographer.

There are a couple of good lists that I like to keep imported into my db, and this feature would be useful for me, simply as a way of saving time.

Not an issue if there isn't any way to, I don't mind doing that every week or two, and understand what a pain it can be to write/test import scripts. I simply wondered, incase the data format in the backup db is close enough, if it could be easily imported.

Thanks!
jameyc is offline Report comment to moderator  
Reply With Quote
Unread 03-06-07, 05:20 PM  
Toran
A Nerdscale Dorkin
 
Toran's Avatar

Forum posts: 142
File comments: 430
Uploads: 0
Re: WoWKB vs. MetaMapWKB

Originally posted by ciphersimian
If MetaMapWKB works fine for you, you're happy with it and it does everything you need then keep on using it.

MetaMapWKB is a branch of WoWKB that most likely occurred because I stopped supporting WoWKB. When I started playing WoW again I picked up MetaMap and found it just had too much crap in it for my tastes - the last straw was when my data got messed up following a patch. I had designed WoWKB so that couldn't happen but all that functionality was removed from MetaMapWKB.

I'm maintaining WoWKB for my own personal use because I prefer it and for others who want a stand-alone mod. This enables me to support both MapNotes and Cartographer so people can use whichever they prefer. I like having more options and combining a crapload of other mods into one Uber mod is difficult to maintain and in my opinion gives a sub-optimal result. One guy maintaining six mods is going to have a hard time maintaining the same level of quality and functionality as six different guys each focused on their piece.
Cipher, I should say that after switching to Cartographer and WKB I'm very happy. I 100% agree with you about the bloat factor. Thanks for all you do for this addon and please keep the updates coming. Turns out this was exactly what I was looking for, but didn't realize it.

-- the only thing that bothers me is the duplications. I brought in my MetaMapWKB which had no dups. Right when it was imported, it seems like 70% of the items were dup'd. What method does this addon use to reduce duplications? If it's the coords, then no wonder why there are so many dups.
Last edited by Toran : 03-06-07 at 08:43 PM.
Toran is offline Report comment to moderator  
Reply With Quote
Unread 02-18-07, 01:42 PM  
ciphersimian
A Kobold Labourer
AddOn Compiler - Click to view compilations

Forum posts: 1
File comments: 8
Uploads: 1
Originally posted by elfchief
Howdy!

I just moved from MetaMap to Cartographer + WoWKB, and so far, I really like what I see!

Just one feature I miss, from MetaMap -- with MetaMap, I could set WKB so that it wouldn't add a new entry unless I hit a (bindable) key. This helped me keep my database very clean and only contain things I cared about.

Would it be possible to get this option in WoWKB?
Yeah, I've had a few requests for this feature so I plan to add it.
ciphersimian is offline Report comment to moderator  
Reply With Quote
Unread 02-18-07, 02:50 AM  
elfchief
A Defias Bandit

Forum posts: 2
File comments: 13
Uploads: 0
Howdy!

I just moved from MetaMap to Cartographer + WoWKB, and so far, I really like what I see!

Just one feature I miss, from MetaMap -- with MetaMap, I could set WKB so that it wouldn't add a new entry unless I hit a (bindable) key. This helped me keep my database very clean and only contain things I cared about.

Would it be possible to get this option in WoWKB?
elfchief is offline Report comment to moderator  
Reply With Quote
Unread 02-15-07, 06:53 AM  
ciphersimian
A Kobold Labourer
AddOn Compiler - Click to view compilations

Forum posts: 1
File comments: 8
Uploads: 1
Phurion,

I've been running with Detached Minimap Buttons and Squeenix for quite awhile now and have not seen a problem with the KB button disappearing.

I've noticed a few other MiniMap buttons with strange behavior like AlphaMap and LootLink but the KB one seems just fine.

What other AddOns are you using? Did you figure out what was going on?
ciphersimian is offline Report comment to moderator  
Reply With Quote
Unread 02-11-07, 04:07 PM  
ciphersimian
A Kobold Labourer
AddOn Compiler - Click to view compilations

Forum posts: 1
File comments: 8
Uploads: 1
WoWKB vs. MetaMapWKB

Originally posted by Toran
I don't get it. Why not just use MetaMapWKB? Seems to have everything I need in it. Why use this and go through all the importing and switching to Cartographer? Beyond Ace 2.

If MetaMapWKB works fine for you, you're happy with it and it does everything you need then keep on using it.

MetaMapWKB is a branch of WoWKB that most likely occurred because I stopped supporting WoWKB. When I started playing WoW again I picked up MetaMap and found it just had too much crap in it for my tastes - the last straw was when my data got messed up following a patch. I had designed WoWKB so that couldn't happen but all that functionality was removed from MetaMapWKB.

I'm maintaining WoWKB for my own personal use because I prefer it and for others who want a stand-alone mod. This enables me to support both MapNotes and Cartographer so people can use whichever they prefer. I like having more options and combining a crapload of other mods into one Uber mod is difficult to maintain and in my opinion gives a sub-optimal result. One guy maintaining six mods is going to have a hard time maintaining the same level of quality and functionality as six different guys each focused on their piece.
ciphersimian is offline Report comment to moderator  
Reply With Quote
Unread 02-04-07, 09:02 PM  
Toran
A Nerdscale Dorkin
 
Toran's Avatar

Forum posts: 142
File comments: 430
Uploads: 0
I don't get it. Why not just use MetaMapWKB? Seems to have everything I need in it. Why use this and go through all the importing and switching to Cartographer? Beyond Ace 2.
Toran is offline Report comment to moderator  
Reply With Quote
Unread 01-22-07, 06:58 AM  
Phurion
A Kobold Labourer

Forum posts: 0
File comments: 8
Uploads: 0
Thanks Cipher.

And my bad on the mod name. It's simple "Detached Minimap Buttons", the latest version available here. Squeenix is the latest version posted over at wowace.com/files.

Hope that helps.
Phurion is offline Report comment to moderator  
Reply With Quote
Unread 01-21-07, 01:39 PM  
ciphersimian
A Kobold Labourer
AddOn Compiler - Click to view compilations

Forum posts: 1
File comments: 8
Uploads: 1
Phurion,

Your point is well taken - I'll start leaving the last 2-3 good versions available for download.

I'll look into the MiniMap Button problem, it must be related to DetachableMiniMapButtons or Squeenix minimap. I don't currently use either of those and I've never seen the MiniMap button not be there.

[EDIT]: I can't find DetachableMiniMapButtons anywhere and the only version of Squeenix I'm finding hasn't been updated since June '06. Can you send me the versions you are using (e-mail in WoWKB.toc file.)
Last edited by ciphersimian : 01-21-07 at 01:54 PM.
ciphersimian is offline Report comment to moderator  
Reply With Quote
Post A Reply



Category Jump: