From d63b1ed00ece42392ac74085686406740809e635 Mon Sep 17 00:00:00 2001 From: Andrew Mordecai Date: Wed, 13 Jul 2016 16:51:40 -0700 Subject: [PATCH] Add README file --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..07962b8 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +oUF Stardust +============ + +oUF Stardust is a layout for Haste's oUF unit frame framework. The look is +mainly inspired by oUF Qulight, and some code is borrowed from oUF Phanx. + +- **Supported units:** player, pet, target, targettarget, focus, focustarget +- **Standard features:** health, power, combo points, threat glow, all the usual + status icons +- **Secondary resources:** demonic fury, soul shards, druid mana, holy power, + runes, shadow orbs, totems (including ghouls and mushrooms) +- **Supported plugins:** oUF MovableFrames, oUF Smooth (install them separately) + +Some configuration is available by editing the `config.lua` file. If WoW is +open, you'll need to `/reload` the UI after saving your changes. + + +Unfinished / Missing Features +----------------------------- + +oUF Stardust is a work in progress, and isn't yet ready to be used on its own. +Many features aren't finished yet, or haven't been tested much (or at all). + +**Unfinished**, but will be added sooner or later, in roughly this order: + +- burning embers +- casting bars +- selected auras (boss debuffs, dispellable debuffs, important class auras) +- party and partypet frames +- boss and bosstarget frames +- heal/absorb predictions +- alternate power bars (I've not yet decided where to put them) +- eclipse bar +- stagger bar (maybe) +- in-game menus for changing the fonts and bar texture + +**Missing**, and likely won't be added at all: + +- arena or raid units (I don't need them myself) +- portraits (I don't like them) +- in-game menus for anything else (I don't feel like writing it) + + +Contributing +------------ + +If you've discovered a bug in oUF Stardust, the preferred way to let me know +about it is by opening an issue ticket on the [GitLab project page][1]. You +can also log into GitLab using your Google, Twitter, or GitHub account. + + [1]: https://gitlab.com/armordecai/ouf-stardust/issues + + +Legal +----- + +oUF Stardust is published under the zlib/libpng license. See the included +LICENSE.txt file for more details. + -- 1.7.9.5