About Grid
Grid is a modular, lightweight, and screen-estate saving grid of party/raid unit frames.
Read This
Due to its flexible design, Grid has a fairly daunting configuration menu. I suggest taking a few minutes to look through the configuration and familiarize yourself with the options available to you.
There's a very small User's Guide that needs some love but may be helpful in its current state.
How to report a bug
Before reporting a bug, check the bugtracker to see if the bug you were going to report has already been reported!
After verifying that your bug hasn't been reported (or resolved!), create a new ticket.
Please be sure to include the following information in the ticket:
- Grid version (ex: r16623 from wowace.com)
- WoW version and language (ex: 1.12 enUS)
- What you were doing when the bug occured
- What happened (ie. what the bug is)
- Any error messages if applicable (please use BugSack to get a full stack trace for the error message)
- A complete list of addons you have installed
- 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.
Each indicator can only show one status at a time. This is where the priority system comes into play. The highest priority in-range status will be displayed. Indicators are only updated when a status is gained or lost on the unit. Status setting changes only take effect when a new StatusGained event is sent.
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
- Mikk: icon
- kaybe: german localization
- JoshBorke: API documentation
- Jerry: Pet support
- Julith: HealComm usage
------------------------------------------------------------------------
r1211 | pastamancer | 2009-08-11 19:17:48 +0000 (Tue, 11 Aug 2009) | 1 line
Changed paths:
A /tags/1.30200.2009081101 (from /trunk:1210)
Tag for release. Mostly just translation fixes.
------------------------------------------------------------------------
r1210 | pastamancer | 2009-08-11 19:16:19 +0000 (Tue, 11 Aug 2009) | 1 line
Changed paths:
M /trunk/Grid.toc
Prepare for tag.
------------------------------------------------------------------------
r1209 | pastamancer | 2009-08-11 19:11:37 +0000 (Tue, 11 Aug 2009) | 1 line
Changed paths:
M /trunk/GridLocale-enUS.lua
M /trunk/GridLocale-esES.lua
M /trunk/GridLocale-esMX.lua
M /trunk/GridLocale-zhCN.lua
Removed old translations.
------------------------------------------------------------------------
r1208 | pastamancer | 2009-08-10 15:11:43 +0000 (Mon, 10 Aug 2009) | 1 line
Changed paths:
M /trunk/Grid.toc
Added Waterfall-1.0 to optdeps.
------------------------------------------------------------------------
r1207 | trasher | 2009-08-06 20:10:55 +0000 (Thu, 06 Aug 2009) | 1 line
Changed paths:
M /trunk/GridLocale-frFR.lua
frFR update
------------------------------------------------------------------------
r1206 | trasher | 2009-08-06 20:09:44 +0000 (Thu, 06 Aug 2009) | 1 line
Changed paths:
M /trunk/GridLocale-frFR.lua
frFR update
------------------------------------------------------------------------
r1204 | pastamancer | 2009-08-05 17:30:49 +0000 (Wed, 05 Aug 2009) | 1 line
Changed paths:
M /trunk/Grid.toc
Update toc for release.
------------------------------------------------------------------------
r1203 | onyxmaster | 2009-08-05 08:05:09 +0000 (Wed, 05 Aug 2009) | 1 line
Changed paths:
M /trunk/GridLocale-ruRU.lua
ruRU: grammar fixes, new "25/10-player" instead of "heroic/normal" texts
------------------------------------------------------------------------
r1202 | lsjyzjl | 2009-07-31 09:21:45 +0000 (Fri, 31 Jul 2009) | 1 line
Changed paths:
M /trunk/GridLocale-zhTW.lua
zhTW typo fix
------------------------------------------------------------------------
r1201 | lsjyzjl | 2009-07-31 03:38:43 +0000 (Fri, 31 Jul 2009) | 1 line
Changed paths:
M /trunk/GridLocale-zhTW.lua
zhTW Update
------------------------------------------------------------------------
r1200 | sayclub | 2009-07-10 23:47:35 +0000 (Fri, 10 Jul 2009) | 1 line
Changed paths:
M /trunk/GridLocale-koKR.lua
koKR typo fix
------------------------------------------------------------------------
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)...
