Add-ons/Toolbox/Toolbelt and HUDs
More actions
The Toolbelt is the central heads-up display in the Toolbox Lua add-on. It uses the buff bar as its base and can attach the player's vital bars, consumables, equipment condition, and target display so the entire combat interface moves and hides as one unit.[1]
Building the Toolbelt
- Open settings with
/toolboxor/tbx. - Choose Toolbelt from the Settings menu and enable Show the Toolbelt.
- Set each component to Off, Own strip, or In Toolbelt. The target is controlled separately but may also join the Toolbelt.
- Move the complete assembly by dragging its grip or use
/toolbox toolbelt move <x> <y>.
The command form /toolbox toolbelt vitals|consumables|gear|target on|off changes which components are attached. Entering /toolbox toolbelt without a subcommand reports the current arrangement.
Only during combat hides the Toolbelt outside combat and for a short period afterward. It remains visible while settings are open so it can still be positioned. Because the buff bar is the base, turning that bar off separates the other enabled components onto their own strips.[1]
Buff bar and buff block
/toolbox buffs toggles the player's buff display. Buffs and red-outlined debuffs appear as skill icons ordered by remaining time. A darkening sweep, optional final-seconds counter, flashing border, and alert sound can signal expiration without depending on color alone.
Useful options include:
/toolbox buffalert 10sounds ten seconds before a buff expires;offdisables it./toolbox debuffalert on|offcontrols the debuff-arrival sound./toolbox buffs countdown onshows whole seconds near expiration; a number such as10changes the threshold./toolbox buffs combat on|offlimits the bar to combat./toolbox buffs replace on|offreplaces the game's buff bar on supported clients. The original returns whenever Toolbox's bar is not showing./toolbox buffs dismiss on|offallows a displayed buff to be dismissed on supported clients.
Long effects can share a grouped slot. The default threshold is fifteen minutes; /toolbox buffs group after 30 changes it to thirty minutes, while off disables time-based grouping. Names that should always be grouped can be managed in settings or with group add|remove <name>.
Repeated alerts may be muted by effect name. The repeat interval can also suppress another sound for the same effect until it has stopped recurring for the chosen time. Muting affects the sound, not the icon's visual warning.
Version 1.7.0 can assign a custom sound to an individual buff or debuff when it arrives, when it nears expiration, or both. Choose the effect and file under Buff settings, or use /toolbox buffs sound get|end <effect> = <file>. Store custom audio somewhere under the game's Lua folder but outside Lua/toolbox, because package updates replace that directory. A muted effect remains silent; if its custom file cannot be opened, Toolbox reports the problem and uses the ordinary alert instead.[1]
The optional buff block displays every effect on its own multi-row strip with no grouping. Its width, icon size, combat-only behavior, sweeps, countdown, and dismiss behavior are configurable. It is independent of the Toolbelt.
Buff-bar, buff-block, and skill-activity icons may be set as large as 64 pixels in version 1.7.0.
Health, focus, and Vigor
/toolbox vitals shows health and focus as current and maximum values, plus Vigor as a percentage once Vigor applies to the character. Settings control scale, bar length, numbers, bars, background, and the low-value flash threshold. When Dark is selected for the number panels, version 1.9.0 adds a background-shade slider; zero removes the panel while leaving the numbers solid.[1]
These bars can replace the corresponding elements in the game's player frame on supported clients. Use /toolbox vitals replace on|off. Replacement is temporary: the stock bars return if Toolbox's display is hidden or disabled.[1]
Target display
/toolbox target on displays the selected target's visible health, optional focus, and timed effects. Toolbox cannot reveal a creature's hidden health; such a target appears full, just as it does in the standard target frame. On API 47 or later, Only mine can limit effects to those applied by the player; API 48 can color the target name by difficulty.[1]
The target can appear above the buffs or below the Toolbelt, display all effects, debuffs only, or no effects, and show between one and eight icons. Show the target's name, off by default, places its name above the bars; the command equivalent is /toolbox target name on|off. Mirrored mode right-aligns that name, fills bars from right to left, and places the target to the left of the player's vital bars when both are attached. When the target is in the Toolbelt, showing its name moves the player's bars and buffs down one line so the two sets of bars remain aligned.[1]
The target's Dark number panels also have their own background-shade slider in version 1.9.0. All Toolbox HUD-strip backgrounds initially use 60 percent shading; a value of zero removes the panel without fading its text or icons.[1]
When the target occupies the top or left position, Toolbox reserves its space even with no target. This prevents the player's bars and effects from jumping when a target is selected. The reserved area is transparent and does not catch clicks; settings display a temporary label to help with placement.
Party Toolbelt
Introduced in Toolbox 1.10.0; requires Lua API 55. The separate Party Toolbelt can show each member's name, health and focus bars, percentage or dead/away/offline state, debuffs, and selected watched buffs. Members in another scene or beyond reach are dimmed. Rows may follow party order or sort by lowest health, and the player's own row is optional.
Party settings also provide optional health and named-debuff alerts. A qualifying member's health bar flashes, and Toolbox can send a notification or play a configured sound. Combat-only display is available.[1]
Consumables and equipment
The consumables bar separates food, potions, poisons, and supported combat consumables from the ordinary buff bar. Categories and name exclusions are configurable. Additional effects can be routed there by matching part of their name. Its expiration visuals and sounds follow the buff-bar settings.
The equipment bar appears when worn gear falls below its repair threshold, twenty percent by default. Its icons are ordered by condition and use a red sweep to show lost durability. The tooltip distinguishes ordinary repair needs from sufficiently worn items that require a crafting-station repair. While settings are open, all worn items appear to make placement easier.
Skill activity and pausing
The skill-activity strip shows recently changing skills, their levels or experience progress, and their training mode. On clients with Lua API 27, version 1.7.0 adds a pause tile at the beginning of the strip. Selecting it sets every skill—including skills being unlearned—to Off by default; selecting it again restores each skill's previous training, maintaining, or unlearning mode.
Toolbox restores only skills that remain in the state set by the pause. A skill changed manually in the meantime is left as the player set it. Settings can make a pause use Maintain instead of Off, or hide the tile while skills are running; it remains visible while paused so there is always a way back. /toolbox skills pause and /toolbox skills resume perform the same operations. The paused state is remembered per character across restarts.[2]
Moving strips
Toolbox HUD elements have a grip at the upper-left. If it is unavailable, clear Lock Status Movement under Options → Interface → Nameplates & Chat Bubbles. Strips can also be placed from HUD layout in Toolbox settings or with their move <x> <y> command.[1]
On clients with Lua API 31, a strip left outside the visible area after reducing the game window or increasing interface scale is moved back on screen automatically.