Create Minecraft bots with a powerful, stable, and high level JavaScript API.
JavaScript
Latest commit dc37892 Nov 15, 2017
rom1504 committed Nov 15, 2017 Merge pull request #614 from jeresuikkila/patch-1
Update sound.js to include hardcoded sound effects

README.md

Mineflayer

NPM version Build Status Join the chat at https://gitter.im/PrismarineJS/mineflayer Greenkeeper badge

Create Minecraft bots with a powerful, stable, and high level JavaScript API.

Features

  • Supports Minecraft 1.8, 1.9, 1.10, 1.11 and 1.12.
  • Entity knowledge and tracking.
  • Block knowledge. You can query the world around you.
  • Basic physics and movement - currently blocks are either "solid" or "empty".
  • Attacking entities and using vehicles.
  • Inventory management.
  • Crafting, chests, dispensers, enchantment tables.
  • Digging and building.
  • Miscellaneous stuff such as knowing your health and whether it is raining.
  • Activating blocks and using items.
  • Chat.

Roadmap

  • Brewing stands, and anvils.
  • Better physics (support doors, ladders, water, etc).

Usage

Without version specified, the version of the server will be guessed automatically, you can set a specific one using the version option. For example version:"1.8".

Echo Example

var mineflayer = require('mineflayer');
var bot = mineflayer.createBot({
  host: "localhost", // optional
  port: 25565,       // optional
  username: "email@example.com", // email and password are required only for
  password: "12345678",          // online-mode=true servers
});
bot.on('chat', function(username, message) {
  if (username === bot.username) return;
  bot.chat(message);
});

More Examples

Third Party Plugins

Mineflayer is pluggable; anyone can create a plugin that adds an even higher level API on top of Mineflayer.

Projects Using Mineflayer

Installation

npm install mineflayer

Documentation

Testing

Some setup is required after first cloning the project but after that is done it's very easy to run them.

Setup

In order to get all tests to run successfully you must first:

  1. create a new folder in which to store minecraft server jars
  2. set the MC_SERVER_JAR_DIR to this folder

Example:

  1. mkdir server_jars
  2. export MC_SERVER_JAR_DIR=/full/path/to/server_jars

Where the "/full/path/to/" is the fully qualified path name.

Ongoing

Simply run: npm test

Updating to a newer protocol version

  1. Wait for a new version of node-minecraft-protocol to be released which supports the new Minecraft version.
  2. npm install --save minecraft-protocol@latest
  3. Apply the protocol changes where necessary.
  4. Run the test suite. See Testing above.

Licence

MIT