Wow Classic Grind Bot

https://github.com/xian55/wowclassicgrindbot
Admin
An automated bot for World of Warcraft Classic that supports grinding, combat rotations,...
Tokens:40,329
Snippets:282
Trust Score:7.7
Update:8 months ago
Show doc for...
Tokens:
Raw
### Run Headless Server - With Options (Batch)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Starts the HeadlessServer with a class configuration file and optional parameters. This example uses the 'Local' pathfinder mode.

```batch
cd C:\WowClassicGrindBot\HeadlessServer
.\run.bat Hunter_1.json -m Local
```

--------------------------------

### Install Headless Server (Batch)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Installs or updates the HeadlessServer. This script should be run after initial project download, cloning, or when significant changes occur, such as a new Addon Version or switching display modes.

```batch
HeadlessServer\install.bat
```

--------------------------------

### Run Headless Server - Basic (Batch)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Starts the HeadlessServer with a specified class configuration file. This is the standard command for quick startup.

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

--------------------------------

### Run Headless Server - Development (Batch)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Starts the HeadlessServer in development mode. This is an alternative to the standard 'run.bat' for quick startup during development.

```batch
HeadlessServer\rundev.bat
```

--------------------------------

### PathingAPI Server Startup (Command Line)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Instructions for starting the PathingAPI server independently using the .NET CLI. This allows for visualization and testing of route-finding capabilities.

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

--------------------------------

### PathingAPI Map Route Request Example

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

An example of a GET request to the PathingAPI to calculate a route between two points on a specific map. This is useful for testing and integration.

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

--------------------------------

### Flee Goal Configuration Examples in JSON

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Provides examples of Flee goal configurations in JSON. This goal allows defining custom rules for the character to flee from encounters deemed unwinnable. It includes sequences for fleeing, crowd control, and using potions, with varying requirements.

```json
{
    "Flee": {
        "Sequence": [
            {
                "Name": "Flee",
                "Requirement": "MobCount > 1 && Health% < 50"
            }
        ]
    }
}
```

```json
{
  "Flee": {
    "Sequence": [
      {
        "Name": "Flee",
        "Requirement": "MobCount > 1" 
      },
      {
        "Name": "Frost Nova",
        "Key": 6,
        "Requirement": "InMeleeRange"
      },
      {
        "Name": "HP Potion",
        "Key": 7,
        "Requirement": "Health% < 50"
      },
      {
        "name": "Blink",
        "Key": "F3",
        "Requirement": "!InMeleeRange"
      }
    ]
  }
}
```

```json
{
  "Flee": {
    "Sequence": [
      {
        "Name": "Flee",
        "Requirement": "MobCount > 1 || TargetElite"
      }
    ]
  }
}
```

--------------------------------

### Running PathingAPI and BlazorServer Simultaneously

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Command-line instructions to run both the PathingAPI and the BlazorServer applications concurrently. This setup is used when the PathingAPI library is integrated directly into the bot.

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

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

--------------------------------

### Run Headless Server - Load Only (Batch)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Starts the HeadlessServer to load a specified class profile and then exits. This is useful for verifying that a profile can be loaded correctly.

```batch
cd C:\WowClassicGrindBot\HeadlessServer
.\run.bat Hunter_1.json -m Local --loadonly
```

--------------------------------

### Sell Macro Example (Lua)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

A Lua macro bound to a key that targets a specific NPC and initiates the selling of specified grey items.

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

--------------------------------

### PathingAPI - Start Navigation Service

Source: https://context7.com/xian55/wowclassicgrindbot/llms.txt

Instructions to start the PathingAPI server, which provides navigation services for route calculation and path visualization. The server runs on http://localhost:5001, with Swagger UI available at http://localhost:5001/swagger.

```powershell
# Start PathingAPI server
cd C:\WowClassicGrindBot\PathingAPI
dotnet run --configuration Release

# Server runs on http://localhost:5001
# Swagger UI available at http://localhost:5001/swagger
```

--------------------------------

### List of Requirements Example

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Illustrates how to define a list of requirements, allowing for multiple conditions to be met simultaneously. This includes checks for target health and the presence or absence of specific buffs/debuffs.

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

--------------------------------

### Pull Goal Sequence Example

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

An example of a 'Pull' goal sequence, defining the 'Concussive Shot' KeyAction with specific requirements like having a ranged weapon, not being in melee range, and having ammunition.

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

