What is mUF?
mUF is planned to be a set of very (very very) customizable unitframes.
Every part of a unitframe (e.g. name, healthbar, auras) is represented as a "module". You can create a set of modules called "template" and assign this template to one or more unitframes, wich will then share the same design.
Both modules and unitframes are created in a plugin-system, wich I plan to make as easy to use as possible and I promise to document it thouroughly, to allow other developers to write their own plugins.
Why did you do it?
I am a long time user of Pitbull, but I get annoyed from time to time because of minor details. There is no way to change the background color on individual frames, and you cannot make your own DoTs bigger than others and more...
I've found it hard to modify and expand Pitbull, due to a lack of documentation.
So it's: Do it yourself =)
How to use it?
I do not recommend to use mUF as you primary uniframe addon yet. It is still not very stable and its seriously lacking features. But if your are interested, give it a try and have a look at this Getting started guide.
How to develop additional modules?
Don't do it yet. There is no documentation yet and the underlying structure is still likely to change.
If you want to get a feel of how it will be done, look at some of the easier modules, like mUF_Module_DogTag or mUF_Module_HealthBar.
What help did I have?
My thanks go to the Ace3 Team, to ckknight for his dogtag libraries and to Burlox, OrionShock, and jerry for their help in the forums. =)
Please leave bug reports or feature requests here.
But check first, if its already on my ToDo list.
Comments are very welcome!
------------------------------------------------------------------------
r24 | vaeyl | 2009-01-13 14:51:42 +0000 (Tue, 13 Jan 2009) | 1 line
Changed paths:
A /tags/v0.1preview1 (from /trunk:23)
Tagging as v0.1preview1
------------------------------------------------------------------------
r23 | vaeyl | 2009-01-13 14:49:54 +0000 (Tue, 13 Jan 2009) | 1 line
Changed paths:
M /trunk/Core.lua
M /trunk/Options.lua
fixed frame settings
------------------------------------------------------------------------
r22 | vaeyl | 2009-01-13 08:05:18 +0000 (Tue, 13 Jan 2009) | 3 lines
Changed paths:
M /trunk/Core.lua
M /trunk/Libs/mUF_Module/mUF_Module.lua
M /trunk/Libs/mUF_UnitType/mUF_UnitType.lua
M /trunk/Modules/mUF_Module_Background/mUF_Module_Background.lua
M /trunk/Modules/mUF_Module_HealthBar/mUF_Module_HealthBar.lua
M /trunk/Options.lua
M /trunk/Other/mUF_TemplateEditor/mUF_TemplateEditor.lua
more bugfixing
added option to change a frame's template
preparing rc1
------------------------------------------------------------------------
r21 | vaeyl | 2009-01-12 14:54:27 +0000 (Mon, 12 Jan 2009) | 2 lines
Changed paths:
M /trunk/Core.lua
M /trunk/Libs/mUF_Module/mUF_Module.lua
M /trunk/Modules/mUF_Module_Background/mUF_Module_Background.lua
M /trunk/Options.lua
M /trunk/Other/mUF_TemplateEditor/mUF_TemplateEditor.lua
M /trunk/UnitTypes/mUF_UnitType_Standard/mUF_UnitType_Standard.lua
bugfixing galore.
Still more bugs in there, though.
------------------------------------------------------------------------
r20 | vaeyl | 2009-01-12 08:35:58 +0000 (Mon, 12 Jan 2009) | 4 lines
Changed paths:
M /trunk/.pkgmeta
M /trunk/Core.lua
M /trunk/Libs/mUF_Module/mUF_Module.lua
M /trunk/Libs/mUF_UnitType/mUF_UnitType.lua
M /trunk/Modules/mUF_Module_Background/mUF_Module_Background.lua
M /trunk/Modules/mUF_Module_DogTag/mUF_Module_DogTag.lua
M /trunk/Modules/mUF_Module_PowerBar/mUF_Module_PowerBar.lua
M /trunk/Options.lua
M /trunk/Other/mUF_TemplateEditor/mUF_TemplateEditor.lua
M /trunk/UnitTypes/mUF_UnitType_Standard/mUF_UnitType_Standard.lua
M /trunk/embeds.xml
added 0.1 sec timer to powerbar
more bugfixing
template editor still does not work
options still do not work.
------------------------------------------------------------------------
r19 | vaeyl | 2009-01-10 13:58:56 +0000 (Sat, 10 Jan 2009) | 1 line
Changed paths:
M /trunk/Core.lua
M /trunk/Libs/mUF_Module/mUF_Module.lua
M /trunk/Libs/mUF_UnitType/mUF_UnitType.lua
M /trunk/Modules/mUF_Module_Background/mUF_Module_Background.lua
M /trunk/Modules/mUF_Module_DogTag/mUF_Module_DogTag.lua
M /trunk/Modules/mUF_Module_HealthBar/mUF_Module_HealthBar.lua
M /trunk/Modules/mUF_Module_PowerBar/mUF_Module_PowerBar.lua
bugfixing
------------------------------------------------------------------------
r18 | vaeyl | 2009-01-10 09:05:09 +0000 (Sat, 10 Jan 2009) | 1 line
Changed paths:
M /trunk/Modules/mUF_Module_Background/mUF_Module_Background.lua
M /trunk/Other/mUF_TemplateEditor/mUF_TemplateEditor.lua
M /trunk/UnitTypes/mUF_UnitType_Standard/mUF_UnitType_Standard.lua
more rollbacks
------------------------------------------------------------------------
r17 | vaeyl | 2009-01-10 08:43:09 +0000 (Sat, 10 Jan 2009) | 1 line
Changed paths:
M /trunk/Libs/mUF_Module/mUF_Module.lua
M /trunk/Libs/mUF_UnitType/mUF_UnitType.lua
M /trunk/Modules/mUF_Module_DogTag/mUF_Module_DogTag.lua
M /trunk/Modules/mUF_Module_HealthBar/mUF_Module_HealthBar.lua
M /trunk/Modules/mUF_Module_PowerBar/mUF_Module_PowerBar.lua
rollback to r15
------------------------------------------------------------------------
r16 | vaeyl | 2009-01-09 19:49:57 +0000 (Fri, 09 Jan 2009) | 1 line
Changed paths:
M /trunk/Libs/mUF_Module/mUF_Module.lua
M /trunk/Libs/mUF_UnitType/mUF_UnitType.lua
M /trunk/Modules/mUF_Module_Background/mUF_Module_Background.lua
M /trunk/Modules/mUF_Module_DogTag/mUF_Module_DogTag.lua
M /trunk/Modules/mUF_Module_HealthBar/mUF_Module_HealthBar.lua
M /trunk/Other/mUF_TemplateEditor/mUF_TemplateEditor.lua
M /trunk/UnitTypes/mUF_UnitType_Standard/mUF_UnitType_Standard.lua
bugfixing
------------------------------------------------------------------------
r15 | vaeyl | 2009-01-09 12:16:51 +0000 (Fri, 09 Jan 2009) | 2 lines
Changed paths:
M /trunk/Libs/mUF_Module/mUF_Module.lua
M /trunk/Libs/mUF_UnitType/mUF_UnitType.lua
M /trunk/Modules/mUF_Module_DogTag/mUF_Module_DogTag.lua
M /trunk/Modules/mUF_Module_HealthBar/mUF_Module_HealthBar.lua
M /trunk/Modules/mUF_Module_PowerBar/mUF_Module_PowerBar.lua
bugfixing
still trouble with securing the frames
------------------------------------------------------------------------
r14 | vaeyl | 2009-01-09 10:21:21 +0000 (Fri, 09 Jan 2009) | 1 line
Changed paths:
M /trunk/Core.lua
M /trunk/Libs/mUF_Module/mUF_Module.lua
M /trunk/Libs/mUF_UnitType/mUF_UnitType.lua
M /trunk/Modules/mUF_Module_Background/mUF_Module_Background.lua
M /trunk/Modules/mUF_Module_HealthBar/mUF_Module_HealthBar.lua
M /trunk/Modules/mUF_Module_PowerBar/mUF_Module_PowerBar.lua
M /trunk/Other/mUF_TemplateEditor/mUF_TemplateEditor.lua
M /trunk/UnitTypes/mUF_UnitType_Standard/mUF_UnitType_Standard.lua
more modifications for restructuring
------------------------------------------------------------------------
r13 | vaeyl | 2009-01-08 15:35:48 +0000 (Thu, 08 Jan 2009) | 2 lines
Changed paths:
M /trunk/Core.lua
M /trunk/Libs/mUF_Module/mUF_Module.lua
M /trunk/Modules/mUF_Module_DogTag/mUF_Module_DogTag.lua
I am beginning to restructure this addon.
WARNING: This and the following version will NOT work. At all!
------------------------------------------------------------------------
r12 | vaeyl | 2009-01-08 08:06:15 +0000 (Thu, 08 Jan 2009) | 1 line
Changed paths:
M /trunk/.pkgmeta
M /trunk/mUF.toc
changed addon structure
------------------------------------------------------------------------
r11 | vaeyl | 2008-12-16 11:59:25 +0000 (Tue, 16 Dec 2008) | 2 lines
Changed paths:
M /trunk/Core.lua
M /trunk/Libs/mUF_Module/mUF_Module.lua
M /trunk/Libs/mUF_UnitType/mUF_UnitType.lua
A /trunk/Modules/mUF_Module_PowerBar
A /trunk/Modules/mUF_Module_PowerBar/mUF_Module_PowerBar.lua
A /trunk/Modules/mUF_Module_PowerBar/mUF_Module_PowerBar.toc
M /trunk/Options.lua
M /trunk/UnitTypes/mUF_UnitType_Standard/mUF_UnitType_Standard.lua
added powerbar
fixed event handling
------------------------------------------------------------------------
r10 | vaeyl | 2008-12-14 09:58:49 +0000 (Sun, 14 Dec 2008) | 4 lines
Changed paths:
M /trunk/Libs/mUF_UnitType/mUF_UnitType.lua
M /trunk/Modules/mUF_Module_Background/mUF_Module_Background.lua
M /trunk/Modules/mUF_Module_DogTag/mUF_Module_DogTag.lua
M /trunk/Modules/mUF_Module_HealthBar/mUF_Module_HealthBar.lua
M /trunk/Other/mUF_TemplateEditor/mUF_TemplateEditor.lua
fixed templat-editor background
fixed some background bugs
added support for anchoring to non TOPLEFT anchors
added support for DogTag justification
------------------------------------------------------------------------
r9 | vaeyl | 2008-12-12 07:41:24 +0000 (Fri, 12 Dec 2008) | 4 lines
Changed paths:
M /trunk/Libs/mUF_Module/mUF_Module.lua
M /trunk/Libs/mUF_UnitType/mUF_UnitType.lua
M /trunk/Modules/mUF_Module_Background/mUF_Module_Background.lua
M /trunk/Other/mUF_TemplateEditor/mUF_TemplateEditor.lua
M /trunk/UnitTypes/mUF_UnitType_Standard/mUF_UnitType_Standard.lua
added support for future use of anchors other than TOPLEFT
fixed DestroyFrame for backgrounds
added InsertSubframe, GetSubframes to UnitType
added default colors to background
------------------------------------------------------------------------
r8 | vaeyl | 2008-12-11 14:59:21 +0000 (Thu, 11 Dec 2008) | 3 lines
Changed paths:
M /trunk/.pkgmeta
M /trunk/Core.lua
A /trunk/Modules/mUF_Module_Background
A /trunk/Modules/mUF_Module_Background/mUF_Module_Background.lua
A /trunk/Modules/mUF_Module_Background/mUF_Module_Background.toc
M /trunk/Modules/mUF_Module_DogTag/mUF_Module_DogTag.lua
M /trunk/Other/mUF_TemplateEditor/mUF_TemplateEditor.lua
addded background module
new module/unittype function :DestroyFrame
fixed dogtags to support IsMouseOver
------------------------------------------------------------------------
r7 | vaeyl | 2008-12-10 20:44:34 +0000 (Wed, 10 Dec 2008) | 2 lines
Changed paths:
M /trunk/Modules/mUF_Module_DogTag/mUF_Module_DogTag.lua
M /trunk/Modules/mUF_Module_HealthBar/mUF_Module_HealthBar.lua
polished Module_DogTag
reverted HealthBar to a simpler form for now.
------------------------------------------------------------------------
r6 | vaeyl | 2008-12-10 16:57:09 +0000 (Wed, 10 Dec 2008) | 1 line
Changed paths:
M /trunk/Modules/mUF_Module_HealthBar/mUF_Module_HealthBar.lua
M /trunk/mUF.toc
healthbar is still broken, but much advanced =)
------------------------------------------------------------------------
r5 | vaeyl | 2008-12-10 09:50:13 +0000 (Wed, 10 Dec 2008) | 2 lines
Changed paths:
M /trunk/Modules/mUF_Module_DogTag/mUF_Module_DogTag.toc
M /trunk/Modules/mUF_Module_HealthBar/mUF_Module_HealthBar.toc
M /trunk/Other/mUF_TemplateEditor/mUF_TemplateEditor.toc
M /trunk/UnitTypes/mUF_UnitType_Standard/mUF_UnitType_Standard.toc
M /trunk/mUF.toc
untested: allowing for disembedded libs
------------------------------------------------------------------------
r4 | vaeyl | 2008-12-09 16:44:08 +0000 (Tue, 09 Dec 2008) | 1 line
Changed paths:
M /trunk/Options.lua
fixed error on deleting the current layout
------------------------------------------------------------------------
r3 | vaeyl | 2008-12-09 13:34:51 +0000 (Tue, 09 Dec 2008) | 1 line
Changed paths:
M /trunk/.pkgmeta
trying to fix DogTag-Libraries
------------------------------------------------------------------------
r2 | vaeyl | 2008-12-09 13:29:25 +0000 (Tue, 09 Dec 2008) | 1 line
Changed paths:
A /trunk/.pkgmeta
A /trunk/Core.lua
A /trunk/Libs
A /trunk/Libs/mUF_Module
A /trunk/Libs/mUF_Module/mUF_Module.lua
A /trunk/Libs/mUF_UnitType
A /trunk/Libs/mUF_UnitType/mUF_UnitType.lua
A /trunk/Locale-deDE.lua
A /trunk/Locale-enUS.lua
A /trunk/Modules
A /trunk/Modules/mUF_Module_DogTag
A /trunk/Modules/mUF_Module_DogTag/embeds.xml
A /trunk/Modules/mUF_Module_DogTag/mUF_Module_DogTag.lua
A /trunk/Modules/mUF_Module_DogTag/mUF_Module_DogTag.toc
A /trunk/Modules/mUF_Module_HealthBar
A /trunk/Modules/mUF_Module_HealthBar/mUF_Module_HealthBar.lua
A /trunk/Modules/mUF_Module_HealthBar/mUF_Module_HealthBar.toc
A /trunk/Options.lua
A /trunk/Other
A /trunk/Other/mUF_TemplateEditor
A /trunk/Other/mUF_TemplateEditor/Locale-enUS.lua
A /trunk/Other/mUF_TemplateEditor/mUF_TemplateEditor.lua
A /trunk/Other/mUF_TemplateEditor/mUF_TemplateEditor.toc
A /trunk/UnitTypes
A /trunk/UnitTypes/mUF_UnitType_Standard
A /trunk/UnitTypes/mUF_UnitType_Standard/mUF_UnitType_Standard.lua
A /trunk/UnitTypes/mUF_UnitType_Standard/mUF_UnitType_Standard.toc
A /trunk/embeds.xml
A /trunk/mUF.toc
initial commit
------------------------------------------------------------------------
r1 | root | 2008-12-09 09:45:44 +0000 (Tue, 09 Dec 2008) | 1 line
Changed paths:
A /branches
A /tags
A /trunk
"muf/mainline: Initial Import"
------------------------------------------------------------------------
Installation Guide
- Exit "World of Warcraft" completely
- Download the mod you want to install
- Make a folder on your desktop called "My Mods"
- Save the .zip/.rar files to this folder.
- If, when you try to download the file, it automatically "opens" it... you need to RIGHT click on the link and "save as..." or "Save Target As".
- Extract the file - commonly known as 'unzipping'
Do this ONE FILE AT A TIME!
- Windows
- Windows XP has a built in ZIP extractor. Double click on the file to open it, inside should be the file or folders needed. Copy these outside to the "My Mods" folder.
- WinRAR: Right click the file, select "Extract Here"
- WinZip: You MUST make sure the option to "Use Folder Names" is CHECKED or it will just extract the files and not make the proper folders how the Authors designed
- Mac Users
- StuffitExpander: Double click the archive to extract it to a folder in the current directory.
- Verify your WoW Installation Path
That is where you are running WoW from and THAT is where you need to install your mods.
- Move to the Addon folder
- Open your World of Warcraft folder. (default is C:\Program Files\World of Warcraft\)
- Go into the "Interface" folder.
- Go into the "AddOns" folder.
- In a new window, open the "My Mods" folder.
- The "My Mods" folder should have the "Addonname" folder in it.
- Move the "Addonname" folder into the "AddOns" folder
- Start World of Warcraft
- Make sure AddOns are installed
- Log in
- At the Character Select screen, look in lower left corner for the "addons" button.
- If button is there: make sure all the mods you installed are listed and make sure "load out of date addons" is checked.
- If the button is NOT there: means you did not install the addons properly. Look at the above screenshots. Try repeating the steps or getting someone who knows more about computers than you do to help.
Translations
When you download a mod, please be sure that the mod is compatible with your translation of wow. Some mods only work on the US versions, while some only work on some of the various European versions. These variations are called "Localizations".
TOC Numbers (Out of Date Mods)
When Blizzard patches WoW, they change the Interface number. This means that all mods will be "out of date" unless or until the author releases a new version for that interface. Some people go into the .toc files and update the numbers themselves, but this is STRONGLY advised against as it will cause problems locating possible incompatibilities addons. When you log into WoW after a patch, you DO NOT have to delete your interface directory. All you have to do is simply tell WoW to ignore the interface numbers and load all the mods anyway. All you have to do is, while at the "character select" screen, look in the lower left corner and click on the "addons" button. A window will pop up listing all your installed mods.
If you look in the upper left corner of that window there should be a box that says "Load Out of Date AddOns". You want to CHECK this box. Now simply go into WoW normally and all your mods should load. As of the 1.9 patch, you will have to do this after EVERY patch/update that Blizzard posts! If you encounter any problems with a mod after a patch, please be sure to let the author of the mod know so they can fix it.
See also: About "Out Of Date AddOns"
Mac Support
WoW addons are not platformed based. As such, they can be used on either Mac or PC. You can extract both .zip and .rar files on a Mac using StuffitExpander.
Directory Structure
World of Warcraft
|_ Interface
|_AddOns
|_*AddonName*
|_ *AddonName*.toc
|_ *AddonName*.xml
|_ *AddonName*.lua
|_ (possibly others as well)...