About Grid
Grid is a party/raid unit frame addon. The compact grid of units lets you select a group member quickly, while retaining a good overview of the whole group. It displays as much information as possible without overloading the user. It allows you to customize what information you see, and how that information is displayed. It is also modular, making it easy to add new features.
Grid includes status modules for health, mana, incoming heals, aggro/threat, buffs and debuffs, and range. It supports pets and vehicles. Each unit's frame is a health bar, with additional statuses overlaid on top. Information can be displayed using the center text, the center icon, the frame border, the frame opacity, or the colored square in each of the four corners.
Due to its flexible design, Grid has a fairly daunting configuration menu. We recommend taking a few minutes to look through the configuration and familiarize yourself with the options available to you.
There is also a small User's Guide which you may find helpful.
How to report a bug in Grid
Before reporting a bug, check the bug tracker to see if someone else has already reported it.
Once you've verified that the bug hasn't been reported yet, submit a new ticket.
Be sure to include the following information in your ticket:
- Grid version (ex: 1.30200.2009120101 from curse.com)
- WoW version (ex: 3.2.2 enUS)
- What you were doing when the bug occured
- What happened (ie. what the bug is)
- Any error messages (enable Lua error display, or install BugSack)
- A screenshot if it is a graphical bug
Please check on your ticket daily. If a ticket is waiting on a response from you for more than 7 days, I will assume that you have fixed the problem yourself and have abandoned the ticket.
Design overview
Grid is based on the concept of statuses and indicators. A status is a piece of information, such as a unit's health or aggro status. An indicator is a part of the unit frame that can display information, such as the health bar or a corner square.
More than one status can be assigned to one indicator, and one status can be assigned to more than one indicator. This is where the priority system comes into play. Each status is assigned a priority level. Each indicator will show the highest-priority status active at any given time.
For example: The Power Word: Shield and Weakened Soul statuses show you when those auras (buffs or debuffs) are active on a particular unit. If you assign both statuses to the Bottom Left Corner indicator, and give them priority levels of 90 and 80, respectively, then when you cast Power Word: Shield on a unit, you will only see the Power Word: Shield status, until the shield is absorbed or expires, at which time you will then see the Weakened Soul status until it ends.
Each status consists of the following:
- name
- The internal name used by Grid to identify the status.
- description
- The name displayed in Grid's menus.
- priority
- A number from 0 (lowest) to 99 (highest).
- range (optional)
- If specified, the status will only be shown if the unit is within range yards of the player.
- color
- A color (including alpha) to be used when the status is displayed.
- text
- A short message to be used when the status is displayed.
- value (optional)
- If specified, value will be used to set the current value of a statusbar indicator.
- maxValue (optional)
- If specified, maxValue will be used to set the maximum value of a statusbar indicator.
- texture (optional)
- If specified, texture will be used to display an image.
The GridFrame module implements several indicators:
- Center Text
- Displays the text of the status using the color.
- Border
- Displays the color of the status as a 2px border around the unit frame.
- Health Bar
- Sets the value of the health bar based on value and maxValue. Sets the color based on the color.
- Healing Bar
- Sets the value of the healing bar based on value and maxValue.
- Four Corners (top left, top right, bottom left, bottom right)
- Displays the color of the status as a small box in the corner of the unit frame.
- Center Icon
- Displays the texture of the status as an icon in the center of the unit frame.
- Frame Alpha
- Sets the alpha (fade) of the frame based on the alpha of the color.
Credits
- Pastamancer: core, complete conversion to OO, modules
- Maia: initial concept, UI design, status modules
- Phanx: all around awesome
- Mikk: icon
- kaybe: german localization
- JoshBorke: API documentation
- Jerry: Pet support
- Julith: HealComm usage
------------------------------------------------------------------------
r1265 | phanx | 2009-12-27 03:32:38 +0000 (Sun, 27 Dec 2009) | 1 line
Changed paths:
A /tags/1.30300.1265 (from /trunk:1264)
Tagging as 1.30300.1265
------------------------------------------------------------------------
r1264 | Phanx | 2009-12-27 03:32:02 +0000 (Sun, 27 Dec 2009) | 1 line
Changed paths:
M /trunk/Grid.toc
- Update TOC for release
------------------------------------------------------------------------
r1263 | Phanx | 2009-12-21 08:29:16 +0000 (Mon, 21 Dec 2009) | 1 line
Changed paths:
M /trunk/GridStatusHeals.lua
- Fix: GridStatusHeals now correctly reassigns its db upvalue when the module is reset
------------------------------------------------------------------------
r1262 | Phanx | 2009-12-21 03:19:57 +0000 (Mon, 21 Dec 2009) | 1 line
Changed paths:
M /trunk/Locales/GridLocale-esES.lua
M /trunk/Locales/GridLocale-esMX.lua
- Correct capitalization error
------------------------------------------------------------------------
r1261 | Phanx | 2009-12-20 04:55:26 +0000 (Sun, 20 Dec 2009) | 1 line
Changed paths:
M /trunk/Locales/GridLocale-esES.lua
M /trunk/Locales/GridLocale-esMX.lua
- Reverted Guiaswow's changes to range check pattern
------------------------------------------------------------------------
r1259 | Phanx | 2009-12-18 09:45:16 +0000 (Fri, 18 Dec 2009) | 1 line
Changed paths:
M /trunk/Grid.toc
- Update TOC for release
------------------------------------------------------------------------
r1258 | Phanx | 2009-12-18 09:44:45 +0000 (Fri, 18 Dec 2009) | 1 line
Changed paths:
M /trunk/GridFrame.lua
- Reduce default font size slightly in case people have four wide letters at the beginning of their name
------------------------------------------------------------------------
r1257 | Phanx | 2009-12-15 16:42:58 +0000 (Tue, 15 Dec 2009) | 1 line
Changed paths:
M /trunk/GridFrame.lua
M /trunk/GridStatusAuras.lua
- Add default settings for Riptide buff
------------------------------------------------------------------------
r1256 | Guiaswow | 2009-12-15 13:50:39 +0000 (Tue, 15 Dec 2009) | 1 line
Changed paths:
M /trunk/Locales/GridLocale-esES.lua
M /trunk/Locales/GridLocale-esMX.lua
Grid Spanish Translation
------------------------------------------------------------------------
r1255 | Phanx | 2009-12-13 15:46:43 +0000 (Sun, 13 Dec 2009) | 1 line
Changed paths:
M /trunk/.pkgmeta
- Fix path to CallbackHandler-1.0 in .pkgmeta
------------------------------------------------------------------------
r1254 | Phanx | 2009-12-11 10:58:54 +0000 (Fri, 11 Dec 2009) | 3 lines
Changed paths:
M /trunk/Grid.toc
- Add X-WoWI-ID field for WoWInterface's MMOUI Minion
- Remove unused TOC fields
- Revert Version field to actual released version number (please don't change it unless you're tagging a release)
------------------------------------------------------------------------
r1253 | kunda | 2009-12-09 19:39:20 +0000 (Wed, 09 Dec 2009) | 1 line
Changed paths:
M /trunk/Grid.toc
update toc for Patch 3.3 (30300)
------------------------------------------------------------------------
r1252 | Phanx | 2009-12-02 10:44:43 +0000 (Wed, 02 Dec 2009) | 2 lines
Changed paths:
M /trunk/.pkgmeta
M /trunk/GridFrame.lua
M /trunk/GridStatusAuras.lua
- Increase default frame and text sizes
- Add default settings for Lifebloom and Forbearance
------------------------------------------------------------------------
r1250 | Phanx | 2009-12-02 04:19:16 +0000 (Wed, 02 Dec 2009) | 1 line
Changed paths:
M /trunk/Grid.toc
- Update toc for release
------------------------------------------------------------------------
r1249 | Phanx | 2009-11-30 04:50:54 +0000 (Mon, 30 Nov 2009) | 1 line
Changed paths:
M /trunk/GridFrame.lua
M /trunk/GridLayout.lua
M /trunk/GridStatusHealth.lua
- Unregister UNIT_NAME_UPDATE from group headers to alleviate problems caused by morons running title-swap addons
------------------------------------------------------------------------
r1248 | pastamancer | 2009-11-28 19:46:13 +0000 (Sat, 28 Nov 2009) | 2 lines
Changed paths:
M /trunk/Grid.toc
Update toc for another release.
------------------------------------------------------------------------
r1247 | greltok | 2009-11-27 09:02:09 +0000 (Fri, 27 Nov 2009) | 1 line
Changed paths:
M /trunk/GridFrame.lua
Respect the alpha when the icon border color is set to ignore.
------------------------------------------------------------------------
r1246 | greltok | 2009-11-21 18:27:29 +0000 (Sat, 21 Nov 2009) | 1 line
Changed paths:
M /trunk/GridFrame.lua
Ticket 238 - Reverted previous fix, as extra entries in the color table would not be passed along. Instead, we check for alpha when the indicator is set.
------------------------------------------------------------------------
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)...