--------------------------------

### Build Solution using .NET CLI

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

This snippet demonstrates how to build the Wow Classic Grind Bot solution using the .NET command-line interface. It requires the .NET SDK to be installed and specifies a release build configuration. The command navigates to the project directory and executes the build.

```powershell
cd C:\WowClassicGrindBot
dotnet build -c Release
```

--------------------------------

### NPC ID Requirement Examples

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Provides examples of using the `npcID` requirement to target or avoid specific Non-Player Characters. This can be based on a numeric ID or a defined integer variable.

```json
"Requirement": "!npcID:6195" // target is not [6195](https://tbc.wowhead.com/npc=6195)
"Requirement": "npcID:6195" // target is [6195](https://tbc.wowhead.com/npc=6195)
"Requirement": "npcID:MyAwesomeIntVariable"
```

--------------------------------

### Requirement Examples: Basic, Negated, and Combined

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Demonstrates various ways to define requirements for KeyActions. This includes simple requirements, negated requirements using '!' or 'not ', and complex combinations using '&&' (and) and '||' (or) operators, with support for nested parentheses.

```json
{
    "Name": "Execute",
    "Key": "7",
    "WhenUsable": true
}
```

```json
{
    "Name": "Soul Shard",
    "Key": "9",
    "HasCastBar": true,
    "Requirements": ["TargetHealth% < 36", "!BagItem:6265:3"]
}
```

```json
{
    "Name": "Curse of Weakness",
    "Key": "6",
    "WhenUsable": true,
    "Requirement": "not Curse of Weakness"
}
```

```json
"Requirement": "!BagItem:Item_Soul_Shard:3"
```

```json
"Requirements": ["Has Pet", "TargetHealth% < 70 || TargetCastingSpell"]
```

```json
"Requirement": "!Form:Druid_Bear && Health% < 50 || MobCount > 2"
```

```json
"Requirement": "(Judgement of the Crusader && CD_Judgement <= GCD && TargetHealth% > 20) || TargetCastingSpell"
```

--------------------------------

### Single Requirement Examples

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Demonstrates various single-line requirements used for conditional logic in the grindbot. These cover player stats, target stats, combat ranges, cooldowns, and action costs.

```json
"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
```

--------------------------------

### Form Requirement Examples

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Demonstrates the `Form` requirement, which checks if the player is currently in a specific form (e.g., Druid forms, Shaman Ghost Wolf, Warrior stances). This is crucial for abilities that are form-dependent.

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

--------------------------------

### Using Stance Conditions in WoW Macros

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/Addons/BindPad/readme.txt

This example illustrates how to use stance conditions within World of Warcraft macros to cast different spells based on the character's current stance or form. This is a common technique for optimizing spell usage across various forms, particularly for classes like Warriors and Druids.

```WoW Macro
-- Warrior example:
/cast [stance:1/2] Berserker Stance; [stance:3] Intercept

-- Druid example:
/cast [stance:1] Bash; [nostance:1] Healing Touch

-- Explanation of stance values:
-- [nostance] = Caster form
-- [stance:1] = Bear form (Druid), Battle Stance (Warrior)
-- [stance:2] = Aquatic form (Druid), Defensive Stance (Warrior), Stealth (Rogue)
-- [stance:3] = Cat form (Druid), Berserker Stance (Warrior), Shadow Dance (Rogue)
-- [stance:4] = Travel form (Druid)
-- [stance:5] = Tree of Life/Moonkin form (Druid) or Flight Form (if Tree/Moonkin not available)
-- [stance:6] = Flight Form (if Tree/Moonkin not available)
```

--------------------------------

### HeadlessServer - Run Bot via Command Line

Source: https://context7.com/xian55/wowclassicgrindbot/llms.txt

Guides on running the WowClassicGrindBot without a UI using the HeadlessServer configuration. This is suitable for lower resource usage and includes options for class profiles, navigation modes, process ID, and overlay settings.

```powershell
# Basic run with class profile
cd C:\WowClassicGrindBot\HeadlessServer
.\run.bat Hunter_1.json

# With pathfinder mode options
.\run.bat Hunter_1.json -m RemoteV3    # Use V3 navigation (recommended)
.\run.bat Hunter_1.json -m RemoteV1    # Use V1 navigation
.\run.bat Hunter_1.json -m Local       # Use local PPather

# With specific WoW process ID
.\run.bat Hunter_1.json -pid 12345

# With overlay enabled
.\run.bat Hunter_1.json -o -t          # Enable overlay with targeting

# Validate profile only (no bot start)
.\run.bat Hunter_1.json --loadonly
```

