Skip to content

sgade/MountsRarity

Repository files navigation

🐴 MountsRarity

GitHub Release CurseForge Game Versions CurseForge Downloads

A World of Warcraft addon library that provides rarity data for mounts among the playerbase.

🎯 For players

Download this library addon to provide the most current database. Your addons that use this library will pick it up automatically.

Internally, only the newest version of this library will be loaded and used for all addons.

Addons using this library

🧑‍💻 For addon developers

This library can be included with the deployment of your addon. I recommend you regularly update the version that you ship with your addon as the data is updated multiple times per week.

Players can opt into installing this addon separately to have a more recent version available as well. Interally, only the most recent version will be loaded, regardless of where it is provided from.

Mount rarities are floating point values between 0 (no player has it) and 100 (every player has it).

Loading the library

To load the library, or access an already initialized instance of it, load it as a LibStub library.

local MountsRarity = LibStub("MountsRarity-2.0")

Get rarity by mount id

To get the rarity value of a mount, call GetRarityById(mountID).

local mountId = 6
local rarity = MountsRarity:GetRarityByID(mountId)

Get all rarity data

To get the entire dataset, organized by mount id and its rarity, call GetData().

local data = MountsRarity:GetData()

📊 Data source

The data source for the rarity data is Data for Azeroth.

Each day, there is a check for new data that publishes a new version with updated rarity values. This happens effectively twice a week.

⚙️ Issues

If you find any issues with this project, feel free to raise them here.

About

World of Warcraft addon that provides rarity data of mounts among the playerbase

Topics

Resources

License

Stars

Watchers

Forks

Contributors