diff --git a/README.md b/README.md index 35639688..300322a9 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ # pfUI -An educational project for World of Warcraft (1.12) mostly known as "Vanilla" -which aimes to be a full replacement for the original Wow interface in a single Addon. -The design is highly inspired by TukUI and ElvUI (which I never used) as well as several -other screenshots I found around the web during the last 10 years. -It is entirely written from scratch without any inclusion of 3rd party addons -or libraries. This is **not** an addon-pack like -[ShaguUI](http://shagu.org/shaguui/) which means that no +An Addon for World of Warcraft (1.12) mostly known as "Vanilla" which +aimes to be a full replacement for the original Wow interface in a single Addon. +The design is highly inspired by TukUI and ElvUI. It is entirely written from +scratch without any inclusion of 3rd party addons or libraries. + +This is **not** an addon-pack like [ShaguUI](http://shagu.org/shaguui/) which means that no external Addons will be included. There will be support for external addons like MobHealth3 and HealComm, but they will be never shipped within the package. -## Installation (Release) -1. Download **[Release](https://github.com/shagu/pfUI/releases/latest)** -2. Unpack the Zip -3. Copy "pfUI" to Wow-Directory\Interface\AddOns -4. Restart Wow +## Screenshots + + + + + ## Installation (Latest) 1. Download **[Latest](https://github.com/shagu/pfUI/archive/master.zip)** @@ -22,18 +22,19 @@ MobHealth3 and HealComm, but they will be never shipped within the package. 3. Copy "pfUI" to Wow-Directory\Interface\AddOns 4. Restart Wow -## Recommended Addons -* [DPSMate](https://github.com/Geigerkind/DPSMate) An advanced combat analyzation tool -* [HealComm](https://github.com/Aviana/HealComm/releases) Visual representation of incoming heals -* [WIM](http://addons.us.to/addon/wim), [WIM (continued)](https://github.com/shirsig/WIM) Give whispers an instant messenger feel -* [MobHealth3](http://addons.us.to/addon/mobhealth) Estimates a mob's health -* [Clean_Up](https://github.com/shirsig/Clean_Up) Automatically stacks and sorts your items. +## Installation (Release) +1. Download **[Release](https://github.com/shagu/pfUI/releases/latest)** +2. Unpack the Zip +3. Copy "pfUI" to Wow-Directory\Interface\AddOns +4. Restart Wow ## Commands - /pfui Open the configuration GUI - /gm Open the ticket Dialog - /rl Reload the whole UI + /pfui Open the configuration GUI + /gm Open the ticket Dialog + /rl Reload the whole UI + /focus Creates a Focus-Frame for the current target + /clearfocus Clears the Focus-Frame ## Languages pfUI supports and contains language specific code for the following languages. @@ -44,10 +45,16 @@ pfUI supports and contains language specific code for the following languages. * Russian (ruRU) * Korean (koKR) -## Screenshots -![Screenshot](http://mephis.he-hosting.de/shaguaddons/pfUI/mmobase/screen.jpg) +## Recommended Addons +* [HealComm](https://github.com/Aviana/HealComm/releases) Visual representation of incoming heals +* [WIM](http://addons.us.to/addon/wim), [WIM (continued)](https://github.com/shirsig/WIM) Give whispers an instant messenger feel +* [MobHealth3](http://addons.us.to/addon/mobhealth) Estimates a mob's health -![Moving Frames](http://mephis.he-hosting.de/shaguaddons/pfUI/mmobase/moveit.jpg) +## Other Addons +* [DPSMate](https://github.com/Geigerkind/DPSMate) An advanced combat analyzation tool +* [DebuffTimers](https://github.com/shagu/DebuffTimers) Timer Overlays for enemy debuffs +* [Clique](https://github.com/shagu/Clique) Simply powerful click-casting interface +* [Clean_Up](https://github.com/shirsig/Clean_Up) Automatically stacks and sorts your items. ## FAQ **What does "pfUI" stand for?** @@ -58,6 +65,13 @@ big fan of creating configuration UI's especially not via the Wow-API **How can I donate?** You can't. I'm doing that for fun. Enjoy! +**How do I report a Bug?** +Please provide as much information as possible in the [Bugtracker](https://github.com/shagu/pfUI/issues). +If there is an error message, provide the full content of it. Just telling that "there is an error" won't help any of us. +Please consider adding additional information such as: since when did you got the error, +does it still happen using a clean configuration, what other addons are loaded and which version you're running. +When playing with a non-english client, the language might be relevant too. If possible, explain how people can reproduce the issue. + **How can I contribute?** Report Errors, Issues and Feature Requests in the [Bugtracker](https://github.com/shagu/pfUI/issues). Please make sure to have the latest version installed and check for conflicting addons beforehand. @@ -65,6 +79,9 @@ Please make sure to have the latest version installed and check for conflicting **Can I use Clique with pfUI?** A pfUI compatible version of Clique can be found [Here](https://github.com/shagu/Clique/releases). If you want to keep your current version of Clique, you'll have to apply this [Patch](https://github.com/shagu/Clique/commit/a5ee56c3f803afbdda07bae9cd330e0d4a75d75a). +**How do I show the Damage- and Threatmeter Dock?** +If you enabled the "dock"-feature for your external (thirdparty) meters such as DPSMate or KTM, then you'll be able to toggle between them and the Right Chat by clicking on the ">" symbol on the bottom-right panel. + **How can I enable mouseover cast?** Create a macro with "/pfcast SPELLNAME". If you also want to see the cooldown, You might want to add "/run if nil then CastSpellByName("SPELLNAME") end" on top of the macro.