--------------------------------

### WoW API Functions for Keybindings

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/Addons/BindPad/readme.txt

This section lists essential World of Warcraft API functions for managing keybindings. These functions allow developers to get, set, and bind spells, items, and macros to specific keys. Changes must be saved using SaveBindings.

```lua
GetBindingKey("command")
SetBinding("KEY", "command")
SetBindingSpell("KEY", "Spell Name")
SetBindingItem("KEY", "itemname")
SetBindingMacro("KEY", "macroname"|macroid)

SaveBindings(GetCurrentBindingSet())
```

--------------------------------

### GET /api/PPather/WorldRoute2

Source: https://context7.com/xian55/wowclassicgrindbot/llms.txt

Advanced world route calculation that considers whether the starting point is indoors or outdoors, preferring underground or surface paths accordingly.

```APIDOC
## GET /api/PPather/WorldRoute2

### Description
Calculates a navigation path using world coordinates, considering indoor/outdoor status of the start point to optimize pathing (e.g., preferring underground routes if starting indoors).

### Method
GET

### Endpoint
`/api/PPather/WorldRoute2`

### Query Parameters
- **x1** (number) - Required - The X coordinate of the starting point.
- **y1** (number) - Required - The Y coordinate of the starting point.
- **z1** (number) - Required - The Z coordinate of the starting point.
- **x2** (number) - Required - The X coordinate of the destination point.
- **y2** (number) - Required - The Y coordinate of the destination point.
- **z2** (number) - Required - The Z coordinate of the destination point.
- **uimap** (integer) - Required - The UI map ID for the route calculation.
- **startindoors** (boolean) - Required - True if the starting point is indoors, false otherwise.

### Response
#### Success Response (200)
- **path** (array of Vector3) - An array of Vector3 objects representing the calculated path coordinates, optimized for the specified indoor/outdoor preference.
  - **x** (number) - The X coordinate.
  - **y** (number) - The Y coordinate.
  - **z** (number) - The Z coordinate.

#### Response Example
```json
[
  {"x": -896.0, "y": -3770.0, "z": 11.0},
  {"x": -750.0, "y": -3450.0, "z": 45.0},
  {"x": -441.0, "y": -2596.0, "z": 96.0}
]
```
```

--------------------------------

### GET /api/PPather/WorldRoute

Source: https://context7.com/xian55/wowclassicgrindbot/llms.txt

Calculates a navigation path using world coordinates and continent ID. Supports reversing start and end points for return paths.

```APIDOC
## GET /api/PPather/WorldRoute

### Description
Calculates a navigation path between two points using world coordinates and a continent ID. The `reverse` parameter allows for calculating the path in the opposite direction.

### Method
GET

### Endpoint
`/api/PPather/WorldRoute`

### Query Parameters
- **x1** (number) - Required - The X coordinate of the starting point.
- **y1** (number) - Required - The Y coordinate of the starting point.
- **z1** (number) - Required - The Z coordinate of the starting point.
- **x2** (number) - Required - The X coordinate of the destination point.
- **y2** (number) - Required - The Y coordinate of the destination point.
- **z2** (number) - Required - The Z coordinate of the destination point.
- **mapid** (integer) - Required - The continent ID (e.g., Azeroth=0, Kalimdor=1).
- **reverse** (boolean) - Optional - If true, reverses the start and end points for the path calculation.

### Response
#### Success Response (200)
- **path** (array of Vector3) - An array of Vector3 objects representing the calculated path coordinates.
  - **x** (number) - The X coordinate.
  - **y** (number) - The Y coordinate.
  - **z** (number) - The Z coordinate.

#### Response Example
```json
[
  {"x": -896.0, "y": -3770.0, "z": 11.0},
  {"x": -750.5, "y": -3450.2, "z": 45.3},
  {"x": -580.8, "y": -3100.5, "z": 72.1},
  {"x": -441.0, "y": -2596.0, "z": 96.0}
]
```
```

--------------------------------

### WeakAura Example for Hunter Pet Range

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

