This is an element for the unitframe framework oUF.
It does nothing by itself and requires layout support to do its magic.
I decided to rename the addon to oUF_Dispellable due to a spelling mistake, which means layout authors will have to adopt the proper spelling from version 2.0.0 onward. Sorry guys and gals :(
oUF_Dispellable provides functionality to highlight debuffs dispellable by the player. It can display either a texture colored by the debuff type, or an icon representing the found dispellable debuff, or both.
It enables and disables itself automatically based on whether the player can dispel or not and keeps an always updated list of the dispel spells available to the player. It also keeps track of self-dispels like Grimoire: Imp and Cleansed by Flame to highlight only the player frame when only those are known.
How to use (for layout authors)
The element is fully documented and follows the current oUF guidelines for documentation. Please take a look at the code for details and examples. You could also consult the wiki.
How to install
If you are a layout author, here are some options how to distribute oUF_Dispellable with your layout:
unzip the whole embedded package into your layout's folder and load
oUF_Dispellable.luafrom your .toc file in that order.
While this is the simplest option, you will have to keep your copy updated manually.
- if you are using git for source control management, you could use gitmodules to pull oUF_Dispellable and its dependencies.
- you could use some automated packaging for distribution like Curse's .pkgmeta or packager. Once set up, this is the best solution.
Please consider making oUFDispellable optional for your users. The easiest way is to distribute it with your layout as a separate addon and use something like
if not IsAddOnLoaded('oUF_Dispellable') then return end before calling its functionality. Users can then opt-out of using it by just uninstalling it without having to edit your code. This way they can also update oUFDispellable themselves, without you having to release a new version of your layout just to pick some minor changes.
If you are a layout user and oUF_Dispellable didn't come together with your layout despite the layout supporting it, just install it as a normal addon.
If you have any problems using oUF_Dispellable, please open an issue at Github. Remember to first search if there is an open/closed issue concerning your problem.
Please read the included LICENSE.