Skip to content

bhhandley/CleveRoidMacros

Repository files navigation

CleveRoid Macros

This was originally an effort to bring the dynamic tooltip and cast sequence functionality of CleverMacro into Roid-Macros. It has since expanded after some additional changes I wanted along with feedback from others. The majority of credit goes to the original addon authors. Still a work in progress.

Both SuperWoW and Nampower are recommended and in some cases requred.


Installation

Manual

  1. Download a zip from the green Code button or by clicking here
  2. Unzip the file and place the folder into your Interface/Addons folder.
  3. Rename the CleveRoidMacros-main folder to CleveRoidMacros
  4. Check that it is enabled in your addon list in-game.
  5. Make sure you don't have other macro addons that may interfere. SuperMacro should be compatible.

Turtle WoW Launcher / GitAddonsManager

  1. Open either application
  2. Click the Add button
  3. Paste the url https://github.com/bhhandley/CleveRoidMacros
  4. Download and keep up to date

Known Issues

  • Medium: Because this addon is constantly checking conditions for all macros on your actionbars, if you improperly create a macro, in some certain cases it can cause strange UI issues including not displaying any icons, other macros not working or lua errors. Fix the macro or remove it from your actionbar and it should go back to normal automatically. Depending on the cause, you may need to reload your UI (/rl). If you find one of these and can reproduce the issue, let me know.
  • Minor: There may be an odd interaction with SuperWoW and/or Nampower and randomly seeing "Unknown Unit" on the screen -- still trying to work out the root cause.
  • Minor: Macros will light up on the action bars the same as non-macro buttons do however if you have conditionals or more than one spell you must put the plain spell anywhere on your actionbars. This is also true for reactive abilities for basically the same reasons.
  • Minor: HealComm support. See below
  • I have not tested all possible combinations of conditionals or ways to break things. Find me on Discord or open an issue if you find any bugs or have feedback.

What's Different

Commands and Conditionals

