kill-switch-mcp 1.1.9 → 1.1.10

package/dist/server.js

@@ -4111,19 +4111,16 @@ execute it by sending code to the game via execute_code.
 - bot.attackNpc("name" or /pattern/i) — attack an NPC
 - bot.walkTo(x, z) — pathfind and walk (complex, uses server pathfinding)
 
-### sdk methods (low-level, instant):
-- sdk.sendWalk(x, z) — click a tile to walk there (fast, no pathfinding)
-- sdk.getState() — full game state object
+### sdk methods (low-level):
+State (sync): sdk.getState(), sdk.getInventory(), sdk.getEquipment(), sdk.getNearbyPlayers(), sdk.getGroundItems()
+Search (sync): sdk.findInventoryItem(/pat/i), sdk.findGroundItem(/pat/i), sdk.findNearbyPlayer(/pat/i)
+Commands (async): sdk.sendWalk(x, z), sdk.sendPickup(x, z, itemId), sdk.sendInteractLoc(x, z, locId, option)
+Timing (async): await sdk.waitForTicks(n) — each tick ~0.6s
+
+Key state paths:
 - sdk.getState().player.worldX / .worldZ — your position
-- sdk.getState().player.hp — your current HP
-- sdk.getState().player.maxHp — your max HP
-- sdk.getInventory() — array of inventory items (each has .name)
-- sdk.getEquipment() — array of equipment items
-- sdk.findInventoryItem(/pattern/i) — find item in inventory
-- sdk.findGroundItem(/pattern/i) — find item on ground (returns { name, x, z, distance } — NOT .worldX!)
-- sdk.getGroundItems() — all nearby ground items (each has .name, .x, .z, .distance, .id, .count)
-- sdk.getNearbyPlayers() — nearby players (each has .name, .combatLevel, .distance, .x, .z)
-- sdk.waitForTicks(n) — wait n game ticks (~0.6s each)
+- sdk.getState().player.hp / .maxHp — your hitpoints
+- Ground items use .x / .z (NOT .worldX)
 
 ### actions (pre-built strategies, await each one):
 Actions are loaded from your bot's actions/ directory at login. Default actions:
