mineflayer-pathfinder

The Movements class configures how the pathfinder plans its paths, including block breaking, building, and movement costs. To change default behavior, create a new instance of Movements and pass it to bot.pathfinder.setMovements().

Example:

const { Movements } = require('mineflayer-pathfinder')

bot.once('spawn', () => {
  const defaultMove = new Movements(bot)

  defaultMove.allow1by1towers = false // Do not build 1x1 towers
  defaultMove.canDig = false // Disable breaking blocks
  defaultMove.scafoldingBlocks.push(bot.registry.itemsByName['netherrack'].id)
  
  bot.pathfinder.setMovements(defaultMove)
})

const { Movements } = require('mineflayer-pathfinder')

bot.once('spawn', () => {
  const defaultMove = new Movements(bot)

  defaultMove.allow1by1towers = false // Do not build 1x1 towers when going up
  defaultMove.canDig = false // Disable breaking of blocks when pathing 
  defaultMove.scafoldingBlocks.push(bot.registry.itemsByName['netherrack'].id) // Add nether rack to allowed scaffolding items
  bot.pathfinder.setMovements(defaultMove) // Update the movement instance pathfinder uses

  // Do pathfinder things
  // ...
})

Goals define the destination or objective for the pathfinder. You should not instantiate the abstract Goal class directly; instead, use the provided implementations or extend Goal to create custom ones.

Position-Based Goals

• GoalBlock(x, y, z): Stand inside this specific block at foot level.
• GoalNear(x, y, z, range): Get within a certain radius of this block position.
• GoalXZ(x, z): Reach a specific X and Z coordinate (ignores Y level).
• GoalNearXZ(x, z, range): Reach an approximate X and Z coordinate within a range.
• GoalY(y): Reach a specific Y level.
• GoalGetToBlock(x, y, z): Get directly adjacent to the block (useful for interacting with chests).

Interaction & Entity Goals

• GoalFollow(entity, range): Follow a specific entity within a given range.
• GoalLookAtBlock(pos, world, options): Path to a position where a blockface at pos is visible.
  • options.reach: Max distance from the clicked face (Default: 4.5).
  • options.entityHeight: Default 1.6.
• GoalPlaceBlock(pos, world, options): Position the bot to place a block at pos.
  • options.range: Max distance from the clicked face.
  • options.faces: Allowed click directions.
  • options.facing: Required direction the player must face.
  • options.facing3D: Boolean for 3D vs 2D facing.
  • options.half: 'top' or 'bottom' half to click.

Composite Goals

• GoalCompositeAny(Array<Goal>): Satisfied if any one of the provided goals is met.
• GoalCompositeAll(Array<Goal>): Satisfied only if all provided goals are met.
• GoalInvert(goal): Inverts the logic of the provided goal.

The Movements class is used to configure how the bot traverses terrain. When you instantiate Movements(bot), it sets up default behaviors for digging, placing, and traversing different types of blocks and entities. You can customize these behaviors by modifying the properties on the Movements instance.

Key Configuration Properties

Costs

Adjust these to influence the pathfinder's preference for certain actions:

• digCost: Cost of digging a block.
• placeCost: Cost of placing a block.
• liquidCost: Cost of moving through liquid.
• entityCost: Cost of moving through/near entities.

Capabilities

Enable or disable specific movement types:

• canDig: Whether the bot is allowed to dig blocks.
• allow1by1towers: Whether the bot can build 1x1 towers to climb.
• allowFreeMotion: Whether the bot can move freely (not standard).
• allowParkour: Whether the bot can perform parkour jumps.
• allowSprinting: Whether the bot can sprint.
• allowEntityDetection: Whether the bot detects entities to avoid them.
• canOpenDoors: Whether the bot attempts to open gates/doors (Note: may cause issues on some servers).

Constraints

• dontCreateFlow: If true, the bot avoids digging blocks adjacent to liquids to prevent flowing water/lava.
• dontMineUnderFallingBlock: If true, the bot avoids digging blocks that are supporting falling blocks or entities.
• maxDropDown: The maximum distance the bot is willing to drop down (default: 4).
• infiniteLiquidDropdownDistance: If true, ignores maxDropDown when dropping into liquids.

To use the pathfinder, load the plugin into your bot, define a Movements instance, and set a Goal. In this example, the bot will move to a player when they type 'come' in chat.

const mineflayer = require('mineflayer')
const pathfinder = require('mineflayer-pathfinder').pathfinder
const Movements = require('mineflayer-pathfinder').Movements
const { GoalNear } = require('mineflayer-pathfinder').goals
const bot = mineflayer.createBot({ username: 'Player' })

bot.loadPlugin(pathfinder)

bot.once('spawn', () => {
  const defaultMove = new Movements(bot)
  
  bot.on('chat', function(username, message) {
  
    if (username === bot.username) return

    const target = bot.players[username] ? bot.players[username].entity : null
    if (message === 'come') {
      if (!target) {
        bot.chat('I don\'t see you !')
        return
      }
      const p = target.position

      bot.pathfinder.setMovements(defaultMove)
      bot.pathfinder.setGoal(new GoalNear(p.x, p.y, p.z, 1))
    } 
  })
})