Installation:
Extract the boxhud-x.y.z.zip and add
boxhud.lua
and the
boxhud
folder to the
lua
folder of your MQ directory.
Make sure that the mq2lua plugin is loaded: /plugin mq2lua
Run the script:
/lua run boxhud
NOTE: If the script errors loading lfs.dll, then you may need to install the VC Redist package from Microsoft
Add an Observed Property for all characters:
1. Go to
Configuration tab
2. Expand
Properties
3. Click
Add new property...
4. Fill in the details.
4a. The property
Name should be a valid TLO member, without the surrounding
${ }
. For example, if you wanted to add
${Me.Class.ShortName}
, you would enter
Me.Class.ShortName
4b. The property
DependsOnName and
DependsOnValue can be left blank as the observer will be added for all characters.
5. Click
Save to persist the changes
NOTE: All TLO members are case sensitive. For example, me.pcthps or Me.Pcthps or Me.PctHps will fail. Only Me.PctHPs will work. Adding observers on TLO members that don't exist can have annoying consequences. If you're unsure, /echo it first. For ideas of what can be added, check out the MQ TLO documentation here: MacroQuest Docs
Add an Observed Property only for characters matching some criteria (Use this for observing TLO members that won't exist on every toon, like CWTN.Mode won't exist on your bard):
1. Go to
Configuration tab
2. Expand
Properties
3. Click
Add new property...
4. Fill in the details.
4a. The property
Name should be a valid TLO member, without the surrounding
${ }
. For example, if you wanted to add
${CWTN.Mode}
, you would enter
CWTN.Mode
4b. The property
DependsOnName should be set to the TLO member which you want to use to determine whether the observer should be added. For example, if you wanted to add an observed property only for certain classes, you might set
DependsOnName to
Me.Class.ShortName
.
4c. The property
DependsOnValue should be set to the list of acceptable values for the TLO member specified in
DependsOnName. For example, if
DependsOnName were
Me.Class.ShortName
and you wanted the observer to only be added for warriors, shadow knights and paladins, then you could set
DependsOnValue to
war,pal,shd
.
5. Click
Save to persist the changes
Add a NetBots Property for all characters:
1. Go to
Configuration tab
2. Expand
Properties
3. Click
Add new property...
4. Select the NetBots radio button
5. Fill in the property
Name.
6. Click
Save to persist the changes
Add a Spawn Property for all characters:
1. Go to
Configuration tab
2. Expand
Properties
3. Click
Add new property...
4. Select the Spawn radio button
5. Fill in the details.
5a. The property
Name should be a member of the
Spawn TLO, such as
Distance3D
.
5b. The property
FromIDProperty usually should be left empty.
6. Click
Save to persist the changes
Add a column:
1. Go to
Configuration tab
2. Expand
Columns
3. Click
Add new column...
4. Fill in the details
5. Click
Save to persist the changes
Add a tab:
1. Go to
Configuration tab
2. Expand
Tabs
3. Click
Add new tab...
4. Fill in the details
5. Click
Save to persist the changes
Add a window
1. Go to
Configuration tab
2. Expand
Windows
3. Click
Add new window...
4. Fill in the details
5. Click
Save to persist the changes
There are 4 options for the DanNet peer group which can be configured for a window:
-
all -- The window will show all characters connected to DanNet, from the
all peer group.
-
zone -- The window will show all characters in the same zone as the character running Boxhud, from the automatically created DanNet peer group for the current zone.
-
group -- The window will show all characters in the same group as the character running Boxhud, from the automatically created DanNet peer group for the group. Note that the automatically created group in DanNet relies on the group leaders name, and Boxhud is currently written to expect the character running Boxhud to be the group leader. This means that if the window is set to use "group" and your characters name is "aquietone", then the window will display characters from the group "group_myserver_aquietone".
-
other -- If you want to enter your own DanNet peer group which is not covered by the above, then select other and enter your own group name.