@@ -4181,7 +4178,7 @@ Wrap in try/catch if you want to handle failures gracefully.
 - \`await bot.talkTo(nameOrPattern)\` — Talk to an NPC.
 - \`await bot.interactLoc(nameOrPattern, option)\` — Interact with a game object.
 - \`await bot.interactNpc(nameOrPattern, option)\` — Interact with an NPC.
-- \`await bot.openDoor(x, z)\` — Open a door at coordinates.
+- \`await bot.openDoor(target)\` — Open a door. Pass a NearbyLoc object, string name, or RegExp. With no args, opens nearest door.
 
 ### Dialog
 - \`await bot.navigateDialog(choices)\` — Navigate through NPC dialog.
@@ -4199,10 +4196,10 @@ Wrap in try/catch if you want to handle failures gracefully.
 - \`sdk.getState()\` — Returns the full game state object. See "State Object Shape" below.
 - \`sdk.getInventory()\` — Array of inventory items. Each has: \`.name\`, \`.id\`, \`.count\`, \`.slot\`
 - \`sdk.getEquipment()\` — Array of equipped items. Each has: \`.name\`, \`.id\`, \`.slot\`
-- \`sdk.getNearbyPlayers()\` — Array of nearby players. Each has: \`.name\`, \`.combatLevel\`, \`.distance\`, \`.x\`, \`.z\`
+- \`sdk.getNearbyPlayers()\` — Array of nearby players. Each has: \`.index\`, \`.name\`, \`.combatLevel\`, \`.distance\`, \`.x\`, \`.z\`
 - \`sdk.getGroundItems()\` — Array of ground items. Each has: \`.name\`, \`.id\`, \`.count\`, \`.x\`, \`.z\`, \`.distance\`
-- \`sdk.getNearbyLocs()\` — Array of nearby game objects.
-- \`sdk.getNearbyNpcs()\` — Array of nearby NPCs.
+- \`sdk.getNearbyLocs()\` — Array of nearby game objects. Each has: \`.id\`, \`.name\`, \`.x\`, \`.z\`, \`.distance\`, \`.options\`
+- \`sdk.getNearbyNpcs()\` — Array of nearby NPCs. Each has: \`.index\`, \`.name\`, \`.combatLevel\`, \`.x\`, \`.z\`, \`.distance\`, \`.hp\`, \`.maxHp\`, \`.inCombat\`
 
 ### Search (instant, not async)
 - \`sdk.findInventoryItem(pattern)\` — Find first matching inventory item. Returns item or null.
@@ -4211,15 +4208,16 @@ Wrap in try/catch if you want to handle failures gracefully.
 - \`sdk.findNearbyNpc(pattern)\` — Find a nearby NPC. Returns NPC or null.
 - \`sdk.findNearbyLoc(pattern)\` — Find a nearby game object. Returns loc or null.
 
-### Direct Commands (instant, fire-and-forget)
-- \`sdk.sendWalk(x, z)\` — Click a tile to walk there. Fast, no pathfinding. Use for quick movement during combat.
-- \`sdk.sendPickup(itemId, x, z)\` — Send raw pickup command.
-- \`sdk.sendInteractPlayer(playerIndex, option)\` — Interact with a player directly.
-- \`sdk.sendInteractNpc(npcId, option)\` — Interact with an NPC directly.
-- \`sdk.sendInteractLoc(locId, x, z, option)\` — Interact with a game object directly.
-- \`sdk.sendUseItem(slot)\` — Use an inventory item (e.g., eat food).
+### Direct Commands (async, send action to server)
+All send* methods are async and return Promise<ActionResult>. Use await or fire-and-forget.
+- \`sdk.sendWalk(x, z)\` — Click a tile to walk there. Fast, no pathfinding. Use for quick movement.
+- \`sdk.sendPickup(x, z, itemId)\` — Pick up a ground item. Args are (x, z, itemId) — NOT (itemId, x, z).
+- \`sdk.sendInteractPlayer(playerIndex, option)\` — Interact with a player. Use player.index from getNearbyPlayers().
+- \`sdk.sendInteractNpc(npcIndex, option)\` — Interact with an NPC. Use npc.index from getNearbyNpcs(). NOT npcId.
+- \`sdk.sendInteractLoc(x, z, locId, option)\` — Interact with a game object. Args are (x, z, locId, option) — NOT (locId, x, z).
+- \`sdk.sendUseItem(slot, option)\` — Use an inventory item. option defaults to 1 (first option, e.g. eat/wear).
 - \`sdk.sendSetCombatStyle(style)\` — Change combat style (0-3).
-- \`sdk.sendTogglePrayer(prayerId)\` — Toggle a prayer on/off.
+- \`sdk.sendTogglePrayer(prayer)\` — Toggle a prayer. Accepts prayer name string (e.g. 'protect_from_melee') or prayer ID number.
 
 ### Timing (async)
 - \`await sdk.waitForTicks(n)\` — Wait n game ticks. Each tick ≈ 0.6 seconds.
@@ -4242,16 +4240,23 @@ sdk.getState() returns:
     hp: number,              // Current hitpoints
     maxHp: number,           // Max hitpoints
     combatLevel: number,
-    animation: number,       // Current animation ID (-1 = idle)
+    animId: number,          // Current animation ID (-1 = idle)
+    combat: {                // Combat sub-state
+      inCombat: boolean,
+      targetIndex: number,
+    },
   },
+  inGame: boolean,           // Whether connected to game
   skills: [...],             // Array of skill objects
   inventory: [...],          // Array of inventory slots
   equipment: [...],          // Array of equipment slots
-  groundItems: [...],        // Nearby ground items (each has .name, .x, .z, .id, .count)
-  nearbyPlayers: [...],      // Nearby players
-  nearbyNpcs: [...],         // Nearby NPCs
+  groundItems: [...],        // Nearby ground items (each has .name, .x, .z, .id, .count, .distance)
+  nearbyPlayers: [...],      // Nearby players (each has .index, .name, .x, .z, .distance, .combatLevel)
+  nearbyNpcs: [...],         // Nearby NPCs (each has .index, .name, .x, .z, .distance, .hp, .maxHp)
+  nearbyLocs: [...],         // Nearby game objects (each has .id, .name, .x, .z, .distance, .options)
   dialog: { isOpen, ... },   // Dialog state
   modalOpen: boolean,        // Whether a modal is open
+  gameMessages: [...],       // Recent game messages
 }
 \`\`\`
 
@@ -4267,10 +4272,20 @@ IMPORTANT PROPERTY NAMES:
 
 ### Quick loot (walk + pick up):
 \`\`\`
-sdk.sendWalk(3106, 3353);           // Click tile to walk there
-await sdk.waitForTicks(5);          // Wait to arrive
-await bot.pickupItem(/lobster/i);   // Pick up item at feet
-await bot.equipItem(/scimitar/i);   // Equip from inventory
+// Option A: Use bot.pickupItem (walks to item automatically, throws on failure)
+try { await bot.pickupItem(/lobster/i); } catch(e) { console.log("Missed lobster"); }
+
+// Option B: Manual walk + raw pickup (more control)
+const item = sdk.findGroundItem(/lobster/i);
+if (item) {
+  sdk.sendWalk(item.x, item.z);              // Walk to item
+  await sdk.waitForTicks(5);                  // Wait to arrive
+  sdk.sendPickup(item.x, item.z, item.id);   // Pick up (args: x, z, itemId)
+  await sdk.waitForTicks(2);                  // Wait for server
+}
+
+// Equip from inventory
+await bot.equipItem(/scimitar/i);
 \`\`\`
 
 ### Combat loop:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kill-switch-mcp",
-  "version": "1.1.9",
+  "version": "1.1.10",
   "description": "Kill Switch MCP Server — AI battle royale powered by Claude Code",
   "type": "module",
   "bin": {