Skip to content

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

Notifications You must be signed in to change notification settings

Kupferhirn/mineflayer

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mineflayer

Join the chat at https://gitter.im/PrismarineJS/node-minecraft-protocol

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

Note: This project is in the process of being updated. Bear with us :)

Features

  • Supports Minecraft 1.8.3.
  • 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

Echo Example

var mineflayer = require('mineflayer');
var bot = mineflayer.createBot({
  host: "localhost", // optional
  port: 25565,       // optional
  username: "[email protected]", // 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

Linux / OSX

npm install mineflayer

Windows

  1. Follow the Windows instructions from node-minecraft-protocol
  2. npm install mineflayer

Documentation

Testing

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.

About

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

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%