Rarity

Table of Contents

NEW:

Support for Cataclysm Classic (experimental)
Rarity now has a Discord server!

If you're interested in following the development process or contributing, you should also check out the official GitHub repository. We're always in need of more hands to help us make the addon better!

Rarity tracks how many times you've tried to obtain various rare items like mounts, battle pets, and toys. It will tell you how likely you are to obtain the item, track how long you've been farming for it, and tell you how lucky you've been so far. Although it's mostly used for mounts, battle pets, and toys, it supports pretty much any item, including profession patterns, archaeology projects, and more.

Looking for Rarity Item Packs? Click here.

Out of the box, Rarity includes support for every single mount, battle pet, and toy in the game which require some time to farm. It also includes support for some mount-related items like Skyshard, Primal Egg, and Giant Dinosaur Bone. It'll even notice if you mouseover a Mysterious Camel Figurine, plus lots of other stuff. Rarity factors in the size of a typical group when determining probabilities, and can also tell you if you've killed various bosses this week (or day). Holiday just started, and you didn't notice? Rarity will give you a helpful reminder to run those holiday dungeons or daily quests if you still need an item from them.

If Rarity doesn't track something you want to track, you can add it yourself! Just about everything is user configurable.

Curious what math is going on behind the scenes? The author of Bunny Hunter created the original algorithms. He wrote an article about it here. Your chance to obtain an item doesn't increase as you farm it; Rarity is just telling you how lucky you've been so far. It can be remarkably cathartic to see a progress bar move up as you spend hours upon hours trying for that Disgusting Oozeling.

Main features

Rarity is primarily an LDB feed with a large tooltip. It can function as either a mini-map icon (you have to turn this on in the options), or as a standard LDB feed (use a display like Fortress, Button Bin, Titan Panel, or Chocolate Bar).
Provides a progress bar, which you can toggle by clicking the icon or feed label.
Adds info to NPC and item tooltips, showing you if it drops or contains something that Rarity tracks. Rare mobs with a guaranteed drop show which item they drop and if you've defeated them yet.
Includes full source info, telling you how to obtain everything Rarity tracks.

Other features

Share packs of items with other users
Can automatically add waypoints to TomTom for certain items
Uses statistics whenever possible to keep track of attempts
Breaks your farming down by session, day, week, and month
Looks at your instance locks to see if you've defeated various bosses recently
Reminds you if you need to farm a holiday dungeon or daily quest, and hides holiday items that aren't available right now
Supports bonus coin rolls
Automatically screenshots when you obtain an item
Keeps track of rare achievements like Frostbitten and Glorious
You can add your own items to track
Lets you modify your attempt count without having to edit saved variables
Automatically imports data from Bunny Hunter if you're switching

Slash Commands

Simply typing /rarity should open the options menu (unless disabled).

For troubleshooting issues:

/rarity dump displays the most recent debug log entries (even if the debug mode is disabled)
/rarity validate checks the consistency of your item database, including custom items (experimental)

Comments

Forge_User_24199669
- Join Date: 6/27/2012
- Posts: 0
- Member Details
#1318 Forge_User_24199669

View User Profile

Send Message

Posted Mar 9, 2017
You could also add

{m=875,i=true},{m=867,i=true},{m=876,i=true},{m=887,i=true},{m=877,i=true},{m=885,i=true}

at the end of the map id list to add the dungeons to the list also.

Also 61444 doesn't track for me, could try adding 61442 and 61445 as the other 2 id's for the bosses in that trial to see which tracks the chest opening.

Last edited by Forge_User_24199669: Mar 9, 2017

Rollback Post to Revision RollBack
_ForgeUser16035346
- Join Date: 2/27/2017
- Posts: 0
- Member Details
#1312 _ForgeUser16035346

View User Profile

Send Message

Posted Feb 27, 2017
Hi, how can i remove the achievment of pets? i'm not interested at all and all it does is getting my hopes up when i think it is a mount, i have to uncheck manually all the pets? thanks

Rollback Post to Revision RollBack
AllaraStarmist
Curse Premium
- Location: San Francisco
- Join Date: 2/18/2005
- Posts: 364
- Member Details
#1313 AllaraStarmist

View User Profile

Send Message

Posted Feb 28, 2017
Just collapse the pet group. If you really want to stop Rarity from telling you when you've made an attempt toward a pet, yes you need to turn them all off manually. Pets and mounts almost never overlap, so I'm not sure what you're saying here.

