Rarity
NEW:
- 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 & bug reports
Help translate Rarity
Click here to help translate Rarity into your language.
Frequently Asked Questions
Click here to read the Frequently Asked Questions. Please read this before requesting support.
The issue with using statistics is that Rarity simply adds the total number of kills to the "attempts" counter, even though only kills after the most recent patch had a chance to drop the pet. That's why I didn't try to use them in the first place, as it displays "36 attempts" instead of "1 attempt" for a boss I have killed before a pet was added to its loot. Additionally, the pet counter increasing when the boss is killed is technically inaccurate, as only the cache (object) will have a chance to contain it.
I'm also not sure if it would be able to display the item in the tooltip without the correct NPC ID, but that should be easy enough to test once I have this figured out. Adding that would be easy enough, however I feel that it defeats the purpose of using the addon to track the new RWL pets unless only valid attempts are tracked :(
Good point on the statistics. I have several tricks I can use when I add these directly to Rarity, but you don't have access to these. For example, I have an option per-item to tell Rarity to not update to the highest stat count, but I didn't expose that in the Options. I could do so easily, there just hasn't been a need.
Similarly with tooltips, I have an extra bit of code where I can manually throw tooltips onto those NPCs even when there is no NPC ID. This is, in fact, how most of the items in Rarity work. (Actually, I could easily expose this to Options as well.)
I know it's not technically an attempt until you loot the cache, but WoW does not provide an API to detect world object loots unless you know the localized string of the tooltip of the object. This is not a practical way to detect loots. If you killed the boss and did not loot the cache, you did it wrong. Rarity will only resort to world object tooltip scans when there is literally no other way to detect it, which is not the case here.
All of this to say, I will get to this eventually. I have many other projects and this is not a top priority. Sorry about that!
As an additional note: if you have an interest in adding these items to Rarity, which it seems you do, you could take a look at Options_Defaults.lua. Here you can see all the items and the code that makes them happen. I have other users who sometimes submit this type of Lua code directly to me when patches come out, but they are also busy right now. I would welcome your help! But I will get to it eventually.
doNotUpdateToHighestStat = true will make an item not update to the highest statistic count. (Semi-untested with the brand new cross-account statistic tracking—there may be a bug here.)
tooltipNpcs = { 95067 } is the bit on an item that puts the item onto an NPC's tooltip even if the NPC ID is not listed for the item.
Done! Tested and working, although it's possible I missed something.
Options_Defaults.lua 818: http://pastebin.com/HbQREnmZ
Locales.lua 1004: http://pastebin.com/zXRiq8rR
It's not actually localised, of course, I've only added the entries there to get it to work with the English client. Also, the drop rate is set to a flat 1 in 10, which may or may not be wrong.
Both of your caveats are correct. For localization, just put the enUS strings in Locales.lua, as you did. Then I upload those to WowAce.com, and other users do the localization.
As far as drop rates, I do the same thing. Just put in an educated guess, as you did, if there isn't enough data.
Sadly I'm still super super busy for the next few days, but I will get to this as soon as I can. Thanks so much!
Thank you Cakechart =)
I really hope you are going to implement the new raiding with leashes pets. All data (boss/location) is available on wowhead. Drop rates don't matter at this point
You can already add it manually, check out my post below (#1104) :)
I'm aware that data is available on Wowhead. As you'll notice, I mentioned I did not have time right now to gather it. Luckily, Cakechart did! Unfortunately, I still have to double check his data and add waypoint data since he did not add it. And I have not yet had the time.
Is there any point in having coordinates for those raid bosses? It doesn't appear TomTom would be useful for tracking RWL, there is an icon on the default map for each boss's position, and there also appear to have been some changes to disallow addons from obtaining position data in instanced content in 7.1, of which I am not sure how they affect this. I wasn't able to see any waypoints I set manually, but then it might be unrelated to this change.
The IDs themselves are taken directly from wowhead and should be correct, I've killed all the bosses while adding them to the files and saw no issues. Anything else that I missed?
Anyway, I added it, although I can't test it exactly and it seems entirely pointless:
http://pastebin.com/jthd99v8
Yes please!! Add [Raiding with Leashes IV: Wrath of the Lick King] so we can track it with rarity. Love this addon.
Please add for [Raiding with Leashes IV: Wrath of the Lick King]!!!!!!!
Just the zones. The coordinates are pointless. Rarity now requires zones for all items that exist in a zone.
Sorry I still haven't gotten to this! Been really crazy busy.
Oh and yeah since you've tested it, I don't think I need to double check it. I'll try to get this in within the next few days. Thanks again for working on this!
Is there a reason why when just show items on zone I am in is checked, sometimes it shows as if there was nothing in that zone?
Not all zones have items that Rarity tracks. Or maybe I misunderstand the question?
For the LFG auto-refresh checkbox: Please provide an option to change the timer (default: 5 seconds)?
5 seconds is too short to glance over all of the various Mythic+ groups forming during prime times, I managed to change the timer manually (Core.lua, line 640) but an official option including a slider or text box would be preferred.
I'll do that. Rarity isn't intended to help with your Mythic+ groups, but hey, might as well while it's there!
Is there a way you can add a feature for us to include all items we have already seen? Would be nice to go over the ones we have and how many attempts it took. Or does this exist and I'm just missing it?
Pop into the Options screen and click through the items to review the attempt counts. If you really want it back in your tooltip, turn Repeatable on.
Its probably not worth tracking the Fathom Dweller mount - its not a random drop from Kosumoth. It needs you to unlock world quests for Kosumoth by clicking on orbs spread all over the Broken Isles. Once you've done that every two weeks a world quest will spawn for you to kill it with the reward being either the mount or the pet.