MUDBRINGER
Menu

Dashboard & UI

background

Syntax

/background {path} [{position}]

Use Case:

Sets the background image for the current session terminal.

Arguments:

  • {path} : Path to the image file.
  • {position}: Alignment (Center, Tile, Stretch, Fill, Fit).

Examples:

  1. /background {C:\images\bg.jpg} {Fill}
  2. /background {bg2.png}

See Also:

border

barback

Syntax

/barback {color}

Use Case:

Sets the default background color for the status bar.

Arguments:

  • {color}: ANSI color index (0-7) or Hex code.

Examples:

  1. /barback {0}
  2. /barback {#111111}

See Also:

barfore, baritemback

barfore

Syntax

/barfore {color}

Use Case:

Sets the default foreground color for the status bar.

Arguments:

  • {color}: ANSI color index (0-15) or Hex code.

Examples:

  1. /barfore {7}
  2. /barfore {#FFFFFF}

See Also:

barback, baritemfore

baritem

Syntax

/baritem {name} {text} {pos} {len} [fore] [back] [group]

Use Case:

Defines a dynamic item to be displayed on the status bar.

Arguments:

  • {name} : Unique identifier.
  • {text} : Text template (can include variables).
  • {pos} : Character position on the bar.
  • {len} : Maximum length.
  • [fore]: (Optional) Foreground color.
  • [back]: (Optional) Background color.
  • [group]: (Optional) Script group.

Examples:

  1. /baritem {hp} {HP: $hp} {1} {10} {10} {0} {combat}

See Also:

unbaritem, barseparator

baritemback

Syntax

/baritemback {name} {color}

Use Case:

Sets the background color for a specific bar item.

Arguments:

  • {name} : Item name.
  • {color}: Color index or Hex.

Examples:

  1. /baritemback {hp} {1}

See Also:

baritemfore, baritem

baritemfore

Syntax

/baritemfore {name} {color}

Use Case:

Sets the foreground color for a specific bar item.

Arguments:

  • {name} : Item name.
  • {color}: Color index or Hex.

Examples:

  1. /baritemfore {hp} {12}

See Also:

baritemback, baritem

baritemshift

Syntax

/baritemshift {start} {end} {shift}

Use Case:

Shifts a range of status bar items by a specific offset.

Arguments:

  • {start}/{end}: Range of items (1-indexed).
  • {shift} : Number of characters to shift.

Examples:

  1. /baritemshift {1} {5} {10}

See Also:

baritem

barseparator

Syntax

/barseparator {name} {pos}

Use Case:

Adds a vertical separator line to the status bar.

Arguments:

  • {name}: Unique name.
  • {pos} : Character position.

Examples:

  1. /barseparator {sep1} {20}

See Also:

baritem

clearscreen

Syntax

/clearscreen

Use Case:

Wipes the entire terminal buffer and clears the screen. Also known as /cls.

Arguments:

  • (None)

Examples:

  1. /clearscreen

See Also:

cls

cr

Syntax

/cr

Use Case:

Sends a blank carriage return (Enter key) to the server.

Arguments:

  • (None)

Examples:

  1. /cr

See Also:

(None)

dashboard

Syntax

/dashboard {name} {rows} {cols} {opacity}

Use Case:

Initializes a new dashboard or updates an existing one’s grid dimensions.

Arguments:

  • {name} : The unique name for the dashboard.
  • {rows} : Number of logical rows in the grid.
  • {cols} : Number of logical columns in the grid.
  • {opacity}: (Optional) Transparency from 0.0 (clear) to 1.0 (opaque).

Examples:

  1. /dashboard {MyStats} {10} {10} {0.85}
  2. /dashboard {Map} {1} {1}

See Also:

dashadd, dashdock, dashgrid, dashboards

dashadd

Syntax

/dashadd {dash} {type} {r} {c} {rs} {cs} {name} [args]

Use Case:

Adds a UI element to a dashboard grid at a specific position.

Arguments:

  • {dash} : Target dashboard name.
  • {type} : item type (button, percentbar, textbar, textbox, nested).
  • {r}/{c} : Row and Column starting position (0-indexed).
  • {rs}/{cs}: Row Span and Column Span (size).
  • {name} : Unique name for the item.
  • [args] : Item-specific parameters (see examples).

Examples:

  1. /dashadd {MyStats} {button} {0} {0} {1} {1} {Buffs}
  2. /dashadd {MyStats} {percentbar} {1} {0} {1} {10} {HP} {0} {100} {Char.HP} {Red:25,Green:100} {1} {percent} {12.0} {White}

See Also:

dashset, dashtext, dashboard

dashboards

Syntax

/dashboards

Use Case:

Lists all defined dashboards and their current visibility/docking status.

Arguments:

  • (None)

Examples:

  1. /dashboards

See Also:

showdashboard, hidedashboard, dashstatus

dashdock

Syntax

/dashdock {dash} {mode} {hydrationMode}

Use Case:

Attaches a dashboard to a specific edge of the main window.

Arguments:

  • {dash} : Dashboard name.
  • {mode} : Top, Bottom, Left, Right, or Floating.
  • {hydrationMode}: (Optional) Docking behavior in Focus Mode.

Examples:

  1. /dashdock {MyStats} {Right} {Top}
  2. /dashdock {Chat} {Bottom}

See Also:

dashdockhydrate, dashpos

dashgrid

Syntax

/dashgrid {dash} [rows {def}] [cols {def}]

Use Case:

Defines custom row/column scaling for a dashboard grid.

Arguments:

  • {dash}: Dashboard name.
  • {def} : Comma-separated scaling (e.g. 1*, auto, 100).

Examples:

  1. /dashgrid {Map} {rows} {1} {cols} {1}**
  2. /dashgrid {Stats} {rows} {20,1,20}*

See Also:

dashboard, dashadd

dashset

Syntax

/dashset {dash} {item|prop} {prop|val} {val}

Use Case:

Modifies properties of a dashboard or a specific item within it.

Arguments:

  • {dash} : Dashboard name.
  • {item} : Item name or a dashboard property like ‘opacity’.
  • {prop} : Property to change (align, margin, row, col, dir).
  • {val} : The new value for the property.

Examples:

  1. /dashset {MyStats} {HP} {align} {Center}
  2. /dashset {MyStats} {opacity} {0.5}

See Also:

dashadd, dashboard

fontstretch

Syntax

/fontstretch {x} {y}

Use Case:

Adjusts the horizontal and vertical scaling of the terminal font. This is useful for ‘tightening’ legacy fonts (like Medievia) to remove gaps on high-resolution displays.

Arguments:

  • {x}: Horizontal scale factor.
  • {y}: Vertical scale factor.

Examples:

  1. /fontstretch {1.0} {1.1}

See Also:

@fontstretch, @fontsize

hidedashboard

Syntax

/hidedashboard {dash}

Use Case:

Hides a visible dashboard.

Arguments:

  • {dash}: Dashboard name to hide.

Examples:

  1. /hidedashboard {Map}

See Also:

showdashboard, dashboards

showdashboard

Syntax

/showdashboard {dash}

Use Case:

Makes a hidden dashboard visible.

Arguments:

  • {dash}: Dashboard name to display.

Examples:

  1. /showdashboard {MyStats}

See Also:

hidedashboard, dashboards

statusbar

Syntax

/statusbar {above|below|off|on}

Use Case:

Toggles the status bar on/off or changes its position.

Arguments:

  • {mode}: ‘above’, ‘below’, ‘off’, or ‘on’ (toggles).

Examples:

  1. /statusbar {below}
  2. /statusbar {off}

See Also:

statusbarsize, baritem

statusbarsize

Syntax

/statusbarsize {lines} {width}

Use Case:

Sets the number of lines and the width of the status bar.

Arguments:

  • {lines}: Height in terminal lines.
  • {width}: Width in characters.

Examples:

  1. /statusbarsize {2} {80}

See Also:

statusbar

tabadd

Syntax

/tabadd {word}

Use Case:

Adds a word to the global tab-completion list. These words are used to complete input when the Tab key is pressed.

Arguments:

  • {word}: The word to add.

Examples:

  1. /tabadd {mycommand}

See Also:

tabdelete, tablist

tabdelete

Syntax

/tabdelete {word}

Use Case:

Removes a word from the global tab-completion list.

Arguments:

  • {word}: The word to remove.

Examples:

  1. /tabdelete {mycommand}

See Also:

tabadd, tablist

tablist

Syntax

/tablist

Use Case:

Displays all words currently in the global tab-completion list.

Arguments:

  • (None)

Examples:

  1. /tablist

See Also:

tabadd, tabdelete

unbaritem

Syntax

/unbaritem {name|index}

Use Case:

Removes an item from the status bar.

Arguments:

  • {name} : Name of the item.
  • {index}: Numeric position (1-based).

Examples:

  1. /unbaritem {hp}
  2. /unbaritem {1}

See Also:

baritem

updatebaritem

Syntax

/updatebaritem

Use Case:

Alias for /updatestatusbar.

Arguments:

  • (None)

Examples:

  1. /updatebaritem

See Also:

updatestatusbar

updatestatusbar

Syntax

/updatestatusbar

Use Case:

Forces the status bar to redraw immediately.

Arguments:

  • (None)

Examples:

  1. /updatestatusbar

See Also:

updatebaritem