@nxg-org/mineflayer-physics-util 1.8.13 → 1.8.15

package/.vscode/settings.json

@@ -1,5 +1,5 @@
-{
-    "print.colourScheme": "GitHub",
-    "ecl.launchConfiguration": "not found",
-    "ecl.targetCluster": {}
+{
+    "print.colourScheme": "GitHub",
+    "ecl.launchConfiguration": "not found",
+    "ecl.targetCluster": {}
 }

package/README.md

@@ -1 +1 @@
-# mineflayer-physics-utils
+# mineflayer-physics-utils

package/dist/physics/engines/botcraft.js

@@ -223,13 +223,14 @@ class BotcraftPhysics {
     physicsTick(ctx, world) {
         // Check for rocket boosting if currently in elytra flying mode
         const entity = ctx.state;
-        if (ctx.state.elytraFlying) {
-            // TODO: entity check for fireworks
-            // TODO: check if firework is attached to player
-            if (false) {
-                // player->speed += player->front_vector * 0.1 + (player->front_vector * 1.5 - player->speed) * 0.5;
-            }
-        }
+        // if (ctx.state.elytraFlying) {
+        //   // TODO: entity check for fireworks
+        //   // TODO: check if firework is attached to player
+        //   if (false) {
+        //     // player->speed += player->front_vector * 0.1 + (player->front_vector * 1.5 - player->speed) * 0.5;
+        //   }
+        // }
+        // for now, only check if this is a player.
         const playerFlag = ctx.entityType.type === "player";
         this.fluidPhysics(ctx, world, true);
         this.fluidPhysics(ctx, world, false);
@@ -940,8 +941,21 @@ class BotcraftPhysics {
                 if (player.onGround) {
                     player.fallFlying = false;
                 }
+                // Potentially not the correct place for this logic, but it is easier to implement here for now. This is the firework boost from elytra flying.
+                if (player.fireworkRocketDuration > 0) {
+                    const { lookDir } = (0, physicsUtils_1.getLookingVector)(player);
+                    player.vel.x += lookDir.x * 0.1 + (lookDir.x * 1.5 - player.vel.x) * 0.5;
+                    player.vel.y += lookDir.y * 0.1 + (lookDir.y * 1.5 - player.vel.y) * 0.5;
+                    player.vel.z += lookDir.z * 0.1 + (lookDir.z * 1.5 - player.vel.z) * 0.5;
+                    --player.fireworkRocketDuration;
+                }
+                // we're on ground or in air, not flying.
             }
             else {
+                // clear firework boost if on ground or in air without flying, otherwise it can cause issues with movement.
+                if (player.fireworkRocketDuration > 0) {
+                    player.fireworkRocketDuration = 0;
+                }
                 const blockBelow = world.getBlock(this.getBlockBelowAffectingMovement(player, world));
                 // deviation. using our stores slipperiness values.
                 const friction = blockBelow

package/dist/physics/states/playerState.js

@@ -288,7 +288,7 @@ class PlayerState {
                 break;
             case "survival":
             case "adventure":
-                this.flySpeed = 0;
+                this.flySpeed = 0.05; // same as creative
                 this.mayFly = bot.entity.canFly;
                 break;
             default:

package/dist/simulators/baseSimulator.d.ts

@@ -13,7 +13,7 @@ export declare class BaseSimulator<State extends IEntityState = IEntityState> {
     predictGenerator(simCtx: EPhysicsCtx<State>, world: any, ticks?: number, controls?: ControlStateHandler): Generator<IEntityState, EPhysicsCtx<State>, unknown>;
     predictForward(target: Entity, world: any, ticks?: number, controls?: ControlStateHandler): EntityState;
     predictForwardRaw(simCtx: EPhysicsCtx<State>, world: any, ticks?: number, controls?: ControlStateHandler): State;
-    simulateUntil(goal: SimulationGoal, onGoalReach: OnGoalReachFunction, controller: Controller, simCtx: EPhysicsCtx<State>, world: any, ticks?: number): State;
+    simulateUntil(goal: SimulationGoal<State>, onGoalReach: OnGoalReachFunction<State>, controller: Controller<State>, simCtx: EPhysicsCtx<State>, world: any, ticks?: number): State;
     static getReached<State extends IEntityState = IEntityState>(...path: Vec3[]): SimulationGoal<State>;
     static getCleanupPosition<State extends IEntityState = IEntityState>(...path: Vec3[]): OnGoalReachFunction<State>;
     static buildFullController<State extends IEntityState = IEntityState>(...controllers: Controller<State>[]): Controller<State>;

package/eslint.config.mjs

@@ -1,17 +1,17 @@
-import { defineConfig } from "eslint/config";
-import globals from "globals";
-import js from "@eslint/js";
-import tseslint from "typescript-eslint";
-
-export default defineConfig([
-  {
-    files: ["**/*.{ts,tsx}"], // Only check TypeScript files
-    languageOptions: { globals: globals.browser }
-  },
-  {
-    files: ["**/*.{ts,tsx}"], // Only check TypeScript files
-    plugins: { js },
-    extends: ["js/recommended"]
-  },
-  tseslint.configs.recommended,
-]);
+import { defineConfig } from "eslint/config";
+import globals from "globals";
+import js from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default defineConfig([
+  {
+    files: ["**/*.{ts,tsx}"], // Only check TypeScript files
+    languageOptions: { globals: globals.browser }
+  },
+  {
+    files: ["**/*.{ts,tsx}"], // Only check TypeScript files
+    plugins: { js },
+    extends: ["js/recommended"]
+  },
+  tseslint.configs.recommended,
+]);

package/package.json

@@ -1,46 +1,46 @@
-{
-    "name": "@nxg-org/mineflayer-physics-util",
-    "version": "1.8.13",
-    "description": "Provides functionality for more accurate entity and projectile tracking.",
-    "keywords": [
-        "mineflayer",
-        "mineflayer-plugin",
-        "mineflayer-tracker"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/nxg-org/mineflayer-physics-utils.git"
-    },
-    "license": "GPL-3.0",
-    "author": "generel_schwerz",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "scripts": {
-        "lint": "eslint . --ext .ts,.tsx",
-        "build": "npx tsc",
-        "prepublishOnly": "npm run build",
-        "test": "mocha --require ts-node/register --recursive tests/**/*.test.ts"
-    },
-    "dependencies": {
-        "@nxg-org/mineflayer-util-plugin": "^1.8.2"
-    },
-    "devDependencies": {
-        "@eslint/js": "^9.23.0",
-        "@types/mocha": "^10.0.10",
-        "@typescript-eslint/eslint-plugin": "^8.27.0",
-        "@typescript-eslint/parser": "^8.27.0",
-        "eslint": "^9.23.0",
-        "expect": "^29.7.0",
-        "globals": "^16.0.0",
-        "minecraft-data": "^3.83.1",
-        "mineflayer": "^4.26.0",
-        "mineflayer-pathfinder": "^2.4.4",
-        "mocha": "^11.1.0",
-        "prismarine-entity": "^2.4.0",
-        "prismarine-registry": "^1.11.0",
-        "ts-node": "^10.9.2",
-        "typescript": "^5.8.2",
-        "typescript-eslint": "^8.27.0"
-    },
-    "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
-}
+{
+    "name": "@nxg-org/mineflayer-physics-util",
+    "version": "1.8.15",
+    "description": "Provides functionality for more accurate entity and projectile tracking.",
+    "keywords": [
+        "mineflayer",
+        "mineflayer-plugin",
+        "mineflayer-tracker"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/nxg-org/mineflayer-physics-utils.git"
+    },
+    "license": "GPL-3.0",
+    "author": "generel_schwerz",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "lint": "eslint . --ext .ts,.tsx",
+        "build": "npx tsc",
+        "prepublishOnly": "npm run build",
+        "test": "mocha --require ts-node/register --recursive tests/**/*.test.ts"
+    },
+    "dependencies": {
+        "@nxg-org/mineflayer-util-plugin": "^1.8.2"
+    },
+    "devDependencies": {
+        "@eslint/js": "^9.23.0",
+        "@types/mocha": "^10.0.10",
+        "@typescript-eslint/eslint-plugin": "^8.27.0",
+        "@typescript-eslint/parser": "^8.27.0",
+        "eslint": "^9.23.0",
+        "expect": "^29.7.0",
+        "globals": "^16.0.0",
+        "minecraft-data": "^3.83.1",
+        "mineflayer": "^4.26.0",
+        "mineflayer-pathfinder": "^2.4.4",
+        "mocha": "^11.1.0",
+        "prismarine-entity": "^2.4.0",
+        "prismarine-registry": "^1.11.0",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.8.2",
+        "typescript-eslint": "^8.27.0"
+    },
+    "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+}

package/tests/actualBot.ts

@@ -1,198 +1,198 @@
-import { pathfinder, goals } from "mineflayer-pathfinder";
-import { Bot, createBot } from "mineflayer";
-const physicsInject = require("mineflayer/lib/plugins/physics");
-import loader, { BotcraftPhysics, EntityPhysics, EntityState, EPhysicsCtx } from "../src/index";
-import { PlayerState } from "../src/physics/states";
-
-const { Physics } = require("prismarine-physics");
-
-const rl = require("readline").createInterface({
-  input: process.stdin,
-  output: process.stdout,
-});
-
-let bot1: Bot;
-function buildBot() {
-  console.log("hey!");
-
-  const bot = createBot({
-    host: process.argv[2] || 'localhost',
-    port: Number(process.argv[3]),
-    username: "testingbot",
-    version: process.argv[4],
-  });
-
-  bot.on('login', () => {
-    bot.chat("Hello! I am a testing bot!");
-  })
-
-  bot.once("spawn", async () => {
-    bot.loadPlugin(loader);
-    bot.loadPlugin(pathfinder);
-    await bot.waitForTicks(20);
-    (bot as any).physics.yawSpeed = 50;
-    (bot as any).physics.pitchSpeed = 50;
-    setupNewPhysics(bot);
-    // setupNewPhysics(bot);
-  });
-
-  bot.on('entityMoved', (entity => {
-    // if (entity !== bot.entity)
-    // console.log(entity.attributes) 
-  }))
-
-  let wasOnGround = false;
-  const printNextPos = false;
-
-  bot.on("move", (pos) => {
-    // console.log(pos);
-    if (bot.entity.onGround && !wasOnGround) {
-      // bot.chat("Hit the ground! " + bot.entity.position.toString());
-    }
-    wasOnGround = bot.entity.onGround;
-  });
-
-  // print whenever another player hits the ground
-  const lastPositions: Record<string, boolean> = {};
-  bot.on("entityMoved", (entity) => {
-    if (entity.username && entity.username !== bot.username) {
-      // check by seeing is y value is an integer
-      if (Math.floor(entity.position.y) === entity.position.y && !lastPositions[entity.username]) {
-        // check if in liquid
-        const block = bot.blockAt(entity.position);
-        if (block && (block.type === bot.registry.blocksByName.water.id || block.type === bot.registry.blocksByName.lava.id)) return;
-
-        bot.chat(`${entity.username} hit the ground! ${entity.position.toString()}`);
-        lastPositions[entity.username] = true;
-      } else if (Math.floor(entity.position.y) !== entity.position.y) {
-        lastPositions[entity.username] = false;
-      }
-    }
-  });
-
-  let usingNew = false;
-  let oldSimulate: any = null;
-  let state: PlayerState | null = null;
-
-  function setupNewPhysics(bot: Bot) {
-    if (usingNew) return;
-    usingNew = true;
-    oldSimulate = (bot.physics as any).simulatePlayer;
-
-    const val = new BotcraftPhysics(bot.registry);
-
-    (EntityState.prototype as any).apply = function (this: EntityState, bot: Bot) {
-      console.log(this.control, this.isUsingItem);
-      this.applyToBot(bot);
-    };
-
-    const ctx = EPhysicsCtx.FROM_BOT(val, bot);
-    state = ctx.state as PlayerState;
-
-    // EntityPhysics.prototype.simulate = function (ctx, world) {
-    //   bot.physics.simulatePlayer(ctx.state, world);
-    // }
-
-    (bot.physics as any).autojumpCooldown = 0;
-    // (bot.physics).jumpTicks = 0;
-
-    (bot.physics as any).simulatePlayer = (...args: any[]) => {
-      state!.update(bot);
-      ctx.state.jumpTicks = 0; // allow immediate jumping
-      return val.simulate(ctx, bot.world);
-    };
-  }
-
-  bot.on("chat", async (user, message) => {
-    const [cmd, ...args] = message.split(" ");
-    const author = bot.nearestEntity((e) => e.username === user);
-
-    switch (cmd) {
-      case "using":
-        bot.chat(`Using new physics: ${usingNew}`);
-        break;
-      case "lookatme":
-        if (!author) return bot.chat("I can't see you!");
-        bot.lookAt(author.position.offset(0, author.height, 0));
-        break;
-      case "status":
-        const str0 = `pos: ${bot.entity.position.toString()}, vel: ${bot.entity.velocity.toString()}, yaw: ${bot.entity.yaw}, pitch: ${bot.entity.pitch}`;
-        bot.chat(str0);
-        
-        const str = `onGround: ${bot.entity.onGround}, hCol: ${(bot.entity as any).isCollidedHorizontally}, vCol: ${
-          (bot.entity as any).isCollidedVertically
-        }, inWater: ${(bot.entity as any).isInWater}, inLava: ${(bot.entity as any).isInLava}`;
-        bot.chat(str);
-
-        if (state != null) {
-          const str1 = `crouching: ${state.crouching}, sprinting: ${state.sprinting}`;
-          bot.chat(str1);
-        }
-        break;
-      case "use":
-        if (bot.usingHeldItem) bot.deactivateItem();
-        else bot.activateItem();
-        break;
-      case "useoff":
-        bot.deactivateItem();
-        bot.activateItem(true);
-        break;
-      case "control":
-        if (args[0] === "clear") return bot.clearControlStates();
-        if (args.length === 1) return bot.setControlState(args[0] as any, !bot.getControlState(args[0] as any));
-        bot.setControlState(args[0] as any, args[1] === "true");
-        break;
-      case "sim":
-        // turn all but the mentioned ones off
-        const [time, ...controls] = args;
-        bot.clearControlStates();
-        for (const control of controls) {
-          bot.setControlState(control as any, true);
-        }
-
-        for (let i = 0; i <= Number(time); i++) {
-          console.log(bot.entity.position, bot.entity.velocity, i);
-          await bot.waitForTicks(1);
-        }
-        bot.clearControlStates();
-
-        break;
-      case "reset":
-        usingNew = false;
-        bot.quit();
-        await new Promise((res) => setTimeout(res, 3000));
-        bot1 = buildBot();
-
-        break;
-      case "new":
-        setupNewPhysics(bot);
-        bot.chat("Switched to new physics!");
-        break;
-      case "jump":
-        bot.setControlState("jump", true);
-        break;
-      case "come":
-        if (!author) return bot.chat(`Cannot see ${user}!`);
-        const goal0 = new goals.GoalNear(author.position.x, author.position.y, author.position.z, 3);
-        bot.pathfinder.setGoal(goal0);
-        break;
-      case "goto":
-        if (!author) return bot.chat(`Cannot see ${user}!`);
-        const goal1 = new goals.GoalNear(Number(args[0]), Number(args[1]), Number(args[2]), 3);
-        bot.pathfinder.setGoal(goal1);
-        break;
-      case "stop":
-        bot.deactivateItem();
-        bot.pathfinder.stop();
-        bot.clearControlStates();
-        bot.chat("Stopped!");
-        break;
-    }
-  });
-
-  rl.on("line", (line: any) => bot.chat(line));
-
-  return bot;
-}
-
-bot1 = buildBot();
+import { pathfinder, goals } from "mineflayer-pathfinder";
+import { Bot, createBot } from "mineflayer";
+const physicsInject = require("mineflayer/lib/plugins/physics");
+import loader, { BotcraftPhysics, EntityPhysics, EntityState, EPhysicsCtx } from "../src/index";
+import { PlayerState } from "../src/physics/states";
+
+const { Physics } = require("prismarine-physics");
+
+const rl = require("readline").createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+let bot1: Bot;
+function buildBot() {
+  console.log("hey!");
+
+  const bot = createBot({
+    host: process.argv[2] || 'localhost',
+    port: Number(process.argv[3]),
+    username: "testingbot",
+    version: process.argv[4],
+  });
+
+  bot.on('login', () => {
+    bot.chat("Hello! I am a testing bot!");
+  })
+
+  bot.once("spawn", async () => {
+    bot.loadPlugin(loader);
+    bot.loadPlugin(pathfinder);
+    await bot.waitForTicks(20);
+    (bot as any).physics.yawSpeed = 50;
+    (bot as any).physics.pitchSpeed = 50;
+    setupNewPhysics(bot);
+    // setupNewPhysics(bot);
+  });
+
+  bot.on('entityMoved', (entity => {
+    // if (entity !== bot.entity)
+    // console.log(entity.attributes) 
+  }))
+
+  let wasOnGround = false;
+  const printNextPos = false;
+
+  bot.on("move", (pos) => {
+    // console.log(pos);
+    if (bot.entity.onGround && !wasOnGround) {
+      // bot.chat("Hit the ground! " + bot.entity.position.toString());
+    }
+    wasOnGround = bot.entity.onGround;
+  });
+
+  // print whenever another player hits the ground
+  const lastPositions: Record<string, boolean> = {};
+  bot.on("entityMoved", (entity) => {
+    if (entity.username && entity.username !== bot.username) {
+      // check by seeing is y value is an integer
+      if (Math.floor(entity.position.y) === entity.position.y && !lastPositions[entity.username]) {
+        // check if in liquid
+        const block = bot.blockAt(entity.position);
+        if (block && (block.type === bot.registry.blocksByName.water.id || block.type === bot.registry.blocksByName.lava.id)) return;
+
+        bot.chat(`${entity.username} hit the ground! ${entity.position.toString()}`);
+        lastPositions[entity.username] = true;
+      } else if (Math.floor(entity.position.y) !== entity.position.y) {
+        lastPositions[entity.username] = false;
+      }
+    }
+  });
+
+  let usingNew = false;
+  let oldSimulate: any = null;
+  let state: PlayerState | null = null;
+
+  function setupNewPhysics(bot: Bot) {
+    if (usingNew) return;
+    usingNew = true;
+    oldSimulate = (bot.physics as any).simulatePlayer;
+
+    const val = new BotcraftPhysics(bot.registry);
+
+    (EntityState.prototype as any).apply = function (this: EntityState, bot: Bot) {
+      console.log(this.control, this.isUsingItem);
+      this.applyToBot(bot);
+    };
+
+    const ctx = EPhysicsCtx.FROM_BOT(val, bot);
+    state = ctx.state as PlayerState;
+
+    // EntityPhysics.prototype.simulate = function (ctx, world) {
+    //   bot.physics.simulatePlayer(ctx.state, world);
+    // }
+
+    (bot.physics as any).autojumpCooldown = 0;
+    // (bot.physics).jumpTicks = 0;
+
+    (bot.physics as any).simulatePlayer = (...args: any[]) => {
+      state!.update(bot);
+      ctx.state.jumpTicks = 0; // allow immediate jumping
+      return val.simulate(ctx, bot.world);
+    };
+  }
+
+  bot.on("chat", async (user, message) => {
+    const [cmd, ...args] = message.split(" ");
+    const author = bot.nearestEntity((e) => e.username === user);
+
+    switch (cmd) {
+      case "using":
+        bot.chat(`Using new physics: ${usingNew}`);
+        break;
+      case "lookatme":
+        if (!author) return bot.chat("I can't see you!");
+        bot.lookAt(author.position.offset(0, author.height, 0));
+        break;
+      case "status":
+        const str0 = `pos: ${bot.entity.position.toString()}, vel: ${bot.entity.velocity.toString()}, yaw: ${bot.entity.yaw}, pitch: ${bot.entity.pitch}`;
+        bot.chat(str0);
+        
+        const str = `onGround: ${bot.entity.onGround}, hCol: ${(bot.entity as any).isCollidedHorizontally}, vCol: ${
+          (bot.entity as any).isCollidedVertically
+        }, inWater: ${(bot.entity as any).isInWater}, inLava: ${(bot.entity as any).isInLava}`;
+        bot.chat(str);
+
+        if (state != null) {
+          const str1 = `crouching: ${state.crouching}, sprinting: ${state.sprinting}`;
+          bot.chat(str1);
+        }
+        break;
+      case "use":
+        if (bot.usingHeldItem) bot.deactivateItem();
+        else bot.activateItem();
+        break;
+      case "useoff":
+        bot.deactivateItem();
+        bot.activateItem(true);
+        break;
+      case "control":
+        if (args[0] === "clear") return bot.clearControlStates();
+        if (args.length === 1) return bot.setControlState(args[0] as any, !bot.getControlState(args[0] as any));
+        bot.setControlState(args[0] as any, args[1] === "true");
+        break;
+      case "sim":
+        // turn all but the mentioned ones off
+        const [time, ...controls] = args;
+        bot.clearControlStates();
+        for (const control of controls) {
+          bot.setControlState(control as any, true);
+        }
+
+        for (let i = 0; i <= Number(time); i++) {
+          console.log(bot.entity.position, bot.entity.velocity, i);
+          await bot.waitForTicks(1);
+        }
+        bot.clearControlStates();
+
+        break;
+      case "reset":
+        usingNew = false;
+        bot.quit();
+        await new Promise((res) => setTimeout(res, 3000));
+        bot1 = buildBot();
+
+        break;
+      case "new":
+        setupNewPhysics(bot);
+        bot.chat("Switched to new physics!");
+        break;
+      case "jump":
+        bot.setControlState("jump", true);
+        break;
+      case "come":
+        if (!author) return bot.chat(`Cannot see ${user}!`);
+        const goal0 = new goals.GoalNear(author.position.x, author.position.y, author.position.z, 3);
+        bot.pathfinder.setGoal(goal0);
+        break;
+      case "goto":
+        if (!author) return bot.chat(`Cannot see ${user}!`);
+        const goal1 = new goals.GoalNear(Number(args[0]), Number(args[1]), Number(args[2]), 3);
+        bot.pathfinder.setGoal(goal1);
+        break;
+      case "stop":
+        bot.deactivateItem();
+        bot.pathfinder.stop();
+        bot.clearControlStates();
+        bot.chat("Stopped!");
+        break;
+    }
+  });
+
+  rl.on("line", (line: any) => bot.chat(line));
+
+  return bot;
+}
+
+bot1 = buildBot();