diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff74258 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# KlazUnitFrames + +A World of Warcraft add-on that styles default unit frames. + +There are no in-game options. All settings are hard-coded. + +## Features + +- Style default unit frames + - Player frame + - Target frame + - Focus frame +- Remove various indicators (e.g. income healing and damage text) +- Darken various textures (e.g. holy power background texture) +- Class colour health status bars +- ~~Class icon portraits~~ Removed. This feature has been implemented by Blizzard. +- Add timers to player and target cast bars + +## Screenshots + +Example of timer on player cast bar: + +![](https://forge.haothitran.com/KlazHTT/KlazUnitFrames/raw/branch/main/Media/Screemshot_CastBar.jpg) + +## Installation + +1. Backup `World of Warcraft\_retail_\Interface` and `World of Warcraft\_retail_\WTF` folders. Just in case. +2. Download and extract folder. +3. Place extracted folder in `World of Warcraft\_retail_\Interface\AddOns\` directory. +4. Restart World of Warcraft client.