This is an example of a WeakAura custom code for a Hunter, checking if their pet is within a 10-yard range, likely for a 'feed pet' action. This WeakAura would then set a specific trigger bit that the Wowclassicgrindbot can read.

```lua
!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
```

--------------------------------

### Configure Multiple Paths with Requirements in JSON

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

This JSON configuration illustrates how to set up multiple paths that can be switched during runtime based on defined requirements. Each path object includes its filename and optional settings like PathThereAndBack and PathReduceSteps, along with a 'Requirements' array. The order of paths in the array determines priority, with the first path having the highest priority. A path without requirements serves as a fallback.

```json
{
    "Paths": [
        {
            "PathFilename": "1-5_Gnome.json",                                 
            "PathThereAndBack": false,
            "PathReduceSteps": false,
            "Requirements": [
                "Level < 4"
            ]
        },
        {
            "PathFilename": "_pack\1-20\Dwarf.Gnome\1-4_Dun Morogh.json",  
            "Requirements": [
                "Level < 5"
            ]
        },
        {
            "PathFilename": "_pack\1-20\Dwarf.Gnome\4-6_Dun Morogh.json",  
            "PathThereAndBack": false,
            "PathReduceSteps": false
        }
    ]
}
```

--------------------------------

### Configure Simple Path Settings in JSON

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

This JSON snippet demonstrates how to define basic path settings within a class configuration. It specifies the path file to use, whether to traverse it forwards and backward, reduce the number of steps, and set requirements for side activities. These settings are applied when only one path is needed.

```json
{
    "Id": 42,                                                               
    "PathFilename": "_pack\1-20\Dwarf.Gnome\1-4_Dun Morogh.json.json",   
    "PathThereAndBack": true,                                               
    "PathReduceSteps": true,                                                
    "SideActivityRequirements": [ "PathDist_0 < 10" ]                       
}
```

--------------------------------

### GET /api/Path

Source: https://context7.com/xian55/wowclassicgrindbot/llms.txt

Searches for path JSON files in the Json/path directory based on a filter.

```APIDOC
## GET /api/Path

### Description
Searches for path JSON files in the Json/path directory.

### Method
GET

### Endpoint
/api/Path

### Parameters
#### Query Parameters
- **filter** (string) - Optional - A filter string to search for matching path file names (e.g., "Durotar").

### Request Example
```bash
# Search for Durotar paths
curl -X GET "http://localhost:5000/api/Path?filter=Durotar"
```

### Response
#### Success Response (200 OK)
- **Array of strings** - An array containing the file paths of matching path JSON files.

#### Response Example
```json
[
  "\\Json\\path\\1-10_Durotar.json",
  "\\Json\\path\\Durotar_Vendor.json"
]
```
```

--------------------------------

### GET /api/PPather/SelfTest

Source: https://context7.com/xian55/wowclassicgrindbot/llms.txt

Performs a health check on the server and validates MPQ file access.

```APIDOC
## GET /api/PPather/SelfTest

### Description
Performs a health check on the server and validates MPQ file access.

### Method
GET

### Endpoint
/api/PPather/SelfTest

### Parameters
None

### Request Example
```bash
curl -X GET "http://localhost:5001/api/PPather/SelfTest"
```

### Response
#### Success Response (200 OK)
- **true** (boolean) - Returns true if MPQ files are accessible, otherwise indicates an issue.

#### Response Example
```
true
```
```

--------------------------------

### Follow Route Goal Configuration

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Configures the bot to follow a specified route using pathfinding based on loaded Class Configurations. It includes a base cost and can be added multiple times. It also attempts to find new targets and gathering nodes.

```json
{
    "Name": "FollowRoute",
    "PathFilename": "Path_to_Follow.json",
    "Cost": 20
}
```

--------------------------------

### Configure Bindpad Addon Commands

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

This snippet shows the commands to be configured within the Bindpad addon for specific key presses. These commands automate actions like stopping attacks, clearing targets, and following. The configuration is done via chat commands within the game.

```bash
/stopattack<br>/stopcasting<br>/petfollow
```

```bash
/cleartarget
```

```bash
/follow
```

--------------------------------

### GET /api/Path/GetAreaIdAndZ

Source: https://context7.com/xian55/wowclassicgrindbot/llms.txt

Returns the area ID and calculated Z coordinate for a given map location.

