mineflayer-collectblock's Introduction

mineflayer-collectblock

A small utility plugin for allowing users to collect blocks using a higher level API.

Showcase

You can see a video of the plugin in action, here. The source code of the bot in the video can be seen in the examples folder, here.

Getting Started

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

npm install --save mineflayer-collectblock

Simple Bot

The brief description goes here.

// Create your bot
const mineflayer = require("mineflayer")
const bot = mineflayer.createBot({ username: "Player" })

// Load collect block
bot.loadPlugin(require('mineflayer-collectblock').plugin)

function collectGrass() {
  // Find a nearby grass block
  const grass = bot.findBlock({
    matching: require('minecraft-data').blocksByName.grass_block.id,
    maxDistance: 64
  })

  if (grass) {
    // If we found one, collect it.
    bot.collectBlock.collect(grass, err => {
      if (err) // Handle errors, if any
        console.log(err)
      else
        collectGrass() // Collect another grass block
    })
  }
}

// On spawn, start collecting all nearby grass
bot.once('spawn', collectGrass)

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.

Recommend Projects