shagu / ShaguWidget

A Desktop Widget System For World of Warcraft: Vanilla & TBC

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ShaguWidget

ShaguWidget is an addon for the original World of Warcraft: Vanilla (1.12.1) and The Burning Crusade (2.4.3) gameclients. It is highly configurable and is able to monitor several game variables including the memory, upload, download, server time, unit names, levels, health, mana, money and much more. ShaguWidget is drawn directly to the World Frame, allowing it to stays visible even when the UI is fade out.

The addon supports adding multiple widgets. Each widget can be scripted and customized via the built-in widget editor using plain text and several variables. Every widget can be toggled for each character. In order to move a widget, the editor has to be opened.

Commands

To start the editor/unlock mode:

  • /shaguwidget
  • /swidget
  • /widget

Preview

screenshot YouTube Video on the initial prototype: HERE

Variables

  • {color COLOR} - Set the color to following characters to the given hex color (RRGGBB) such as: "33ffcc". If empty, the color will be reset to game defaults.

  • {size SIZE} - Set the font size of the entire line to a specific size. Defaults to 12.

  • {font FONT} - Set the font family of the entire line to a specific font. Defaults to default game font. For details, see the font section below.

  • {date FORMAT} - Displays the given date format. Defaults to "%M/%D/%Y %H:%M:%S". For details, see: Lua docs

  • {name UNIT} - Displays the name of the given unit. Defaults to own character name. For details, see WoWWiki)

  • {level UNIT} - Displays the level of the given unit. Defaults to own character level. For details, see WoWWiki)

  • {elite UNIT STRING} - Displays the elite state of the given unit. Defaults to own character level. For details, see WoWWiki). The string parameter is a comma-separated list of strings that should be printed for each elite type. Defaults to: _,+,R+,B,R where _ is shown as nothing.

  • {health UNIT} - Displays the health of the given unit. Defaults to own character health. For details, see WoWWiki)

  • {maxhealth UNIT} - Displays the maximum health of the given unit. Defaults to own character max health. For details, see WoWWiki)

  • {mana UNIT} - Displays the mana of the given unit. Defaults to own character mana. For details, see WoWWiki)

  • {maxmana UNIT} - Displays the maximum mana of the given unit. Defaults to own character max mana. For details, see WoWWiki)

  • {gold} - Displays the characters gold.

  • {silver} - Displays the characters silver.

  • {copper} - Displays the characters copper.

  • {realm} - Display the realm name.

  • {fps} - Displays the FPS.

  • {ping} - Displays the ping in milliseconds.

  • {up} - Displays the current upload in KB/s.

  • {down} - Displays the current download in KB/s.

  • {mem} - Displays the RAM usage of all addons in MB.

  • {memkb} - Displays the RAM usage of all addons in KB.

  • {serverh} - Displays the servertime clock (hour).

  • {serverm} - Displays the servertime clock (minutes).

  • {itemcount NAME} - Displays how many of the given items are carried in the inventory.

  • {zone} - Displays the real name of an instance or the zone name.

  • {subzone} - Displays the subzone name or an empty string (if not in a subzone).

Fonts

Builtin Fonts

ShaguWidget already includes 14 fonts taken from the google font project:

thumbnails

Custom Fonts

In order to use a custom font, make sure it's a TrueType (.ttf) font and copy it to the Interface\AddOns\ShaguWidget[-tbc]\fonts directory. It might be required to restart the game, before you can access it via the regular {font YOURFONT} variable.

About

A Desktop Widget System For World of Warcraft: Vanilla & TBC

License:MIT License


Languages

Language:Lua 100.0%