```APIDOC
## GET /api/Path/GetAreaIdAndZ

### Description
Returns the area ID and calculated Z coordinate for a given map location.

### Method
GET

### Endpoint
/api/Path/GetAreaIdAndZ

### Parameters
#### Query Parameters
- **mapid** (integer) - Required - The ID of the map.
- **x** (number) - Required - The x-coordinate.
- **y** (number) - Required - The y-coordinate.

### Request Example
```bash
# Get area info for Kalimdor coordinates
curl -X GET "http://localhost:5000/api/Path/GetAreaIdAndZ?mapid=1&x=-896&y=-3770"
```

### Response
#### Success Response (200 OK)
- **areaId** (integer) - The ID of the area.
- **z** (number) - The calculated Z coordinate.

#### Response Example
```json
{
  "areaId": 17,
  "z": 11.5
}
```
```

--------------------------------

### Compile Headless Server (Batch)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Compiles the HeadlessServer project. This is a prerequisite before running the server. It uses a batch script for compilation.

```batch
HeadlessServer\build.bat
```

--------------------------------

### BlazorServer - Build and Run Bot with Web UI

Source: https://context7.com/xian55/wowclassicgrindbot/llms.txt

Instructions for building and running the WowClassicGrindBot using the BlazorServer configuration. This enables a web interface for monitoring and configuration. Assumes the project is located at C:\WowClassicGrindBot.

```powershell
# Build and run BlazorServer
cd C:\WowClassicGrindBot
dotnet build -c Release

# Run with default settings
cd BlazorServer
.\run.bat

# Run with verbose logging
.\rundev.bat

# Access web UI at http://localhost:5000
```

--------------------------------

### Repair Macro Example (Lua)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

A Lua macro bound to a key that targets a specific NPC and selects the first gossip option, typically used for initiating repairs.

```lua
/tar Vargus
/script SelectGossipOption(1)
```

--------------------------------

### Food and Drink Configuration

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Defines the minimum configuration for 'Food' and 'Drink' actions, including their reserved keys and health/mana percentage requirements.

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

--------------------------------

### Delete Items Macro Example (Lua)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

A Lua macro that iterates through inventory containers and deletes items matching specific string patterns (e.g., 'Slimy', 'Pelt', 'Mystery').

```lua
/run c=C_Container for b=0,4 do for s=1,c.GetContainerNumSlots(b) do local n=c.GetContainerItemLink(b,s) if n and (strfind(n,"Slimy") or strfind(n,"Pelt") or strfind(n,"Mystery")) then c.PickupContainerItem(b,s) DeleteCursorItem() end end end
```

--------------------------------

### Configure Movement Keys in JSON

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

This JSON snippet demonstrates how to configure movement keys (Forward, Backward, Turn Left, Turn Right) using their corresponding ASCII values. This is typically done within a class configuration file to customize player movement controls.

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

--------------------------------

### Bag Item Requirement Examples

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Illustrates the `BagItem` requirement for checking the presence and quantity of items in the player's inventory. This is useful for crafting or resource management, such as Healthstones or Soul Shards.

```json
"Requirement": "BagItem:5175" // Must have a [Earth Totem](https://tbc.wowhead.com/item=5175) in bag
"Requirement": "BagItem:Item_Soul_Shard:3" // Must have atleast [3x Soulshard](https://tbc.wowhead.com/item=6265) in bag
"Requirement": "not BagItem:19007:1" // Must not have a [Lesser Healthstone](https://tbc.wowhead.com/item=19007) in bag
"Requirement": "!BagItem:6265:3" // Must not have [3x Soulshard](https://tbc.wowhead.com/item=6265) in bag
"Requirement": "!BagItem:MyAwesomeIntVariable:69"
```

--------------------------------

### GET /api/PPather/MapToWorldRoute

Source: https://context7.com/xian55/wowclassicgrindbot/llms.txt

Converts map coordinates to world coordinates and calculates a path. Useful when you have minimap coordinates but need world coordinate output.