Rollback Post to Revision RollBack
_ForgeUser16035346
- Join Date: 2/27/2017
- Posts: 0
- Member Details
#1314 _ForgeUser16035346

View User Profile

Send Message

Posted Feb 28, 2017
i mean the "achievment style" that popup when you drop a pet, is the same as the mount one, but with the pet, so if i'm hoping to drop the invincible and an achi pop up i almost collapse, but is a pet everytime.

I turned off manually

I was talking only about the achievment style popup

Rollback Post to Revision RollBack
AllaraStarmist
Curse Premium
- Location: San Francisco
- Join Date: 2/18/2005
- Posts: 364
- Member Details
#1316 AllaraStarmist

View User Profile

Send Message

Posted Mar 7, 2017
Well, the achievements are kind of the point! :) But yes, you'll need to turn off the ones you don't want to see.

Last edited by AllaraStarmist: Mar 7, 2017

Rollback Post to Revision RollBack
malfunction__
- Join Date: 5/31/2011
- Posts: 2
- Member Details
#1310 malfunction__

View User Profile

Send Message

Posted Feb 9, 2017
Trying to track my my fishing attempts for Shard of Darkness for the Ashbringer skin, but its not tracking. Can you tell me what I'm doing wrong?

AV4xXlReU2l0ZW1zXlReTjFeVF5Tem9uZXNeVF5OMV5TMjheTjJeUzEzOV50XlN0eXBlXlNJVEVNXlNtZXRob2ReU0ZJU0hJTkdeU2xhc3RBdHRlbXB0c15OMF5TZGlzYWJsZUZvckNsYXNzXlReU1BBTEFESU5eQl50XlNpdGVtSWReTjEzOTYyNF5TbmFtZV5TMTM5NjI0XlNleHBvcnReQl5TY2hhbmNlXk4xMDAwXlNpbnN0YW5jZURpZmZpY3VsdGllc15UXk4wXmJedF5TYXR0ZW1wdHNeTjRedF50XlNzaWduYXR1cmVeU1JGSTJQRDRqT2pKME5udGdJbmMvWkE9PV5TYnVpbGReTjU4NV50Xl4=

Rollback Post to Revision RollBack
AllaraStarmist
Curse Premium
- Location: San Francisco
- Join Date: 2/18/2005
- Posts: 364
- Member Details
#1311 AllaraStarmist

View User Profile

Send Message

Posted Feb 10, 2017
I no longer have an active WoW account, so I can't import your string. I can try to help if you describe what you did, or another user can help.

Rollback Post to Revision RollBack

RDW

Curse Premium

Join Date: 9/7/2012
Posts: 514
Member Details

#1329 Posted Apr 8, 2017

In reply to malfunktionv2:

Probably way too late, but... for posterity:

AzlxA/8CahRYjxTahaJeI0Vmo5KbKsgvFdRtKjuh9pLdkOwXoZ9IFcMov1HkNEpDUdBgVGo4qg6iUJdVHVM6J1iIVGopUspipMJyFXqsAk8VyyTPpUxEqpqKZLJIpoOLSMF5pKRnVF0XkY0q2gaxGVKfRdRHpJKvSIlpQuNUGolU6RtitAjGI6U6KVK3UHFN1D0UshIpai1S0WGp1orSsPCuiRKuLEpDIxPqmyjh1dDyDf6ISuRmyNWTk56ro1JNoAFa+dekKRoOadxDAlNKc6aH3jSmS8PVGzAGeMdDEzYNqrvXTEI/phK5mdCJ3PT7kSbUt6Zh4V06Jbw+IBU1wLrXSfZGn31GFkGIvyU0x19NqsM3UcJlS8xbEKUB1r3OjFxPyMa6m0MMJTQnRk0HeMdDE64sEC5bYutXlAZY98J7r2euCpoO8I6HJrxmAuGyJVYVRWmAda/zWvShCtlcFi/iheZE03SAdzw04VhBIFy2xLytKA2w7nVmxHxEvIV7c8hLhOZEoun/Au94aMJeIFy2xKqIKA2w7oXL58i8WyGEEELQdIB3PDThHK9AuGyJVV1RGmDd67yeBDMLt0goYis0J5qmA7zjoQmvlUC4bIl5y6I0wLrXma8ZQW4hGyNBSBCaE72mA7zjoQlHIhAuW2LeEFEaYN0L+/XMlZEQQgiBZE0HeMdDE64sEC5bYmUlSgOse53ExyWRmG1YJO4KzYlZ0wHe8dCENwuEy5aYNyJKA6x7YYQgzDeYmZnZek0HeMdDE84mEC5bYlVZlAZY9zpzrS+E+K0bzCNXaE40TQd4x0MT9rUCgeYgoaMOXrjMTPO080xHEN2aDvCOhya8SDaBQNPYZFSHpONraDvTxZB+ZEAPA5oNoyA5jTo4TCdjRow0dCSxXCnhTIhAAg==

