mineflayer-blockfinder

v0.0.7

mineflayer plugin which gives bots a function to find the nearest block

NPM

README

GitHub

Website

MIT

Latest version published 4 years ago

    npm install mineflayer-blockfinder

We couldn't find any similar packages Browse all packages

Package Health Score

42 / 100

Popularity
Limited
Maintenance
Inactive
Security
No known security issues
Community
Limited

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (39)

Dependents: 2
GitHub Stars: 15
Forks: 6
Contributors: 4

The npm package mineflayer-blockfinder receives a total of 39 downloads a week. As such, we scored mineflayer-blockfinder popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package mineflayer-blockfinder, we found that it has been starred 15 times, and that 2 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

0.0.7

Indirect Vulnerabilities

0.0.7

License Risks

0.0.7

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like mineflayer-blockfinder is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like mineflayer-blockfinder is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test mineflayer-blockfinder

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 3
Merged PR: 5
Open PR: 1
Last Commit: 3 years ago

Further analysis of the maintenance status of mineflayer-blockfinder based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for mineflayer-blockfinder is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 4
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like mineflayer-blockfinder is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 8 years
Dependencies: 2 Direct
Versions: 9
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 1
TS Typings: No

mineflayer-blockfinder has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

mineflayer-blockfinder

A library to help your mineflayer bot find blocks in the 3D world.

See mineflayer.

Usage

var mineflayer = require('mineflayer');
var blockFinderPlugin = require('mineflayer-blockfinder')(mineflayer);
var bot = mineflayer.createBot({username: 'Player'});

// Install the plugin
blockFinderPlugin(bot);

// Sample usage
bot.once('spawn', function() {
  bot.findBlock({
    point: bot.entity.position,
    matching: 56,
    maxDistance: 256,
    count: 1,
  }, function(err, blocks) {
    if (err) {
      return bot.chat('Error trying to find Diamond Ore: ' + err);
      bot.quit('quitting');
      return;
    }
    if (blocks.length) {
      bot.chat('I found a Diamond Ore block at ' + blocks[0].position + '.');
      bot.quit('quitting');
      return;
    } else {
      bot.chat("I couldn't find any Diamond Ore blocks within 256.");
      bot.quit('quitting');
      return;
    }
  });
});

Dependencies

Mineflayer

Installation

npm install mineflayer-blockfinder

Or clone and cd into the directory

npm install .

Windows: You will need to install:

Python 2.5+ (but < 3.0): https://www.python.org/downloads/
Visual C++ 2015 build tools: https://landinghub.visualstudio.com/visual-cpp-build-tools
A version of Visual Studio: https://www.visualstudio.com/vs/community/
An older version of OpenSSL (bitness needs to match your installation of nodejs)

** 64-bit: https://slproweb.com/download/Win64OpenSSL-1_0_2k.exe

** 32-bit: https://slproweb.com/download/Win32OpenSSL-1_0_2k.exe

Documentation

bot.findBlock(options, callback)

Finds the nearest block(s) to the given point.

options - Additional options for the search:
- point - The start position of the search.
- matching - A function that returns true if the given block is a match. Also supports this value being a block id or array of block ids.
- maxDistance - The furthest distance for the search, defaults to 64.
- count - The number of blocks to find at most, defaults to 1.
callback - A callback function to get the result. Function signature:

function(err, arrayOfPoints)

bot.findBlockSync(options)

Finds the nearest block(s) to the given point synchronously.

options - See bot.findBlock.

History

0.0.7

DiamondFinder tested working, fix another issue related to recursion.

0.0.6

Fix recursion issue (thanks to rom1504)

0.0.5

Added new OctahedronIterator class, a fast finder algorithm that always returns the closest block, and is comparable with the cube algorithm.

0.0.4

Reverted algorithm to use the old, fast cube algorithm.

0.0.3

Fix 'matching' option to allow for array of ids instead of crashing.

0.0.2

Refactored algorithm to use an Iterator approach, to allow for re-useable code.
Rewrote block finding algorithm to guarantee the closest block is always found first.
Matching argument now takes an array of block ids, instead of block enums.