A Lua / ImGui boxing HUD for EverQuest.
- MQ
- MQ2Lua
- Either or both of:
- MQ2DanNet (to use DanNet peers/observers)
- MQ2EQBC+MQ2NetBots (to use netbots data)
Add the boxhud folder to the lua folder of your MQ directory, or wherever your configured lua path may be.
On first start, you will be prompted to download lfs.dll from the MQ luarocks server if it is not already present.
Run the script with:
/lua run boxhud
Stop the script with:
/boxhudend
or
/lua stop boxhud
Toggle the window with:
/boxhud
Show help output:
/bhhelp
BoxHUD provides an alternative to a similar MQ2NetBots/MQ2HUD based HUD. Instead, it uses observed properties from MQ2DanNet to watch various bits of information about all your peers. It is also still possible to use MQ2NetBots values if desired.
The default settings provided Includes the following properties:
General tab:
- Name -- in green if in same zone as the character running the script, in ( ) if invis, in red if not in same zone
- HP% -- with % threshold based coloring, red < 35, yellow < 70, green > 70
- Mana% -- with % threshold based coloring, red < 35, yellow < 70, green > 70.
- Endurance% -- with % threshold based coloring, red < 35, yellow < 70, green > 70.
- Distance -- if character is in same zone, displays distance away from the character, green if dist < 100, yellow < 200, red > 200
- Target -- if character is in same zone, name of their target
- Spell/Disc -- name of spell currently being cast or current running disc
Macro tab:
- Macro Name -- the name of the currently running macro
- Paused -- shows PAUSED if the currently running macro is paused
- Pause macro button -- sends
/dex name /mqpto the character - End macro button -- sends
/dex name /endto the character
XP tab:
- Exp% -- current level experience percentage
- AA Unspent -- current number of unspent AAs
Additionally, the character names are buttons with the following function:
- Left click -- Brings the character to the foreground with
/dex toonname /foreground. - Right click -- Opens a context menu with some helpful buttons specific to the selected toon. Also includes a
Send Commandtext input which will do/dex toonname <text input>
These button actions are more just to play around with the capabilities provided by lua and ImGui.
Example:
Context menu on Name column:
Context menu on table:
Hide columns using the table menu:
Click and drag headers to rearrange table columns:
Configuration:
The script takes a few seconds to start up as it waits for the DanNet observers to be ready. Characters which log off or for some reason stop being available will go stale and be removed from the table after 30 seconds.
The configuration is stored in a separate Lua file, which is then included with settings = require 'boxhud.settings.boxhud-settings'.
By default, boxhud-settings.lua is included with the script. Upon startup, it will be copied to a character specific file boxhud-settings-charactername.lua.
An existing boxhud-settings-charactername.lua will always take precedence over boxhud-settings.lua.
A settings filename can also be provided when starting the script like lua run boxhud boxhud-settings.lua
Note that since the settings are another lua file, its expecting the settings file to also be in the lua folder, rather than the config folder.
Boxhud configuration is broken up into 4 main sections: Properties, Columns, Tabs and Windows.
- Properties define what data you want to watch in the HUD. These can include DanNet observed properties, NetBots properties and Spawn properties.
- Columns define the display settings for a given property, such as whether it should only show for toons in the same zone as you, or whether it is a percentage value. They can also be used to define value mappings to display different text based on the value returned for a property.
- Tabs define a group of columns to be displayed together.
- Windows define individual ImGui windows to display, which allows for having separate groups of characters displayed in separate windows.
There are 3 types of properties: Observed, NetBots and Spawn.
Properties = {
['Me.PctHPs'] = {
['Name']='Me.PctHPs',
['Type']='Observed'
}
}
Observed properties define a property for which a DanNet observer should be created for each toon, to monitor the value of that property from each toon.
Observing properties which are not defined on a toon can impact running macros. To avoid this, there are some optional settings which can be added to Observed property definitions to define conditions for when to create the observer for a given toon.
Properties = {
['CWTN.Mode'] = {
['Name']='CWTN.Mode',
['Type='Observed',
['DependsOnName']='Me.Class.ShortName',
['DependsOnValue']='MNK,ROG,WAR,SHD,MAG,ENC,CLR,BST,SHM'
}
}
The example above would observe CWTN.Mode only on toons whose class is listed in DependsOnValue, which are the classes that have CWTN plugins available.
Properties = {
['PctMana'] = {
['Name']='PctMana',
['Type']='NetBots'
}
}
NetBots properties define a property to get from NetBots for each toon.
Properties = {
['Distance3D'] = { Type='Spawn' }
}
Spawn properties define a property to read from the Spawn data for each toon. These will only work for toons that are in the same zone as only they would have Spawn data available.
All 3 types of properties can be mixed together, provided they have unique names. Combining the 3 example properties above, we would have:
Properties = {
['Me.PctHPs'] = { Name='Me.PctHPs', Type='Observed' },
['PctMana'] = { Name='PctMana', Type='NetBots' },
['Distance3D'] = { Name='Distance3D', Type='Spawn' },
['CWTN.Mode'] = {
Name='CWTN.Mode',
Type='Observed',
DependsOnName='Me.Class.ShortName',
DependsOnValue='MNK,ROG,WAR,SHD,MAG,ENC,CLR,BST,SHM'
}
}
Columns can have two types, property or button.
Each property column includes several settings, for example:
['MP%'] = {
Type='property'
Properties={caster='Me.PctMana'},
Thresholds={35,70},
Percentage=true,
Ascending=true,
InZone=false
},
Each column lists the property or properties which it uses to populate its data.
More details on each setting can be found in the provided boxhud-settings.lua.
Note that the Name column is treated as a special case.
Each button column specifies the command to run on click, for example:
{
Name='Pause',
Type='button',
Action='/dex #botName# /mqp'
},
The button Action supports replacement of the string #botName# with the name of the character in the row where the button exists.
Each tab includes a name and list of columns to be included in that tab, for example:
{
Name='General',
Columns={
{
'HP%',
'MP%',
...
}
}
},
Windows include a name and a list of tabs to be shown on the window.
['default'] = {
Name='default',
Tabs={
'General'
}
}
Some other configuration options include:
This can be set to dannet or netbots to specify whether the list of peers to display in the HUD should come from MQ2DanNet or MQ2NetBots.
This can be set to all or zone to use either the DanNet All peer group or the zone specific peer group. Default: zone
Configure the delay for polling observed properties. Used in mq.delay() call.
Default: 250 (0.25 seconds)
Configure the time in seconds before stale entries are removed from the displayed data. Default: 60
- I'm far from (read: not at all) a Lua expert, so don't be too surprised if any Lua best practices haven't been followed here or things could be done in much more clean ways.
- I'm open to suggestions / improvements :)
- This is mostly just written as me wanting to explore some of the possibilities provided by the new Lua support
- This is still very much a work in progress