malfunction__
- Join Date: 5/31/2011
- Posts: 2
- Member Details
#1338 malfunction__

View User Profile

Send Message

Posted May 21, 2017
In reply to Cakechart:

Just tried this import but Rarity kicked it back as invalid

Rollback Post to Revision RollBack
RDW
Curse Premium
- Join Date: 9/7/2012
- Posts: 514
- Member Details
#1339 RDW

View User Profile

Send Message

Posted May 23, 2017
In reply to malfunktionv2:

Indeed! In my naivety I (wrongly) assumed that importing would be straight-forward. However, after some serious investigation into the intricacies of the import/export encoding, I can safely say that the feature is either broken, or can be considered as having a huge conceptual flaw or two at the very least.

In this case, you can't import the string because it stores the custom item ID from MY local copy (which is 25), and then fails to validate the string because it's not the first item (index 1).

I'm not sure what to make of it, but I doubt it will be changed/fixed for obvious reasons :P Anyway, as for your problem: Since I don't want to delete all my custom items, I can offer the following hack (it's the best I can do here):

1. Go to Interface\Addons\Rarity_Options\
2. Create a backup of Options.lua, then open it and
3. On line 1085, replace the entire line, that is

if type(e) == "table" and e.items and type(e.items) == "table" and #e.items > 0 and e.build and tonumber(e.build) > 0 and e.signature and e.signature == IMPORTEXPORT_SIGNATURE then

with

if type(e) == "table" and e.items and type(e.items) == "table" and (#e.items > 0 or e.items[25]) and e.build and tonumber(e.build) > 0 and e.signature and e.signature == IMPORTEXPORT_SIGNATURE then

This will allow my export string to be recognized as valid, and have no adverse effects, but you should still change it back afterwards just to be sure (or don't).

Now, export this string:

AV4xXlReU2l0ZW1zXlReTjI1XlReU3pvbmVzXlReTjFeU1dlc3Rlcm5+YFBsYWd1ZWxhbmRzXnReU2V4cG9ydF5CXlNtZXRob2ReU0ZJU0hJTkdeU2NoYW5jZV5OMjAwMF5TbmFtZV5TU2hhcmR+YG9mfmBEYXJrbmVzc15TdHlwZV5TSVRFTV5TaXRlbUlkXk4xMzk2MjRedF50XlNzaWduYXR1cmVeU1JGSTJQRDRqT2pKME5udGdJbmMvWkE9PV5TYnVpbGReTjU3N150Xl4=

It's a different one because I removed all unnecessary data (my attempts etc), which also makes it a lot shorter.
Rollback Post to Revision RollBack
RDW
Curse Premium
- Join Date: 9/7/2012
- Posts: 514
- Member Details
#1340 RDW

View User Profile

Send Message

Posted May 23, 2017
In reply to malfunktionv2:

Oh, and an addendum to solve your original problem:

Your string differs from mine in that it uses zone IDs, and restricts it to only consider Paladins. I don't know if that makes much of a difference, but since you're extremely unlikely to go fishing anywhere else in Western Plaguelands, with any character, I just set it to be more forgiving.

That said, your map IDs are wrong. /dump GetMapNameByID(28) returns "Searing Gorge", and 139 is entirely invalid. You probably took them from wowhead, but their zone IDs are different from those used by the game. Western Plaguelands is actually 23, and Eastern Plaguelands has 22 - although it only drops on the western shore so I'd remove that.

Additionally, the chance is apparently closer to 1/2000 than 1/1000. I arrived at this conclusion from wowhead's aggregated comment data, which averaged out to some 1.9k attempts (for what it's worth) :)

In retrospect, this will be much easier for you to change than the LUA file + import. If it still doesn't work, you can always fall back to using that option.

Last edited by RDW: May 23, 2017

Rollback Post to Revision RollBack
AllaraStarmist
Curse Premium
- Location: San Francisco
- Join Date: 2/18/2005
- Posts: 364
- Member Details
#1342 AllaraStarmist

View User Profile

Send Message

Posted May 29, 2017
In reply to Cakechart:

Hey Cakechart, if you see this. I'm going to try to come back at least with a Starter Edition account to get Rarity working in 7.2. I saw your comments about the Import/Export system being fundamentally broken and I think I sort of understand what you're saying. Based on your fix it looks like yet another failure of the # operator in Lua. This is an easy fix. Rarity doesn't actually care what table index anything is at in the import.

Rollback Post to Revision RollBack
RDW
Curse Premium
- Join Date: 9/7/2012
- Posts: 514
- Member Details
#1343 RDW

View User Profile

Send Message

Posted May 30, 2017
In reply to Allara:

I'm glad to hear it. Yes, it is not a difficult thing to fix, what I proposed was merely a workaround for this particular import string, because I didn't want to make things even more complicated [for other users]. I did notice the index matters little and so I'd simply replace that check with a version that doesn't break if indices are missing, but still returns whether or not the table is empty.

That isn't exactly a failure, I believe it's "working as intended". From the Lua manual:

The length of a table t is defined to be any integer index n such that t[n] is not nil and t[n+1] is nil; moreover, if t[1] is nil, n can be zero. For a regular array, with non-nil values from 1 to a given n, its length is exactly that n, the index of its last value. If the array has "holes" (that is, nil values between other non-nil values), then #t can be any of the indices that directly precedes a nil value (that is, it may consider any such nil value as the end of the array).

That is pretty much all that went wrong; there are "holes" in it and so it won't count the entries correctly. With "fundamentally broken" I meant that it generally won't work, only in the special case of exporting N entries from the start (where N can be all of them, if none are missing "in between").

Disclaimer: I haven't tested this with different types of exports, but it's what I got from looking at the respective lines in the code.

Last edited by RDW: May 30, 2017

Rollback Post to Revision RollBack
AllaraStarmist
Curse Premium
- Location: San Francisco
- Join Date: 2/18/2005
- Posts: 364
- Member Details
#1344 AllaraStarmist

View User Profile

Send Message

Posted May 30, 2017
In reply to Cakechart:

Yeah basically what I mean is # is generally useless. It would be useful if it returned the number of things in an array. I'm not sure why it even exists in its current form. I try never to use it.

I did test the feature as well as I could on my own and it generally works. I'll just change it to iterate using pairs and count that way (which is what I usually do).

Rollback Post to Revision RollBack
RDW
Curse Premium
- Join Date: 9/7/2012
- Posts: 514
- Member Details
#1345 RDW

View User Profile

Send Message

Posted May 30, 2017
In reply to Allara:

From how I understand it, that isn't quite right. In this case it doesn't matter, but it is "generally" much faster than iterating if all you want to do is count a regular, properly numbered array. luaH_getn (= #) operates in constant time while i/pairs obviously do not (as they iterate over each element = linear time), so I'd always use it whenever possible even if I highly doubt someone wants to import millions of entries into Rarity :P

That performance was apparently achieved by highly optimizing the algorithm for the kinds of tables Lua uses as well as the most common use case where efficient counting would be of interest (sequences, table length of 2^x). I'd suspect counting other types of arrays isn't possible with this approach without giving up that advantage.

As for the import feature, you could simply table.insert / tinsert the entries. The table with key [25] would become [1] in my example, discarding the key Rarity doesn't care about anyway and continue to use # with no drawbacks, as you already iterate through them before compressing and serializing them:

e.items[itemkey] = item

in line 1224 could become

table.insert(e.items, item)

or, in fact,

e.items[#e.items+1] = item

- which is faster, although not by entire orders of magnitude. This way, the validation shouldn't need any changes at all.

And there we have another example for using # that justifies its current form. If it wasn't as fast, using this shortcut would be a terrible idea :)
Last edited by RDW: May 30, 2017

Rollback Post to Revision RollBack
AllaraStarmist
Curse Premium
- Location: San Francisco
- Join Date: 2/18/2005
- Posts: 364
- Member Details
#1346 AllaraStarmist

View User Profile

Send Message

Posted May 30, 2017
In reply to Cakechart:

r589 should fix that validation issue.

I don't really care to continue debating Lua at the moment :), but this isn't code that needs to be performant. And you'll see I in fact did an early exit on the iterator, so it only goes through one item anyway. In my world of WoW add-ons, the number of consecutively-numbered tables I utilize is close to zero, so the # operator is pretty useless for me. Also it is far less risky to change the validator than to change the exporter in my opinion.

We never iterate on tables in any performant sections of Rarity. It's all hash lookups using the indexer. In fact I put a lot of work into ensuring this was the case.

Anyways, I wasn't able to find any other issues with Rarity in 7.2. I'm aware that all the Calendar functions are deprecated, but it's easier to wait until they actually go away before fixing them. Anything else I missed?

Rollback Post to Revision RollBack
RDW
Curse Premium
- Join Date: 9/7/2012
- Posts: 514
- Member Details
#1348 RDW

View User Profile

Send Message

Posted May 31, 2017
In reply to Allara:

Oh, yeah. As I said, it doesn't matter in this case but I figured it's not ENTIRELY useless :) Sorry if I got carried away a little.

That proposed change doesn't change the workings at all, as it merely rewrites the index to always be in order. In any event, any solution is fine for this minor issue.

Otherwise, there's only a few things that I can think of, gathered from the comments:

7.2 mounts from the Paragon caches aren't tracked

Midnight's Eternal Reins (Return to Karazhan) is missing (?)

The Group Finder API (Search() as used by the checkbox) is now protected after the Anti-WQGF hotfix

For the most part, everything is still working as expected. Thanks for all the work you put into this addon, by the way!
Rollback Post to Revision RollBack
AllaraStarmist
Curse Premium
- Location: San Francisco
- Join Date: 2/18/2005
- Posts: 364
- Member Details
#1349 AllaraStarmist

View User Profile

Send Message

Posted May 31, 2017
In reply to Cakechart:

Oh yeah forgot about group finder. When I put that feature in I knew it was only a matter of time before it caused server stress. Took longer than I thought it would haha!

Thank you for your help. :)

(Oh and the other problem with changing the exporter as the fix means any existing strings floating around still wouldn't work. So I preferred to fix it so those strings started working.)

Rollback Post to Revision RollBack
RDW
Curse Premium
- Join Date: 9/7/2012
- Posts: 514
- Member Details
#1355 RDW

View User Profile

Send Message

Posted May 31, 2017
In reply to Allara:

I don't think many people were using that feature, at least not enough to prompt a hotfix. From what I understand World Quest Group Finder was spamming the servers with its various features and that did indeed cause problems for some players, seeing how it is widely used and probably more taxing than Rarity. The auto-refreshing checkbox was nice, but it's probably not a huge loss to remove it.

There's an issue apparent in the newest alpha release, which is caused by the packager; handle-unlocalized doesn't default to "ignore" even though the documentation says it should, according to this post. That's why people are reporting Lua errors on Curse already.

(Good point, indeed.)

Rollback Post to Revision RollBack
AllaraStarmist
Curse Premium
- Location: San Francisco
- Join Date: 2/18/2005
- Posts: 364
- Member Details
#1359 AllaraStarmist

View User Profile

Send Message

Posted May 31, 2017
In reply to Cakechart:

To clarify: I didn't expect Rarity's use of Group Finder to cause server issues. In fact I tried to architect it to be minimally intrusive. But having those functions unblocked was bound to cause problems with server performance once someone got around to really going nuts with them (as happened with WQGF).

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

Project ID

30801
Created

Aug 5, 2011
Last Released File

Feb 6, 2025
Total Downloads

17,572,256
License

GNU General Public License ver...

RDW Owner
AllaraStarmist Author
Ananhaid Translator
bjfr123 Translator
freimensch Translator
gershuun Contributor
ImNotACatTrustMe Translator
mantis3d Translator
Urtgard Contributor
Zakhai Translator

WowAce

Rarity

Addons

Rarity

Table of Contents

Looking for Rarity Item Packs? Click here.

Main features

Other features

Slash Commands

Comments & bug reports

Help translate Rarity

Frequently Asked Questions

Comments

About This Project

Categories

Members

Recent Files

WoW Retail

WoW Cataclysm Classic