Important! Spells, Items, conditionals, etc are case sensitive. Barring a bug, if there is an issue, it's almost always because something is typed incorrectly.

  • Renamed attacking/noattacking contitionals to targeting/notargeting for better clarity of what they do.
  • All conditionals that should have an implied target of @target now do
  • Conditionals can be separated by comma or space
  • Conditional arguments with spaces that would need to be replaced with underscores (_) can instead be enclosed in quotes.
  • Updated syntax for conditionals with stack/time checking
    • You can use >, <, =, ~=, >=, <= as valid operators. Include a # sign to designate you're checking the stack's, not time
      • Operators should be placed after the colon, either by itself (if applicable) or after the argument [power:>20], [debuff:"Sunder Armor<#5"], [buff:Thorns<30]
    • Omitting an operator or amount will just check that the buff/debuff exists
    • When stack checking, omitting an operator assumes equals (=)
      [debuff:"Sunder Armor#3] is the same as [debuff:"Sunder Armor=#3]
    • Omitting the argument entirely will assume you want to use the action in the condition check
      [nobuff] Power Word: Fortitude is the same as [nobuff:"Power Word: Fortitude"] Power Word: Fortitude
  • Updated most conditionals (that make sense) to allow for multiple arguments. Use a / to separate them.
  • Added plain [mod] and [nomod] to conditionals
  • Added alive conditional
  • Added member conditional
  • Added form conditional (an alias of stance)
  • Added Priest Shadowform to stance/form conditionals. Use [stance:1] or [form:1]
  • Added Rogue Stealth to stance/form conditionals. Use [stance:1] or [form:1]
  • Added combo conditional
  • Added known conditional
  • Added resting conditional
  • Changed cooldown conditional to ignore the GCD (will show usable if the cooldown is exactly 1.5 seconds) -- It felt better but not 100% on keeping this, send feedback.
  • Added cdgcd conditional that works the same as cooldown that will trigger for any length of cooldown
  • Added inrange conditional (Nampower required)
  • Added changes to make usable/mana/range updating show properly in pfUI.
  • Added Bongos action bars compatibility support
  • Added /runmacro command. Same as /cast {macroname} but always ignores icon/tooltip
  • Added /retarget command. Clears your target if it doesn't exist, has 0 hp or if you can't attack it and then targets the nearest enemy
  • Added /equipmh command. Equips the weapon into your mainhand slot.
  • Added ? flag to prevent an action from affecting the icon/tooltips. It must be the first character.
    #showtooltip
    /use ?Some Item
    /cast [reactive] Overpower; Heroic Strike
  • Updated ! flag as a shortcut easily make spammable spells.
  • Added ~ flag to either cast or cancel the buff/aura if possible. (Toggles the spell on/off)

Dynamic Icons and Tooltips

  • The icon and tooltip for a macro will automatically update to the first true condition's action. Left to right, top to bottom.

  • Consumables and certain other item types will now show a count on the action bar.

  • Spells with reagent costs will now show a count of how many uses you have.

  • Full #showtooltip support with dynamic icons and tooltips

    • A macro must start with #showtooltip or #showtooltip spell/item/itemid. The icons and tooltips will update on your bars as the conditions are met.

      #showtooltip
      /cast [mod:alt] Frostbolt; [mod:ctrl] Fire Blast; [mod:shift] {MyMacro}; Blink
      #showtooltip
      /cast [stance:1/3, nocooldown, notargeting:player] Mocking Blow
      /cast [stance:2/3, nocooldown, notargeting:player] Taunt
      /cast Shield Slam

      One line or separate lines are valid, sometimes one is better than the other

      #showtooltip
      /cast [zone:Ahn'Qiraj] Yellow Qiraji Battle Tank;[nozone:Orgrimmar/Undercity/"Thunder Bluff" nomybuff:"Water Walking"] Red Goblin Shredder;Plainsrunning
      

      Is the same as

      #showtooltip
      /cast [zone:Ahn'Qiraj] Yellow Qiraji Battle Tank
      /cast [nozone:Orgrimmar/Undercity/"Thunder Bluff" nomybuff:"Water Walking"] Red Goblin Shredder
      /cast Plainsrunning
      
  • Updated /castsequence support. See below

  • Added support for updating to the icon/tooltip of the {macro} named in a another macro

    • Macro 1 calls Macro 2 and will update the icon when out of combat with Arcane Missiles from Macro2's #showtooltip

      Note: This will only use the icon/tooltip of either the referenced #showtooltip <spell/item/itemid> or the icon you set for the macro.

      Macro 1:

      #showtooltip
      /cast [nocombat] {Macro2}; Fireball

      Macro 2

      #showtooltip Arcane Missiles
      /cast [mod] Conjure Food
      /use 2288
  • Added support for itemid lookup instead of the item's name. Using this will show the icon/tooltip even if you don't have the item cached or in your inventory so you don't see ? icons. e.g. No Mage food/water on login

    #showtooltip
    /use [nomod] 5350
    /cast [mod] Conjure Water

Usage

Slash Commands

Command Conditionals Supported Purpose
/retarget Clears your target if it doesn't exist, has 0 hp or if you can't attack it and then targets the nearest enemy.
/startattack Starts auto-attacking.
/stopattack Stops auto-attacking.
/stopcasting Stops casting.
/petattack * Starts your pet's auto-attack.
/castsequence * Performs a cast sequence. See below for more infomation.
/equip * Equips an item by name or itemid.
/equipmh * Equips an item by name or itemid into your mainhand slot.
/equipoh * Equips an item by name or itemid into your offhand slot.
/unshift * Cancels your current shapeshift form.
/cancelaura, /unbuff Cancels a valid buff/aura.
/runmacro Runs a macro. Use /runmacro {macroname}
/use * Uses an item by name or id
/cast * Casts a spell by name

Cast Sequence

#showtooltip
/castsequence reset=3 Fireball, Frostbolt, Arcane Explosion, Fire Blast
  • Dynamic icons and tooltips on each sequence with range/mana/usable checks

  • Supports reset=#/mod/target/combat

  • Supports conditionals for the entire sequence, not individual actions within the sequence.

    #showtooltip
    /castsequence [group:party/raid] reset=3/target Sweaty Spell 1, Sweaty Spell 2, Sweaty Spell 3
    /castsequence reset=target/combat Casual Spell 1, Casual Spell 2, Casual Spell 3
  • SuperWoW dll mod is required

  • Nampower dll mod required for range checking

Conditionals

  • Conditionals are basically if/then/else statements which are evaluated left to right, top to bottom.

  • The first set of conditions that are all true will be the action that happens so the order you put things in is very important.

  • Multiple conditionals can be used, separated with a space or comma.

  • Spells and items with spaces in the name need to use underscores (_) instead of spaces or be enclosed in quotations.

  • Each action can be written on one line or on separate. Both are effectively the same however WoW executes every line of a macro so it is technically better to use one line where possible. I usually prefer separate lines because it's easier to read and troubleshoot at a quick glance. You do you.

    Separate Lines:

    #showtooltip
    /use [@mouseover alive help hp:<70 nodebuff:"Recently Bandaged"] Runecloth Bandage
    /use [@target, alive, help, hp:<70, nodebuff:Recently_Bandaged] Runecloth Bandage
    /use [@player] Runecloth Bandage
    

    One Line:

    #showtooltip
    /use [@mouseover alive help hp:<70 nodebuff:"Recently Bandaged"] Runecloth Bandage; [@target, alive, help, hp:<70, nodebuff:Recently_Bandaged] Runecloth Bandage; [@player] Runecloth Bandage
    

    Note: Classic/Retail macros allow for cascading conditional blocks like below. This is NOT supported however a future update will add support for it.

    #showtooltip
    /use [@mouseover alive help hp:<70][@target alive help hp:<70][@player][] Runecloth Bandage
    
  • If a conditional on the table is marked as Multi you can provide multiple values in the same condition. Only one needs to be true.
    [targeting:party1/party2/party3/party4] -- targeting one of your party members
    [zone:Stormwind/Ironforge] -- in Stormwind OR Ironforge

  • If a conditional is marked as Noable you can prefix the condition with "no" to test the opposite condition. All need to be true
    [notargeting:player] -- not targeting the player
    [nozone:Stormwind/Ironforge] -- not in Stormwind AND not in Ironforge

  • You can specifiy a target unit for the macro by adding in a valid @unitid
    /cast [@party1 combat] Intervene -- casts Intervene on party member 1 if you (player) are in combat

  • @focus / focus can be used as an @unitid / conditional unitid however Vanilla does not support focus targets, a compatible addon is required to make this function.

  • If the conditional allows for a numerical comparison, the format is condition:>X or condition:"Some Value">X. If you want to compare stacks/rank (where applicable) and not remaining time, use >#X.

    • Only the player's buffs/debufs can be checked for remaining time
    • Valid operators are =, ~=, >, >=, <, <=
  • You can omit the value of a conditional if you want to check the same spell/item that you are using in the action.
    [debuff:"Sunder Armor"<#5] Sunder Armor == [debuff:<#5] Sunder Armor
    [nobuff:"Mark of the Wild"] Mark of the Wild == [nobuff] Mark of the Wild

  • SuperWoW dll mod is required for some conditionals

  • Nampower dll mod required for some conditionals

Special Characters

Character Syntax Examples Description
! !Attack
!Cat Form
!Spell Name
Prefix on spell name.
Will only use the spell if it's not already active.
Can also be used with other spells as shorthand for nomybuff
? /use ?[equipped:Swords]
/cast ?Presence of Mind
Prevents the icon and tooltip from showing.
Must be the first character.
~ ~Slow Fall Prefix on spell name. Acts as a toggle ability.
Will cast or cancel the buff/aura if possible.

Key Modifiers

Conditional Syntax Examples Multi Noable Tests For
mod [mod]
[mod:ctrl/alt/shift]
* * If any mod key is pressed.
If one of the listed modifier keys are pressed.

Player Only

Conditional Syntax Examples Multi Noable Tests For
cdgcd [cdgcd]
[cdgcd:"Name"]
[cdgcd:"Name">X]
* * If the Spell or Item is on cooldown and optionally if the amount of time left is >= or <= than X seconds. GCD NOT IGNORED
channeled [channeled] If the player is currently channeling a spell.
combat [combat] * If the player is in combat.
combo [combo:>#3]
[combo:#2]
[combo:<#5]
* If the player has the specified number of combo points.
cooldown [cooldown]
[cooldown:"Name"]
[cooldown:"Name"<X]
* * If the Spell or Item name is on cooldown and optionally if the amount of time left is >= or <= than X seconds. GCD (if exatly 1.5 sec) IGNORED
equipped [equipped:"Name"]
[equipped:Shields]
[equipped:Daggers2]
* * If the player has an item name/id or item type equipped. See below for a list of valid Weapon Types.
form [form:0/1/2/3/4/5] * Alias of stance
group [group]
[group:party/raid]
* * If the player is in any group or specific group type.
known [known]
[known:"Name"]
[known:"Name">#2]
* * If the player knows a spell or talent. Can optionally check the rank.
mybuff [mybuff]
[mybuff:"Name"]
[mybuff:"Name">#X]
[mybuff:<X]
* If the player has a buff of the given name.
Optionally compared to X number of stacks.
Optionally compared to X time remaining.
mydebuff [mydebuff]
[mydebuff:"Name"]
[mydebuff:"Name">#X]
[mydebuff:<X]
* If the player has a debuff of the given name.
Optionally compared to X number of stacks.
Optionally compared to X time remaining.
myhp [myhp:<=X]
[myhp:>=X/<=Y]
* The player's health PERCENT compared to X.
myhplost [myhplost:>=X]
[myhplost:>=X/<=Y]
* The player's lost health compared to X.
mypower [mypower:>=X]
[mypower:>=X/<=Y]
* The player's power (mana/rage/energy) PERCENT compared to X.
mypowerlost [mypowerlost:>=X]
[mypowerlost:>=X/<=Y]
* The player's lost power (mana/rage/energy) compared to X.
myrawhp [myrawhp:>=X]
[myrawhp:>=X/<=Y]
* The player's health compared to X.
myrawpower [myrawpower:>=X]
[myrawpower:>=X/<=Y]
* The player's power (mana/rage/energy) compared to X.
reactive [reactive]
[reactive:Overpower]
* If the player has the reactive ability (Revenge, Overpower, Riposte, etc.) available to use.

NOTE: Currently requires the reactive ability to be somewhere on your actionbars in addition to any macros you're using it in. A planned future update will remove this requirement if using Nampower.
resting [resting] * If the player is resting (in an inn/capital city/etc.)
stance [stance:0/1/2/3/4/5] * If the player is in stance #.
Supports Shadowform and Stealth as stance 1.
stealth [stealth] * If the player is in Stealth or Prowl.
zone [zone:"Zone"]
[zone:"Zone"/"Another Zone"]
* * If the player is in one or more zones of the given name.

Unit Based

The default @unitid is usually @target if you don't specify one

Conditional Syntax Multi Noable Tests For
alive [alive] If the @unitid is NOT dead or a ghost.
buff [buff]
[buff:"Name"]
[buff:"Name">#X]
[buff:"Name"<X]
* If the @unitid has a buff of the given name and optionally if it has >= or <= than X number of stacks.
casting [casting]
[casting:"Spell Name"]
* * If the @unitid is casting any or one or more specific spells.
dead [dead] If the @unitid is dead or a ghost.
debuff [debuff]
[debuff:"Name"]
[debuff:"Name">#X]
[debuff:<X]
* If the @unitid has a debuff of the given name and optionally if it has >= or <= than X number of stacks.
harm [harm] If the @unitid is an enemy.
help [help] If the @unitid is friendly.
hp [hp:>=X]
[hp:>=X/<=Y]
The @unitid health PERCENT compared to X.
hplost [hplost:>=X]
[hplost:>=X/<=Y]
The @unitid health lost compared to X.
inrange [inrange]
[inrange:"Name"]
* * If the specified @unitid is in range of the spell.
isnpc [isnpc:unitid] * If the unitid is an npc.
See this article for a list of unitids.
Not all units are valid in vanilla.
isplayer [isplayer:unitid] * If the unitid is a player.
See this article for a list of unitids.
Not all units are valid in vanilla.
member [member] * If the @unitid is in your party OR raid.
party [party] * If the @unitid is in your party.
power [power:>=X]
[power:>=X/<=Y]
The @unitid power (mana/rage/energy) PERCENT compared to X.
powerlost [powerlost:>=X]
[powerlost:>=X/<=Y]
The @unitid power (mana/rage/energy) lost compared to X.
raid [raid] * If the @unitid is in your raid.
rawphp [rawhp:>=X]
[rawhp:>=X/<=Y]
The @unitid health compared to X.
rawpower [rawpower:>=X]
[rawpower:>=X/<=Y]
The @unitid power (mana/rage/energy) compared to X.
type [type:"Creature Type"] * * If the @unitid is the specified creature type. See below for a list of valid Creature Types.
targeting [targeting:unitid] * * If the @unitid is targeting the specified unitid.
See this article for a list of unitids.
Not all units are valid in vanilla.

Weapon Types

Name Slot
Axes, Axes2 Main Hand, Off Hand
Bows Ranged
Daggers, Daggers2 Main Hand, Off Hand
Crossbows Ranged
Fists, Fists2 Main Hand, Off Hand
Guns Ranged
Maces, Maces2 Main Hand, Off Hand
Polearms Main Hand
Shields Off Hand
Staves Main Hand
Swords, Swords2 Main Hand, Off Hand
Thrown Ranged
Wands Ranged

Creature Types

Name
Boss
Worldboss
Beast
Dragonkin
Demon
Elemental
Giant
Undead
Humanoid
Critter
Mechanical
Not specified
Totem
Non-combat Pet
Gas Cloud

Reactive Spells (twow)

Name
Revenge
Overpower
Riposte
Mongoose Bite
Counterattack
Arcane Surge

Compatibility

Compatibility should be the same as the original CleverMacro and Roid-Macros however I have not fully tested that.

UnitFrames

  • agUnitFrames
  • Blizzard's UnitFrames
  • CT_RaidAssist
  • CT_UnitFrames
  • DiscordUnitFrames
  • FocusFrame
  • Grid
  • LunaUnitFrames
  • NotGrid
  • PerfectRaid
  • pfUI
  • sRaidFrames
  • UnitFramesImproved_Vanilla
  • XPerl

Action Bars

  • Blizzard's Action Bars
  • Bongos
  • Discord Action Bars
  • pfUI

Supported Addons

  • ClassicFocus / FocusFrame
  • SuperMacro
  • ShaguTweaks

HealComm Support

This addon uses SuperWoW's CastSpellByName which is not compatible with the standard HealComm-1.0 library. MarcelineVQ has an updated version of LunaUnitFrames where they added SuperWoW support to the HealComm-1.0 library. If you use SuperWoW and want proper HealComm support with your macros, you need to do one or both of the following:

  • Contact the author of whichever addon and ask that they update their HealComm to support SuperWoW and link them to MarcelineVQ's updated LunaUnitFrames.

  • Manually update any addon that is using the HealComm-1.0 library by deleting the HealComm-1.0 folder and replacing it with the libs/HealComm-1.0 folder from MarcelineVQ's version of LunaUnitFrames.

Example for the standalone HealComm addon:

  1. Exit WoW completely.
  2. Download a copy of the updated LunaUnitFrames.
  3. Delete the /Interface/AddOns/HealComm/libs/HealComm-1.0 folder.
  4. From the LunaUnitFrames download, copy the /libs/HealComm-1.0 folder into your /Interface/AddOns/HealComm/libs/ folder.

Original Addons & Authors


License

MIT

About

Use more advanced and modern style macros with World of Warcraft 1.12.1

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages