• The project current goal is to support Season of Mastery Classic, Burning Crusade Classic, Wrath of the Lich King Classic

• Addon: Modified Happy-Pixels to read the game state.

• Frontend: ASP.NET Core Razor components.

• BlazorServer: ASP.NET Core Blazor to show the state in a browser.

• HeadlessServer: Run from CommandLine without Frontend. Requires valid configuration files present next to the executable.

• Backend(Core/Game): written in C#. Screen capture, mouse and keyboard clicking. No memory tampering and DLL injection.

• Further detail about the architecture can be found in Blog post.

• Pathing:

  • World map / Outdoor there are multiple solutions - by default the app attempts to discover the available pathing in the following order:
    • V3 Remote - Out of process AmeisenNavigation
    • V1 Remote - Out of process PathingAPI.
    • V1 Local - In process PPather.
  • Indoors pathfinder only works properly if PathFilename is exists.
  • Dungeons / instances not yet supported.

• Game fullscreen or windowed mode
• Limited Background mode support with GDIBlit reader.
• Addon supports all available client languages
• Most of the classes should work. Some classes have more support than others.
• Highly configurable Combat rotation described in Class Configuration
• Utilizing the Actionbar related APIs to retrieve ActionbarSlot(usable, cost)
• One click to populate Actionbar based on Class Configuration
• Pathfinder in the current zone to the grind location
• Grind mobs in the described PathFilename
• Blacklist certain NPCs
• Loot and GatherCorpse (Skin, Herb, Mine, Salvage)
• Vendor goods
• Repair equipments
• Corpse run
• Semi automated gathering mode

Create an issue with the given template.

You are welcome to create pull requests. Some ideas of things that could be improved:

• This readme
• More route and class profiles

• Frontend Runtime Class Profile picker
• Frontend Runtime Path Profile autocomplete search
• Frontend Dark mode
• Improved Loot Goal
• Added Skinning Goal -> GatherCorpse (Skin, Herb, Mine, Salvage)
• Introduced a concept of Produce/Consume corpses. Killing multiple enemies in a single combat, can consume them all.
• ActionbarPopulator based on Class Configuration
• DataConfig: change where the external data(DBC, MPQ, profiles) can be found
• Edit the loaded profile from frontend
• NPCNameFinder: extended to friendly/neutral units
• Remap essential keybindings and support more Actionbar slots up to 34
• Added a new input system to handle modifier keys
• Support more 4:3 aspect ratio based resolution
• Addon is rewritten/reorganized with performance in mind(caching and reduce cell paint) to achieve game refresh rate speed

Put the contents of the repo into a folder. e.g C:\WowClassicGrindBot. I am going to refer to this folder from now on, so just substitute your own folder path.

Download the MPQ route files.

These files are required in order to start the application!

• Classic: common-2.MPQ (1.7Gb)
• TBC: expansion.MPQ (1.8Gb)
• WOTLK: lichking.MPQ (2.5Gb)

Copy the previously mentioned files under \Json\MPQ folder (e.g. C:\WowClassicGrindBot\Json\MPQ)

Download the navmesh files.

• Vanilla + TBC
• Vanilla + TBC + Wrath

1. Extract and copy anywhere you want. like C:\mmaps
2. Create a build of AmeisenNavigation
3. Navigate to the build location and find config.cfg
4. Edit the file last line to look as sMmapsPath=C:\mmaps

Resolutions which based on either 4:3 aspect ratio, tested resolutions:

• 1024 x 768
• 1920 x 1080
• 3840 x 2160

For Nvidia users, under Nvidia Control panel settings

• Make sure the Image Sharpening under the Manage 3D Settings-> Global settings or Program Settings(for WoW) is set to Sharpening Off, Scaling disabled!

Known issues with other applications:

• f.lux can affect final image color on the screen thus prevents NpcNameFinder to work properly.

Required game client settings. Press ESC -> System

• System > Graphics > Anti-Aliasing: None
• System > Advanced > Contrast: 50
• System > Advanced > Brightness: 50
• System > Advanced > Gamma from: 1.0
• System > Render Scale: 100%
• Disable Glow effect - type in the chat /console ffxGlow 0
• To keep/save this settings make sure to properly shutdown the game.

Highly recommended to replace the default in-game font with a much Bolder one with this guide

Should be only concerned about Friz Quadrata: the "Everything Else" Font which is the FRIZQT__.ttf named file.

Example - Robot-Medium - Shows big improvement to the NpcNameFinder component which is responsible to find - friendly, enemy, corpse - names above NPCs head.

• Windows 10 and above
• .NET 7.0 SDK
• AnyCPU, x86 and x64 build supported.

One of the following IDE or command line

• Visual Studio
• Visual Studio Code
• Powershell

e.g. Build from Powershell

cd C:\WowClassicGrindBot
dotnet build -c Release

The app reads the game state using small blocks of color shown at the top of the screen by an Addon. This needs to be configured.

1. Edit the batch script in C:\WowClassicGrindBot\BlazorServer called run.bat, change it to point at where you have put the repo BlazorServer folder

   e.g.

   start "C:\Program Files (x86)\Google\Chrome\Application\chrome.exe" "http://localhost:5000"
   c:
   cd C:\WowClassicGrindBot\BlazorServer
   dotnet run --configuration Release
   pause

2. Execute the run.bat. This will start the bot and Chrome, Wow must be already running. If you get "Unable to find the Wow process is it running ?" in the console window then it can't find exe.

3. When running the BlazorServer for the first time you will have to follow a setup process:

   • Start the game and login with a character
   • Navigate to 2. Addon Configuration
   • Fill the Author input form
   • Fill the Title input form
   • Then press Save button -> Log should see AddonConfigurator.Install successful
   • Should see a loading screen
   • At the top left corner of the game window should see flashing pixels / cells
   • Navigate to 5. Frame Configuration Guidance for good DataFrame
   • Click on Auto -> Start Validate FrameConfiguration

4. Addon Control panel Status is Update Available

   • Press Save button
   • Should see a loading screen
   • Restart the BlazorServer
   • Complete 5. Frame Configuration steps again
   • Click on Auto -> Start Validate FrameConfiguration

Similar to BlazorServer project, except without Frontend. Should consume less system resources in general.

While the bot is running there's no way to adjust / tweak the values. In order to take effect, have to restart.

Everything has to be setup inside the Class Configuration file, in prior.

A successful Configuration process has a result of a following configuration files

• data_config.json
• addon_config.json
• frame_config.json

In order to run HeadlessServer please look at the HeadlessServer\run.bat.

Required cli parameter: relative Class Configuration file name under the ./Json/class/ folder.

Optional cli parameters:

e.g. run from Powershell without any optional parameter

cd C:\WowClassicGrindBot\HeadlessServer
.\run.bat Hunter_1.json

e.g. run from Powershell optional parameters, using DXGI reader and forced Local pathfinder.

cd C:\WowClassicGrindBot\HeadlessServer
.\run.bat Hunter_1.json -m Local -r DXGI

Need to make sure that certain interface options are set. The most important are Click-to-Move and Do Not Flash Screen at Low Health.

From the main menu (ESC) set the following under Interface Options:

From the main menu (ESC) -> Key Bindings set the following:

Movement Keys:

To change the default movement keys to WASD in the Class Configuration file or look at the example Json\class\Warrior_1_MovementKeys.json

"ForwardKey": 87,   // W
"BackwardKey": 83,  // S
"TurnLeftKey": 65,  // A
"TurnRightKey": 68, // D

Targeting:

The default class profiles assumes the following Keybinds setup while using English Keyboard layout. In total, 34 customizable key can be configured.

Highly recommended to use the default setup, in order to get properly working the ActionBarSlotCost and ActionBarSlotUsable features!

Bindpad allows keys to be easily bound to commands and macros. Type /bindpad to show it.

For each of the following click + to add a new key binding.

Each class has a configuration file in \Json\class e.g. the config for a Warrior it is in file Warrior_1.json.

The configuration file determines what spells the character casts, when pulling and in combat, where to vendor and repair and what buffs consider.

Take a look at the class files in /Json/class for examples of what you can do. Your class file probably exists and just needs to be edited to set the pathing file name.

Based of UnitClassification API.

Valid Values: "Normal", "Trivial", "Minus", "Rare", "Elite", "RareElite", "WorldBoss"

The mentioned values can be combined together like:

e.g.

"TargetMask": "Normal, Trivial, Rare, Elite, RareElite",

Where Elite and RareElite has been included compare to default.

By Default, the bot attempts to use the mouse for the following reasons:

• (during Follow Route) Target selection
• (during Consume Corpse) "Loot"
• (during Consume Corpse) GatherCorpse("Skin", "Herb", "Mine", "Salvage")

You can disable this behaviour by setting KeyboardOnly to true. Which has the following effects:

• "Loot" limited, only capable of looting by selecting last target. So after each combat only the last npc can be looted.
• GatherCorpse("Skin", "Herb", "Mine", "Salvage") unavailable.
• Target selection limited to only TargetNearestTargetKey, which significantly reduce how quickly can find the next target.

Gives the ability to the user to define global integer variables along the whole Class Configuration scope.

For example look at the Warlock profiles.

"IntVariables": {
    "DOT_MIN_HEALTH%": 35,
    "Debuff_Frost Fever": 237522,   // iconId https://www.wowhead.com/icons
    "Debuff_Blood Plague": 237514,  // iconId https://www.wowhead.com/icons
}

The path that the class follows is a json file in /Json/path/ which contains a list of x & y coordinates the bot will traverse while looking for mobs.

"PathFilename": "58_Winterspring.2.json",   // the path to walk when alive
"PathThereAndBack": true,                   // if true walks the path and the walks it backwards.
"PathReduceSteps": true,                    // uses every other coordinate.

Each KeyAction has its own properties to describe what the action is all about.

Can specify conditions with Requirement(s) in order to create a matching action for the situation.

Some of these properties are optional and not required to be specified.

However you can create complex conditions and branches to suit the situation.

Important, the AfterCast prefixed conditions order as is its shows up the the table above.

e.g. - bare minimum for a spell which has castbar.

{
    "Name": "Frostbolt",
    "Key": "1",
    "HasCastBar": true,   //<-- Must be indicated the spell has a castbar
}

e.g. - bare minimum for a spell which is instant (no castbar)

{
    "Name": "Earth Shock",
    "Key": "6"
}

e.g. for Rogue ability

{
    "Name": "Slice and Dice",
    "Key": "3",
    "Requirements": [
        "!Slice and Dice",
        "Combo Point > 1"
    ]
}

Theres are few specially named KeyAction such as Food and Drink which is reserved for eating and drinking.

They already have some pre baked Requirement(s) conditions in order to avoid mistype the definition.

The bare minimum for Food and Drink is looks something like this.

{
    "Name": "Food",
    "Key": "-",
    "Requirement": "Health% < 50"
},
{
    "Name": "Drink",
    "Key": "=",
    "Requirement": "Mana% < 50"
}

When any of these KeyAction(s) detected, by default, it going to be awaited with a predefined Wait Goal logic.

Should see something like this, you can override any of the following values.

"Wait": {
    "AutoGenerateWaitForFoodAndDrink": true,    // should generate 'Eating' and 'Drinking' KeyActions
    "FoodDrinkCost": 5,                         // can override the Cost of awaiting Eating and Drinking
    "Sequence": {
    {
        "Name": "Eating",
        "Cost": 5,                              // FoodDrinkCost
        "Requirement": "Food && Health% < 99"
    },
    {
        "Name": "Drinking",
        "Cost": 5,                              // FoodDrinkCost
        "Requirement": "Drink && Mana% < 99"
    },
    }
},

CastingHandler is a component which responsible for handling player spell casting, let it be using an item from the inventory, casting an instant spell or casting a spell which has castbar.

From Addon version 1.6.0 it has been significantly changed to the point where it no longer blocks the execution until the castbar fully finishes, but rather gives back the control to the parent Goal such as Adhoc Goals or Pull Goal or Combat Goal to give more time to find the best suitable action for the given moment.

As a result in order to execute the Pull Goal sequence in respect, have to combine its KeyAction(s) with AfterCast prefixed conditions.

This is the Sequence of KeyAction(s) that are used when pulling a mob.

e.g.

"Pull": {
    "Sequence": [
        {
            "Name": "Concussive Shot",
            "Key": "9",
            "BeforeCastStop": true,
            "Requirements": [
                "HasRangedWeapon",
                "!InMeleeRange",
                "HasAmmo"
            ]
        }
    ]
}

The Sequence of KeyAction(s) that are used while the AssistFocus Mode is active.

Upon any keyAction's requirement are met, the Assist Focus Goal is become active.

Upon entering Assist Focus Goal, the player attempts to target the focus/party1.

Then as defined, in-order, executes those KeyAction(s) which fulfills its given requirement(s).

Upon exiting Assist Focus Goal, the current target will be deselected / cleared.

Note: You can use every Buff and Debuff names on the focus/party1 without being targeted.

Just have to prefix it with F_ example: F_Mark of the Wild which means focus/party1 has Mark of the Wild buff active.

e.g. of a Balance Druid

"AssistFocus": {
    "Sequence": [
        {
            "Name": "Mark of the Wild",
            "Key": "4",
            "Form": "None",
            "Requirements": [
                "!Mounted",
                "!F_Mark of the Wild",
                "SpellInRange:5"
            ]
        },
        {
            "Name": "Thorns",
            "Key": "7",
            "Form": "None",
            "Requirements": [
                "!Mounted",
                "!F_Thorns",
                "SpellInRange:8"
            ]
        },
        {
            "Name": "Regrowth",
            "Key": "0",
            "HasCastBar": true,
            "WhenUsable": true,
            "AfterCastAuraExpected": true,
            "Requirements": [
                "!Mounted",
                "!F_Regrowth",
                "FocusHealth% < 65",
                "SpellInRange:6"
            ],
            "Form": "None"
        },
        {
            "Name": "Rejuvenation",
            "Key": "6",
            "BeforeCastStop": true,
            "AfterCastWaitBuff": true,
            "Requirements": [
                "!Mounted",
                "!F_Rejuvenation",
                "FocusHealth% < 75",
                "SpellInRange:7"
            ],
            "Form": "None"
        }
    ]
},

The Sequence of KeyAction(s) that are used when in combat and trying to kill a mob.

The combat goal does the first available command on the list.

The goal then runs again re-evaluating the list before choosing the first available command again, and so on until the mob is dead.

e.g.

"Combat": {
    "Sequence": [
        {
            "Name": "Fireball",
            "Key": "2",
            "HasCastBar": true,
            "Requirement": "TargetHealth% > 20"
        },
        {
            "Name": "AutoAttack",
            "Requirement": "!AutoAttacking"
        },
        {
            "Name": "Approach",
            "Log": false
        }
    ]
}

These Sequence of KeyAction(s) are done when not in combat and are not on cooldown. Suitable for personal buffs.

e.g.

"Adhoc": {
    "Sequence": [
        {
            "Name": "Frost Armor",
            "Key": "3",
            "Requirement": "!Frost Armor"
        },
        {
            "Name": "Food",
            "Key": "=",
            "Requirement": "Health% < 30"
        },
        {
            "Name": "Drink",
            "Key": "-",
            "Requirement": "Mana% < 30"
        }
    ]
}

These Sequence of KeyAction(s) are done when not in combat and are not on cooldown.

The key presses happens simultaneously on all KeyAction(s) which meets the Requirement(s).

Suitable for Food and Drink.

e.g.