```APIDOC
## GET /api/PPather/MapToWorldRoute

### Description
Converts minimap coordinates to world coordinates and calculates a navigation path between the two points.

### Method
GET

### Endpoint
`/api/PPather/MapToWorldRoute`

### Query Parameters
- **x1** (number) - Required - The X coordinate of the starting point on the minimap.
- **y1** (number) - Required - The Y coordinate of the starting point on the minimap.
- **z1** (number) - Required - The Z coordinate of the starting point (often 0 for map coordinates).
- **x2** (number) - Required - The X coordinate of the destination point on the minimap.
- **y2** (number) - Required - The Y coordinate of the destination point on the minimap.
- **z2** (number) - Required - The Z coordinate of the destination point (often 0 for map coordinates).
- **uimap** (integer) - Required - The UI map ID for the coordinate conversion.

### Response
#### Success Response (200)
- **path** (array of Vector3) - An array of Vector3 objects representing the calculated path in world coordinates.
  - **x** (number) - The X coordinate.
  - **y** (number) - The Y coordinate.
  - **z** (number) - The Z coordinate.

#### Response Example
```json
[
  {"x": 234.5, "y": -4567.2, "z": 12.0},
  {"x": 300.8, "y": -4400.5, "z": 25.3},
  {"x": 456.2, "y": -4200.1, "z": 45.7}
]
```
```

--------------------------------

### Manual NPC Route Configuration (JSON)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Defines a sequence of NPC interactions for manual routing. Each step specifies the NPC interaction type, a macro key, conditions for interaction, mount usage, and an optional path file for reaching the NPC.

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

--------------------------------

### NPC MacroText Templating with Variables

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Allows specifying templated macro text for NPCs, where variables are prefixed with '$'. These variables must be defined in StringVariables. The example shows buying ammo if the player has less than a certain amount.

```json
{
    "NPC": {
        "Sequence": [
            {
            "Cost": 6,
            "Name": "VendorAmmo",
            "Requirements": [
                "!BagItem:ITEM_ARROW:MIN_COUNT_ARROW"
            ],
            "MacroText": "/run local a={'$ITEM_NAME_ARROW',$AMMO_SLOT} for i=1,GetMerchantNumItems() do if GetMerchantItemInfo(i)==a[1] then for j=1,a[2] do BuyMerchantItem(i,200) end end end"
            }
        ]
    }
}
```

```lua
/run local a={'Rough Arrow',5} for i=1,GetMerchantNumItems() do if GetMerchantItemInfo(i)==a[1] then for j=1,a[2] do BuyMerchantItem(i,200) end end end
```

--------------------------------

### Overriding Combat Requirement (JSON)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Example of overriding the default combat requirement for a specific key action. This allows actions like 'Horn of Winter' to be used regardless of combat status, provided other conditions are met.

```json
{
    "Cost": 3.1,
    "Name": "Horn of Winter",
    "Key": "F4",
    "InCombat": "i dont care",
    "WhenUsable": true,
    "Requirements": [
        "!Horn of Winter || (CD_Horn of Winter <= GCD && TargetAlive && TargetHostile)",
        "!Mounted"
    ]
}
```

--------------------------------

### Assist Focus Goal Configuration in JSON

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Defines the sequence of KeyActions for the Assist Focus mode. This mode activates when specific requirements are met, causing the player to target a focus or party member and execute defined actions. It includes conditions for buffs, debuffs, and spell ranges.

```json
{
    "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"
            }
        ]
    }
}
```

--------------------------------

### Disable In-Game Glow Effect

Source: https://github.com/xian55/wowclassicgrindbot/wiki/Guidance-for-good-DataFrame

This command disables the in-game glow effect to ensure a cleaner image capture for the bot. It's a crucial step for reliable state acquisition.

```game console
/console ffxGlow 0
```

--------------------------------

### Adhoc Goals Configuration (JSON)

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Defines a sequence of key actions to be performed when not in combat and off cooldown, suitable for personal buffs. Each action has a name, keybind, and a requirement that must be met.

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

--------------------------------

### Instant Spell Configuration

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Defines a spell that is cast instantly and does not have a castbar. This is the minimum configuration for instant spells.

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

--------------------------------

### Define Global String Variables

Source: https://github.com/xian55/wowclassicgrindbot/blob/dev/README.md

Define custom string variables for use in the Class Configuration. Values can be literal strings or references to IntVariables keys. Variables starting with '$ITEM_NAME' or '$NPC_NAME' are dynamically replaced with localized item or NPC names.

```json
{
    "StringVariables": {
        "$ITEM_NAME_ARROW": "ITEM_ARROW",
        "$AMMO_SLOT": "AMMO_SLOT"
    }
}
```
Tokens:
Raw