Welcome to the Rarity Docs
Rarity is a collectibles and statistics tracking addon for World of Warcraft. You can download it here.
More Information#
We've created some resources that should make it easier to use the addon and work with its code or database.
For Players#
To help you achieve common tasks while using the addon, we've created a user manual:
- If you need to track items that aren't supported out of the box, you'll want to add Custom Items
- To see what statistics Rarity gathered while you were playing, simply inspect the History for any given item
- You can import Item Packs to benefit from exports that others have already created and add them as custom items
- Or you could create one yourself and share it with your fellow players so that they can import it
- In the unfortunate event that you're encountering an issue, we hope that this Troubleshooting Guide will help
For Developers#
We also provide technical documentation on various aspects of the codebase:
- Interested in contributing or making changes, but not sure where to start? This way, please!
- For an overview of the item database layout, check out the Database Schema
- If you want to work with the localization system, please read this: Localization Guide
- To look up what functionality is available in code, head to the API Reference
- In order to learn about testing and documentation, visit our QA Hub
Questions and Answers#
There are some questions we keep getting over and over again, so we wrote down the answer here.
Known Issues#
Due to the nature of addons having to rely on Blizzard's World of Warcraft API and various other technical limitations, some long-standing issues exist that we can't currently resolve. A list of them can be found here.
Changelogs#
If you're curious as to how the addon has evolved, feel free to browse the many changelogs we've made available.
How to Report Problems#
It's a sad reality that no software works flawlessly; sooner or later you'll probably encounter a glitch in the matrix. Luckily, there are many ways for you to contact the development team and (hopefully) get it fixed.
Join the Community#
You can participate in the development process or follow along on any of these public platforms:
- All development takes place in our public GitHub repository
- For questions, news, and discussions, hop into our Discord server
- We also monitor comments and issues on CurseForge and WowAce
- Rarity is translated into many languages using the WowAce Localization System
Support the Project#
The addon is and always will be free, but you can still help to make it better:
- Perform ingame testing (extremely important, and often difficult for developers to do on their own!)
- Improve the documentation by helping with writing, translating, or simply by giving feedback
- Participate in discussions and answer questions on Discord to help other community members out
- Create, update, review or confirm GitHub Issues when you have some information that could be of use
- Contribute code or database updates directly, by creating Pull Requests on GitHub (here's how)
- Donations via PayPal or Patreon are another way of showing your support (but please read this first)