"Parallel": {
    "Sequence": [
        {
            "Name": "Food",
            "Key": "=",
            "Requirement": "Health% < 50"
        },
        {
            "Name": "Drink",
            "Key": "-",
            "Requirement": "Mana% < 50"
        }
    ]
}

These actions cause to wait while the Requirement(s) are met, during this time the player going to be idle, until lowered cost action can be executed.

e.g.

"Wait": {
    "Sequence": [
    {
        "Cost": 19,
        "Name": "HP regen",
        "Requirements": [
            "FoodCount == 0 || !Usable:Food",
            "Health% < 90"
        ]
    }
    ]
},

These command are for vendoring and repair.

e.g.

"NPC": {
    "Sequence": [
    {
        "Name": "Repair",
        "Key": "C",
        "Requirement": "Items Broken",
        "PathFilename": "Tanaris_GadgetzanKrinkleGoodsteel.json",
        "Cost": 6
    },
    {
        "Name": "Sell",
        "Key": "C",
        "Requirement": "BagFull",
        "PathFilename": "Tanaris_GadgetzanKrinkleGoodsteel.json",
        "Cost": 6
    }
    ]
}

The "Key" is a key that is bound to a macro. The macro needs to target the NPC, and if necessary open up the repair or vendor page. The bot will click the key and the npc will be targetted. Then it will click the interact button which will cause the bot to move to the NPC and open the NPC options, this may be enough to get the auto repair and auto sell greys to happen. But the bot will click the button again in case there are further steps (e.g. SelectGossipOption), or you have many greys or items to sell.

e.g. Sell macro - bound to the "C" key using BindPad or Key bindings

/tar Jannos Ironwill
/run DataToColor:sell({"Light Leather","Cheese","Light Feather"});

e.g. Repair macro

/tar Vargus
/script SelectGossipOption(1)

e.g. Delete various items

/run for b=0,4 do for s=1,GetContainerNumSlots(b) do local n=GetContainerItemLink(b,s) if n and (strfind(n,"Slimy") or strfind(n,"Red Wolf") or strfind(n,"Mystery") or strfind(n,"Spider L")) then PickupContainerItem(b,s) DeleteCursorItem() end end end

Because some NPCs are hard to reach, there is the option to add a short path to them e.g. "Tanaris_GadgetzanKrinkleGoodsteel.json". The idea is that the start of the path is easy to get to and is a short distance from the NPC, you record a path from the easy to reach spot to the NPC with a distance between spots of 1. When the bot needs to vend or repair it will path to the first spot in the list, then walk closely through the rest of the spots, once they are walked it will press the defined Key, then walk back through the path.

e.g. Tanaris_GadgetzanKrinkleGoodsteel.json in the Json/path folder looks like this:

[{"X":51.477,"Y":29.347},{"X":51.486,"Y":29.308},{"X":51.495,"Y":29.266},{"X":51.503,"Y":29.23},{"X":51.513,"Y":29.186},{"X":51.522,"Y":29.147},{"X":51.531,"Y":29.104},{"X":51.54,"Y":29.063},{"X":51.551,"Y":29.017},{"X":51.559,"Y":28.974},{"X":51.568,"Y":28.93},{"X":51.578,"Y":28.889},{"X":51.587,"Y":28.853},{"X":51.597,"Y":28.808}]

If you have an NPC that is easy to get to such as the repair NPC in Arathi Highlands then the path only needs to have one spot in it. e.g.

[{"X":45.8,"Y":46.6}]

Short Path Example:

In theory if there is a repeatable quest to collect items, you could set up a NPC task as follows. See 'Bag requirements' for Requirement(s) format.

{
    "Name": "Handin",
    "Key": "K",
    "Requirements": ["BagItem:12622:5","BagItem:12623:5"],
    "PathFilename": "Path_to_NPC.json",
    "Cost": 6
}

A requirement is something that must be evaluated to be true for the KeyAction to run.

Not all KeyAction requires requirement(s), some rely on

• Cooldown - populated manually
• ActionBarCooldownReader - populated automatically
• ActionBarCostReader - populated automatically including (MinMana, MinRage, MinEnergy, MinRunicPower, MinRuneBlood, MinRuneFrost, MinRuneUnholy)

Can specify Requirements for complex condition.

e.g.

{
    "Name": "Execute",                                            //<--- Has no Requirement
    "Key": "7",
    "WhenUsable": true
},
{
    "Name": "Soul Shard",
    "Key": "9",
    "HasCastBar": true,
    "Requirements": ["TargetHealth% < 36", "!BagItem:6265:3"]     //<--- Requirement List
},
{
    "Name": "Curse of Weakness",
    "Key": "6",
    "WhenUsable": true,
    "Requirement": "!Curse of Weakness"                           //<--- Single Requirement
}

Every requirement can be negated by adding one of the Negate keyword in front of the requirement.

Formula: [Negate keyword][requirement]

e.g.

"Requirement": "not Curse of Weakness"
"Requirement": "!BagItem:Item_Soul_Shard:3"

Two or more Requirement can be merged into a single Requirement object.

By default every Requirement is concataneted with [and] operator which means in order to execute the KeyAction, every member in the RequirementsObject must be evaluated to true. However this consctruct allows to concatanete with [or]. Nesting parenthesis are also supported.

Formula: [Requirement1] [Operator] [RequirementN]

e.g.

"Requirements": ["Has Pet", "TargetHealth% < 70 || TargetCastingSpell"]
"Requirement": "!Form:Druid_Bear && Health% < 50 || MobCount > 2",
"Requirement": "(Judgement of the Crusader && CD_Judgement <= GCD && TargetHealth% > 20) || TargetCastingSpell"

Value base requirement is the most basic way to create a condition.

Formula: [Keyword] [Operator] [Numeric integer value]

Note: [Numeric integer value] always the right-hand side expression value

For the MinRange and MaxRange gives an approximation range distance between the player and target.

Note: Every class has it own unique way to find these values by using different in game items/spells/interact.

Its worth mention that CD_{KeyAction.Name} is a dynamic value.
Each KeyAction has its own in-game Cooldown which is not the same as KeyAction.Cooldown!

e.g. Single Requirement

"Requirement": "Health%>70"
"Requirement": "TargetHealth%<=10"
"Requirement": "PetHealth% < 10"
"Requirement": "Mana% <= 40"
"Requirement": "Mana < 420"
"Requirement": "Energy >= 40"
"Requirement": "Rage > 90"
"Requirement": "BagCount > 80"
"Requirement": "MobCount > 1"
"Requirement": "MinRange < 5"
"Requirement": "MinRange > 15"
"Requirement": "MaxRange > 20"
"Requirement": "MaxRange > 35"
"Requirement": "LastAutoShotMs <= 500"
"Requirement": "LastMainHandMs <= 500"
"Requirement": "CD_Judgement < GCD"                 // The remaining cooldown on Judgement is less then GCD(1500)
"Requirement": "CD_Hammer of Justice > CD_Judgement" // The remaining cooldown on Hammer of Justice is greater then 8 seconds
"Requirement": "Rage >= Cost_Heroic Strike"          // Create a condition like if player current rage is greater then or equal the cost of Heroic Strike
"Requirement": "MainHandSpeed > 3500"   // Main hand attack speed is greater then 3.5 seconds
"Requirement": "MainHandSwing > -400"   // 400 milliseconds before next predicted main swing happen
"Requirement": "MainHandSwing > -400"   // 400 milliseconds before next predicted main swing happen
"Requirement": "Dead && Deaths % 2"   // Player is currently dead and died for the second time in the current session

e.g. List of Requirements

"Requirements": [
    "TargetHealth% > DOT_MIN_HEALTH%",  // where DOT_MIN_HEALTH% is a user defined variable
    "!Immolate"
],

e.g. for CD: It's a good idea to put CD in healing spells to take consideration of the spell interruption.

{
    "Name": "Flash of Light",
    "Key": "6",
    "HasCastBar": true,
    "WhenUsable": true,
    "Requirements": ["Health% < 60", "TargetHealth% > 20", "CD == 0", "MobCount < 2", "LastMainHandMs <= 1000"],
    "Cooldown": 6000
},

e.g. for CD_{KeyAction.Name}: Where Hammer of Justice referencing the Judgement in-game Cooldown to do an awesome combo!

{
    "Name": "Judgement",
    "Key": "1",
    "WhenUsable": true,
    "Requirements": ["Seal of the Crusader", "!Judgement of the Crusader"]
},
{
    "Name": "Hammer of Justice",
    "Key": "7",
    "WhenUsable": true,
    "Requirements": ["Judgement of the Crusader && CD_Judgement <= GCD && TargetHealth% > 20 || TargetCastingSpell"]
}

If a particular npc is required then this requirement can be used.

Formula: npcID:[intVariableKey/Numeric integer value]

e.g.

• "Requirement": "!npcID:6195" - target is not 6195
• "Requirement": "npcID:6195" - target is 6195
• "Requirement": "npcID:MyAwesomeIntVariable"

If an itemid must be in your bag with given count quantity then can use this requirement.

Useful to determine when to create warlock Healthstone or soul shards.

Formula: BagItem:[intVariableKey/itemid]:[count]

e.g.

• "Requirement": "BagItem:5175" - Must have a Earth Totem in bag
• "Requirement": "BagItem:Item_Soul_Shard:3" - Must have atleast 3x Soulshard in bag
• "Requirement": "not BagItem:19007:1" - Must not have a Lesser Healthstone in bag
• "Requirement": "!BagItem:6265:3" - Must not have 3x Soulshard in bag
• "Requirement": "!BagItem:MyAwesomeIntVariable:69"

If the player must be in the specified form use this requirement.

Useful to determine when to switch Form for the given situation.

Formula: Form:[form]

e.g.

"Requirement": "Form:Druid_Bear"    // Must be in `Druid_Bear` form
"Requirement": "!Form:Druid_Cat"    // Shoudn't be in `Druid_Cat` form

If the character must be the specified race use this requirement.

Useful to determine Racial abilities.

Formula: Race:[race]

e.g.

"Requirement": "Race:Orc"          // Must be `Orc` race
"Requirement": "!Race:Human"    // Shoudn't be `Human` race

If a given Spell name or id must be known by the player then you can use this requirement.

Useful to determine when the given Spell is exists in the spellbook.

It has the following formulas:

• Spell:[name]. The name only works with the English client name.
• Spell:[id]

e.g.

• "Requirement": "Spell:687" - Must have know id=687
• "Requirement": "Spell:Demon Skin" - Must have known the given name
• "Requirement": "!Spell:702" - Must not have known the given id=702
• "Requirement": "not Spell:Curse of Weakness" - Must not have known the given name

If a given Talent name must be known by the player then you can use this requirement.

Useful to determine when the given Talent is learned. Also can specify how many points have to be spent minimium with rank.

Formula: Talent:[name]:[rank]. The name only works with the English client name.

e.g.

"Requirement": "Talent:Improved Corruption"    // Must known the given `name`
"Requirement": "Talent:Improved Corruption:5"  // Must know the given `name` and atleast with `rank`
"Requirement": "not Talent:Suppression"        // Must have not know the given `name` 

First in the IntVariables have to mention the buff icon id such as Buff_{your fancy name}: {icon_id}.

It is important, the addon keeps track of the icon_id! Not spell_id

e.g.

"IntVariables": {
    "Buff_Horn of Winter": 134228
},

Then in KeyAction you can use the following requirement:

e.g.

{
    "Cost": 3.1,
    "Name": "Horn of Winter",
    "Key": "F4",
    "InCombat": "i dont care",
    "WhenUsable": true,
    "Requirements": [
        "Buff_Horn of Winter < 5000", // The remaining time is less then 5 seconds
        "!Mounted"
    ],
    "AfterCastWaitBuff": true
}     

First in the IntVariables have to mention the buff icon id such as Debuff_{your fancy name}: {icon_id}

It is important, the addon keeps track of the icon_id! Not spell_id

e.g.

"IntVariables": {
    "Debuff_Blood Plague": 237514,
    "Debuff_Frost Fever": 237522
},

Then in KeyAction you can use the following requirement:

e.g.

{
    "Name": "Pestilenc",
    "Key": "F6",
    "WhenUsable": true,
    "Requirements": [
        "Frost Fever && Blood Plague && (Debuff_Frost Fever < 2000 || Debuff_Blood Plague < 2000)",   // Frost Fever and Blood Plague is up
        "InMeleeRange"                                                                                // and their duration less then 2 seconds
    ]
}

First in the IntVariables have to mention the buff icon id such as TBuff_{your fancy name}: {icon_id}

It is important, the addon keeps track of the icon_id! Not spell_id

e.g.

"IntVariables": {
    "TBuff_Battle Shout": 132333,
},

First in the IntVariables have to mention the buff icon id such as FBuff_{your fancy name}: {icon_id}

It is important, the addon keeps track of the icon_id! Not spell_id

e.g.

"IntVariables": {
    "FBuff_Battle Shout": 132333,
    "FBuff_Mount": 132239
},

If you feel the current Requirement toolset is not enough for you, you can use other addons such as WeakAura's Trigger to control a given bit.

1. The regarding in-game Addon API is looks like this

   YOUR_CHOOSEN_ADDON_NAME_FROM_ADDON_CONFIG:Set(bit, value)
   -- bit: 0-23
   -- value: 0 or 1 or true or false
   
   --e.g. by using default addon name
   DataToColor:Set(0,1)
   DataToColor:Set(0,0)
   DataToColor:Set(23,true)
   DataToColor:Set(23,false)

   e.g. you can make your awesome WeakAura. Then you can put the following Addon API in the

   WeakAura -> Actions -> On Show -> Custom

   DataToColor:Set(0,1) -- enable Trigger 0

   WeakAura -> Actions -> On Hide -> Custom

   DataToColor:Set(0,0)  -- disable Trigger 0

   Example Weakaura for hunter pet in 10y range for feed pet

   !WA:2!1rvWUTTrq0O6dPGOiXXT1afTaLWT1ibTiW2fnfOO9GOmvScKTuiPJtApqUK7qXnMC3f7Uu2khf6HCwFc6CpXpH8fqi0Va)j4VGUlPQHBrIoioZUZS78EZ82o93Qyl8w43(DcwPkNqbXOtdgo4exXLJstLGQtfMi55OzbWLQpALmdHzx8Q29(Q7uHOjzmXygHQI75EsGRh3(wjeMYefivipurkG1ED4BMukvScteNYXif4btbQ6kuPEvKIKCgbRYC6QDfOefHrLpXtQqc1UlWSW2SJIB)Y)SdrkuaRhlNj(fFq9W9(H9FKdHsuBxF)S4uTLmB367hvV57l29E0CLGmzciK3BxXAZ3(1ZjkO4eub05kzzCt9nwaPKl98h7oC41LsiSaKs0eiyghIENzH)nNi(dmUtanHss8ZyxmIgT6)4ELS5tpglxZO05M4l11CKJ5)d4GYtGOtGD2FVQMJMovxHqwtGzikoAHKd55nLOJsxc12x1KriJdcKM625x)TLyiUmn1uHIJChoU)Pdx0Gftc8pF8WUVY1l0Z9PUNeE4a)UodDpCL5gsB59bhgDd891he5YQWED9dc9d66f0e5nhxuScLRTTCm9zRARkpt5y3ldsoVHEIHm0uctKTsaOC)Bk)MZ5g0enVXCawATWSrdOIQUfHN5r1XTEBLEe58OQB1l4B27OUbHh7)0WZoAGUD5TOKUUXAXFGbztHGw)Jzy4VUd)lFVdTTgEMzx816rCqqr5Vq3g0mZFSqc5PTt(oJccgDSg2ufFZ(cYBSFEjcR7bi7GGLA(ZdMygITCYzi8lAk7KCKugvV32EfL5kILJg0jBxpWYRzNDJLe6KCi(OtnQk96osYBataZn3JV25lwlhFzRCCJLIMRXqboknqwMWOysJ8XI)nFyzjxajedM2yLwbQ1ZJ4TjjMT(raXR1sns6m94r)GLkwY0ws4JhV9oem)BZknKJTEO1MqT3FVz2nnnB99yNca2SZbLeCL354H)0lF4Zrf)EvQq3e9vgAAJRBFiPVzjt9h73ZZ19eVeJq9zBO)fRbtkzI18lyc8zceF(zRn4F)hgA4z6jfssOktaAbxoEwvlN18cWZ60PZgl1d1aU5fN)8tQi02dqdoRfikP18j13RF9UougfEhGKMQgOtuz3DfUu0erOrbO1Ngkxo3eJbg1eNceHQZTMu)67wFEDEDH28t))RSL07hF8p)4d2A6F)Y)5

2. Then outside of the game, you can specify the following in the Class Configuration file ex. class/Hunter_62.json

   Formula: Trigger:[bit]:[name]

   Where the bit is 0-23 and the name is a free text which shows up in the frontend.

   e.g.

   "Requirement": "Trigger:0:Pet in range"           // Trigger 0 must be true
   "Requirement": "Trigger:23:My Awesome trigger"    // Trigger 23 must be true
   "Requirement": "not Trigger:6:Suppression"        // Trigger 6 must be false

Allow requirements about what buffs/debuffs you have or the target has or in general some boolean based requirements.

e.g.

"Requirement": "!Well Fed"      // I am not well fed.
"Requirement": "not Thorns"        // I don't have the thorns buff.
"Requirement": "AutoAttacking"     // "Auto Attack" spell is active.
"Requirement": "Shooting"          // "Shoot" spell is active.
"Requirement": "Items Broken"      // Some of my armor is broken (red).
"Requirement": "BagFull"           // Inventory is full.
"Requirement": "HasRangedWeapon"   // Has an item equipped at the ranged slot.
"Requirement": "InMeleeRange"      // Determines if the target is in melee range (0-5 yard)
"Requirement": "!F_Thorns"         // Focus don't have the thorns buff.
"Requirement": "F_Rejuvenation"    // Focus Has Rejuvenation buff active.

Allow requirements about spell range to be used, the spell in question depends upon the class being played.

"SpellInRange:0" or "not SpellInRange:0" for a Warrior is Charge and for a Mage is Fireball.

This might be useful if you were close enough for a Fireball, but not for a Frostbolt.

Formula: SpellInRange:[Numeric integer value]

Shared CheckInteractDistance API

e.g.

"Requirement": "SpellInRange:4"
"Requirements": ["Health% < 80", "SpellInRange:2"]

Combined with the KeyAction.UseWhenTargetIsCasting property, this requirement can limit on which enemy target spell your character will react or ignore.

Firstly "TargetCastingSpell" as it is without mentioning any spellID. Simply tells if the target is doing any cast at all.

Secondly can specify the following Format "TargetCastingSpell:spellID1,spellID2,..." which translates to "if Target is casting spellID1 OR spellID2 OR ...".

e.g. Rogue_20.json

{
    "Name": "Kick",
    "UseWhenTargetIsCasting": true
},
{
    "Name": "Kick",
    "Requirement": "not TargetCastingSpell"
},
{
    "Name": "Kick",
    "UseWhenTargetIsCasting": true,
    "Requirement": "TargetCastingSpell:9053,11443"
},
{
    "Name": "Kick",
    "Requirement": "not TargetCastingSpell:11443"
}

Every KeyAction has individual Interrupt(s) condition(s) which are Requirement(s) to stop execution before fully finishing it.

As of now every Goal groups has a default Interrupt.

• Combat Goal based KeyAction(s) interrupted once the target dies and the player loses the target.
• Parallel Goal based KeyAction(s) has No interrupt conditions.
• Adhoc Goals based KeyAction(s) depends on KeyAction.InCombat flag.
• Assist Focus Goal based KeyAction(s) interrupted once the target dies and the player loses the target.

Here's and example for low level Hunters, while playing without a pet companion take advantage of interrupt.

It attempts to step back for a maximum 3000ms duration however this can be interrupted either

• losing the current target
• the next Auto Shot coming in 500ms

This 500ms duration is the reload animation time, while the player has to stay still.

"Combat": {
    "Sequence": [
        //...
        {
        "Name": "Stepback",
        "Key": "S",
        "PressDuration": 3000,
        "BaseAction": true,
        "Requirements": [
            "LastAutoShotMs < 400",
            "!InMeleeRange",
            "AutoShot"
        ],
        "Interrupt": "RangedSwing < -500 && TargetAlive"
        },
        //...
    ]
}

The default mode for the bot is to grind, but there are other modes. The mode is set in the root of the class file.

e.g. Rogue.json

