TurkMod

Most of the Statistics bar.

This mod adds a thin bar to your screen, on which you can find shortcuts to various mods and functions within the mod.

Features

Group Statistics

Firstly, the TurkBar will inform you, updating every second, via a series of icons and numbers, how many people in your party/raid are in various states:

Statistics List

• Soulstoned,
  
• In need of your buff  (Arcane Intellect, Power Word: Fortitude, Blessing of Light, etc),
  
• Dead,
  
• In combat,
  
• PvP-enabled,
  
• AFK,
  
• Disconnected,
  
• Far away from you,
  
• Using TurkMod,
  
• Alive, connected and at their keyboard and
  
• In your raid.
  

Tooltip Basics

If you mouse-over any of these buttons, a tooltip will appear, informing you of exactly which players this number is comprised. AFK and disconnected players will also have a time after their name, showing how long they have been that way. Soulstoned players will output how long is left on their Soulstone.

If you mouse-over the number showing how many people are in your raid, a box will appear showing how many of each class there are in the raid, and, below this, how many of these players are active (ie. not disconnected or dead).

You can left-click on any button on the Statistics bar to "sticky" that option, meaning its tooltip will always be shown. You can also right-click on several of these buttons to set various options.

Note that if you join a group with players already afk, disconnected, soulstoned or needing your buff, all these timers will only count from when you joined the group and no earlier. However, if another player with TurkMod is already in the raid, the mod will automatically synchronise its timers with those of everyone else in the raid. As such, please try to share the mod with as many other players as possible ;)

Tooltips' Colours

In brackets after the names of those needing your class's buff, if you are in a raid, will be the player's group number, colour-coded to show how far away that player is, and whether or not they are PvP-enabled. In addition, if they have less than a preset time left (default 5 minutes) on their buff, they will be output with this time also after their name, so you can rebuff them before their buff runs out. The colours mean the following things:

• Red group number: not in your zone.
  
• Green group number: PvP-enabled.
  
• Blue group number: In your group.
  
• Orange or dark-coloured group number group number: In your zone, but not in range.
  
• Yellow or bright/light-coloured group number: In your zone, and in range. May still be out of line-of-sight.
  
• Dark green time: This time is definitely correct; there is no error. Exact buff times can unfortunately only be retreived for the player's own buffs, and buffs the player cast.
  
• Yellow time: This time may be inaccurate, if you have just joined the group or if the player's buff has been re-cast by a player not using TurkMod; otherwise, it should be accurate to within a second. Note that when any player with the mod casts their class buff, this is broadcast to the raid, so there is almost no chance of a buff timer being incorrect if cast by a player with the mod.

Easy Buffing

The most useful aspect of the mod, to a class with a buff, is that when you click on the Buff icon on the Statistics bar mentioned above, a macro will be created that will automatically target a player in your party/raid who needs this buff. Each time you use the macro to cast a spell, it will update itself to target a different raid member, until all those in range have been buffed.

Targets' Order

The macro will choose targets intelligently, ignoring irrelevant classes (like Rogues for Arcane Intellect), automatically buffing your group first in a raid, and then continuing to buff the other groups in numerical order.

Imminent Expiration

Each player in the group with a buff that will run out of time soon (by default, one with under 4 minutes remaining), they will be targeted automatically by your buffing macro, and will also be output in the tooltip with the time left on their buff in brackets after their name.

Greater Buffs

The buffing system will automatically use your greater buff (eg. Arcane Brilliance, Prayer of Spirit or Mark of the Wild) if there are enough people in the group need it. By default, it will use the improved buff if there are four or more people in the group needing the buff.

Notes

• Various options are available by right-clicking on the Buff icon, such as setting how many people in a group should need the buff before an hour-long version is used.
  
• Priests, mages and druids may use their Buff macro for anything while it is not being used by the mod's automatic buff system; when the mod has finished buffing the group, the macro will be returned to do whatever it did beforehand.
  
• Unfortunately, the macro cannot be modified in combat.
  
• A key binding is available to begin the buffing process.
  
• You can double-click on the Buff icon (or press the key binding twice) at any time to reset the macro.
  
• The mod supports the following spells:
  • Arcane Intelligence,
  • Power Word: Fortitude,
  • Divine Spirit,
  • Mark of the Wild,
  • Blessings of:
    • Kings,
    • Wisdom,
    • Might,
    • Salvation,
    • Light and
    • Sanctuary.

Money Counter

Also included in the mod is a counter, outputting to you exactly how much money you have made or lost since the counter was last reset (which can be done by right-clicking on this bar). This means you can always know accurately how much profit you've made from a quick instance run, or how much a night of wiping in a raid has cost.

Typo Corrector

The mod will automatically replace basic typos in your chat, such as "rouge" and "dranei".
The mod has by default a list of a few dozen common typos, but if you wish you can add more at any time.
This feature has numerous extra abilities; if you wish, it can remove spaces from the ends of your chat messages, capitalise "i" and change "u" to "you" (enabled by default), and correct all unusual caps usage.

AddOn Authors' Extras

TurkMod includes several handy features that can be very useful to other creators of World of Warcraft modifications:

Code Speed Testing

TurkMod includes a fairly extensive feature designed to help you determine the relative speeds of blocks of your code. All you have to do is enter one or two lines of code, and the mod will run each one until concordent times are found, then output the speed, or relative speeds, to you. This can be very useful when determining which of a series of functions or algorithms is quickest.

Extra functions

TurkMod also adds four global functions:

• ConvertBase(number, baseFrom, baseTo) allows you to convert a number from any base to any other (eg. binary to decimal, or decimal to hex). For example:
  • ConvertBase(1001101, 2, 10) -> 77
  • ConvertBase(1001101, 2, 16) -> "4D"
• NumString(numIn, dec, case) lets you change any numerical number to a string. See the mod's help menu for details on the arguments. For example:
  • NumString(10) -> "Ten"
  • NumString(429.302, 1, "l") -> "four hundred and twenty-nine point three"
• table.copy(inputTable) creates a table identical to inputTable except for the fact that modifying one of the tables will NOT modify the other. By default, "table1 = table2" simply creates a memory pointer towards the same variable; sometimes, this can be different from what we want.
  
• table.numvalues(inputTable[, keyType][, genre]) returns the number of values in inputTable, including those with non-numeric or non-consecutive indices. keyType is a string equal to the variable type (equal to type() ) of the index of the variable, eg. "string" or "number". genre is a similar string dictating the type of the value of the variable, eg. "table", "string", "function". Both keyType and genre may have a ^ or ! prefix to exclude the given type of variable.

Translations

If you play the game in multiple languages, TurkMod will help the transition between locales by translating all your localised strings (spell names, item names, etc) whenever you log in. You can add your own translations simply by dropping a spell or item onto a button on the TurkBar.

Minor Bonuses

The mod has a couple of extra small features which may be of use to you:

Intelligent Item Clicks

While you are using TurkMod and you left-click on a ring or a trinket in one of your bags, the mod will, if you wish, automatically equip this item in the second slot of its type.

Action Cooldowns

The mod can output the time remaining for each button on your action bars. This information will be shown on the button itself, and will replace, while a cooldown is in progress, any macro names and other text that would otherwise be shown.

Shortcuts

There are several more shortcuts included in the mod, which allow you to easily access one or two other AddOns, and perform a variety of useful actions such as reload your UI or run a line of test code.

Further help

TurkMod comes with a fairly extensive help menu, summarising the main features of the mod, and explaining the nuances of each feature. Additionally, almost every dropdown menu button in the mod has an explanatory tooltip.

Notes

• Just about all options may be disabled at will, and most have their own options menus, all of which may be accessed by right-clicking on the TurkBar or the relevant button.
  
• If the TurkBar is not visible when you first log on and you have a custom User Interface which replaces the action bars at the bottom of the screen, try "/turk reset" to reset the TurkBar's position to the centre of the screen, making it more easily found.
  
• Feel free to use the dropdown automenu system in your mod, but please give me credit, and inform me.
  
• Please report any errors to me via Curse private message, or in-game.

• 

  Author

  Turkey

  (Project Manager)

  Downloads

  • TurkMod

New Features

Range checker

• Enabled through the main options menu, this will output approximately how far from you your target is. Designed for the default Blizzard UI.

Cosmetic Changes

Custom Icons

• All buttons on the main TurkBar, and all statistics, are now represented by their own icon.

Sounds

• TurkMod will now (optionally, of course) speak to you at specific times.

Improved Features

Macro translation

• Dropdown menu buttons have been modified.
• Two new functions have been added (but not yet worked into the main interface due to time restraints):
  • TurkMod.RelocateStrings(localeTo) changes the default, output version of all strings to the given locale.
  • TurkMod.RetrieveClassSpells() stores all spells for the given class in the given locale. It should be run once per locale per character class so that all the spells (that have been learned) for the given class are stored and will be automatically translated whenever they are found in your macros.

DropDown AutoMenus

• You can now set how many menu items to skip when pressing the "Up" or "Down" buttons.

Code

• As usual, the general code of TurkMod has been upgraded.