prismarinejs / mineflayer-tool

A tool/weapon selection Mineflayer plugin for automatically selecting the best tool to use for a specific task.

Mineflayer-Tool

A tool/weapon selection Mineflayer plugin for automatically selecting the best tool to use for a specific task.

---

Getting Started

This plugin is built using Node and can be installed using:

npm install --save mineflayer-tool

Simple Bot

The brief description goes here.

const mineflayer = require('mineflayer')
const toolPlugin = require('mineflayer-tool').plugin

const bot = mineflayer.createBot({ username: 'MiningTool_Bot' })
bot.loadPlugin(toolPlugin)

bot.on('spawn', async () => {
  const blockPos = bot.entity.position.offset(0, -1, 0)
  const block = bot.blockAt(blockPos)

  await bot.tool.equipForBlock(block, {})
  await bot.dig(block)
 })

Documentation

API

Examples

License

This project uses the MIT license.

Contributions

This project is accepting PRs and Issues. See something you think can be improved? Go for it! Any and all help is highly appreciated!

For larger changes, it is recommended to discuss these changes in the issues tab before writing any code. It's also preferred to make many smaller PRs than one large one, where applicable.

mineflayer-tool's Issues

Add option for estimating uses remaining before collecting a tool

It would be helpful to add an option for "expect 10 uses" on tool selection. This would allow for the bot to go and get a tool from a chest, for example, if it still has a tool, but the tool is expected to break before it's finished collecting everything.

Promisify

Since Mineflayer has officially finished promisifing the codebase, all Mineflayer plugins should also start moving in that direction.

Add option to grab tools from a chest

If the bot does not currently have a suitable tool or weapon, the bot should be able to automatically retrieve them from a specified chest list.

Add configurable Movements to be applied when moving to a chest

This plugin should allow for a custom movement configuration to be injected when using the pathfinding element.

Should make it much easier to control how pathfinding is applied when retrieving tools.

Add weapon support

Add support for equipping weaponsto attack a mob with.

Add option to prevent a tool from being used until broken.

This would allow for tools to be used until it only has 1 durability left, then it would not be allowed to be used anymore. Useful when you have highly enchanted tools you want to repair using mending or similar.

Install standard

Can't use 1.2.0 in mineflayer 4.14.0. Need to Update

As the title

Bot does not return to previous location after retrieving an item from a chest

After walking to a chest to get an item, the bot should walk back to its original location.

Add "expectedDrop" option to equipForBlock

This can be used to have the bot automatically prefer to choose to use silk touch tools or non-silk touch tools as needed to retrieve a specific item drop. Such as equipping a silk touch pickaxe when mining stone and expected a stone drop, or switching to a standard pickaxe if a cobblestone is expected.

Prevent a wrong tool from being selected if it would use up durablity.

In a situation where the bot has no tools that can harvest the target block, use a non-tool item to avoid using up durability.