{
    "PathFilename": "Herb_EPL.json",
    "Mode": "AttendedGather",
    "GatherFindKeys":  ["1","2"]
}

The available modes are:

The user interface is shown in a browser on port 5000 http://localhost:5000. This allows you to view it from another device on your lan.

To access you PC port 5000 from another device, you will need to open up port 5000 in your firewall.

Control Panel\System and Security\Windows Defender Firewall - Advanced Settings

• Inbound Rules
• New Rule
• Port
• TCP
• Specific local ports: 5000
• Allow the Connection
• Private, Public, Domain (You may get away with just Private)
• Name "Wow bot"

The UI has the following components:

Show the player state. A hyper link to wowhead appears for the mob you are fighting so you can check out what it drops.

This component shows:

• The main path
• Your location
• The location of any deaths
• Pathed routes

Pathed routes are shown in Green.

This component contains a button to allow the bot to be enabled and disabled.

This displays the finite state machine. The state is goal which can run and has the highest priority. What determines if the goal can run are its pre-conditions such as having a target or being in combat. The executing goal is allowed to complete before the next goal is determined.

Some goals (combat,pull target) contain a list of spells which can be cast. The combat task evaluates its spells in order with the first available being cast. The goal then gives up control so that a higher priority task can take over (e.g. Healing potion).

The visualisation of the pre-conditions and spell requirement(s) makes it easier to understand what the bot is doing and determine if the class file needs to be tweaked.

Various path are needed by the bot:

The path to run when grinding (PathFilename in root of class files).

"PathFilename": "16_LochModan.json",
"PathThereAndBack": true,
"PathReduceSteps": false,

The short path to get to the vendor/repairer when there are obstacles close to them (PathFilename withing NPC task):

{
    "Name": "Sell",
    "Key": "C",
    "Requirement": "BagFull",
    "PathFilename": "Tanaris_GadgetzanKrinkleGoodsteel.json",
    "Cost": 6
}

To record a new path place your character where the start of the path should be, then click on the 'Record Path' option on the left hand side of the bot's browser window. Then click 'Record New'.

Now walk the path the bot should take.

If you make a mistake you can remove spots by clicking on them on the list on the right. Then either enter new values for the spot or click 'Remove'.

For tricky parts you may want to record spots close together by using the 'Distance between spots' slider (Smaller number equals closer together).

Once the path is complete click 'Save'. This path will be saved with a generic filename e.g. Path_20201108112650.json, you will need to go into your /Json/path and rename it to something sensible.

"PathThereAndBack": true

These paths are run from one end to the other and then walked backwards back to the start. So the end does not need to be near the start.

"PathThereAndBack": false

These paths are run from one end to the other and then repeated. So the path needs to join up with itself i.e. the end needs to be near the start.

Try to avoid the path getting too close to:

• Obstactles like trees, houses.
• Steep hills or cliffs (falling off one can make the bot get stuck).
• Camps/groups of mobs.
• Elite mob areas, or solo elite paths.

The best places to grind are:

• Places with non casters i.e. beasts. So that they come to you when agro'd.
• Places where mobs are far apart (so you don't get adds).
• Places with few obstacles.
• Flat ground.

Pathing is built into the bot so you don't need to do anything special except download the MPQ files. You can though run it on its own server to visualise routes as they are created by the bot, or to play with route finding.

The bot will try to calculate a path in the following situations:

• Travelling to a vendor or repair.
• Doing a corpse run.
• Resuming the grind path at startup, after killing a mob, or if the distance to the next stop in the path is not a short distance.

In visual studio just set PathingAPI as the startup project or from the command line:

cd C:\WowClassicGrindBot\PathingAPI
dotnet run --configuration Release

Then in a browser go to http://localhost:5001

There are 3 pages:

• Watch API Calls
• Search
• Swagger

Requests to the API can be done in a new browser tab like this or via the Swagger tab. You can then view the result in the Watch API calls viewer.

http://localhost:5001/api/PPather/MapRoute?map1=1446&x1=51.0&y1=29.3&map2=1446&x2=38.7&y2=20.1

Search gives some predefined locations to search from and to.

In visual studio right click the solution and set Multiple startup projects to BlazorServer and PathingApi and run.

Or from 2 command lines dotnet run each.

cd c:\WowClassicGrindBot\PathingAPI
dotnet run --configuration Release

cd c:\WowClassicGrindBot\BlazorServer
dotnet run --configuration Release

The bot will use the PathingAPI to work out routes, these are shown on the route map as green points.

Warlock heal macro used in warlock profiles.

#showtooltip Create Healthstone
/use Minor Healthstone
/use Lesser Healthstone
/use Healthstone
/use Greater Healthstone
/use Major Healthstone
/use Master Healthstone
/stopmacro [combat]
/cast [nocombat] Create Healthstone

Hunter feedpet macro replace Roasted Quail with the proper diet

#showtooltip
/cast Feed Pet
/use Roasted Quail

Hunter sumpet macro

#showtooltip
/cast [target=pet,dead] Revive Pet
/cast [target=pet,noexists] Call Pet

Rogue weapon enchant (use 17 for second weapon):

#showtooltip
/use Instant Poison V 
/use 16
/click StaticPopup1Button1 

Melee weapon enchant:

#showtooltip
/use Dense Sharpening Stone
/use 16
/click StaticPopup1Button1