Mineflayer

https://prismarinejs.github.io/mineflayer/
Admin
Mineflayer is a powerful, stable, and high-level JavaScript API for creating Minecraft bots, also...
Tokens:2,213
Snippets:19
Trust Score:8.3
Update:8 months ago
Show doc for...
Tokens:
Raw
### Install Mineflayer using npm

Source: https://prismarinejs.github.io/mineflayer/index

This command installs the Mineflayer package and its dependencies using npm, the Node.js package manager. Ensure Node.js version 18 or higher is installed first.

```bash
npm install mineflayer
```

--------------------------------

### Visualize Mineflayer bot activity with prismarine-viewer in JavaScript

Source: https://prismarinejs.github.io/mineflayer/index

This JavaScript code integrates prismarine-viewer with a Mineflayer bot to provide a live, in-browser visualization of the bot's actions. It requires installing `prismarine-viewer` and adds a listener for the bot's spawn event.

```javascript
const { mineflayer: mineflayerViewer } = require('prismarine-viewer')
bot.once('spawn', () => {
  mineflayerViewer(bot, { port: 3007, firstPerson: true }) // port is the minecraft server port, if first person is false, you get a bird's-eye view
})
```

--------------------------------

### Run All Tests with npm

Source: https://prismarinejs.github.io/mineflayer/index

Execute all tests for the Mineflayer project using the npm test command. This is the standard way to ensure the project's integrity.

```bash
npm test

```

--------------------------------

### Run Specific Minecraft Version Tests with npm

Source: https://prismarinejs.github.io/mineflayer/index

Run tests for a specific Minecraft version using the npm run mocha_test command with the -g flag followed by the version number. This allows for targeted testing.

```bash
npm run mocha_test -- -g <version>

```

--------------------------------

### Run Specific Test for a Version with npm

Source: https://prismarinejs.github.io/mineflayer/index

Run a specific test for a particular Minecraft version by combining the version and test name with the npm run mocha_test command and the -g flag. This provides highly granular testing capabilities.

```bash
npm run mocha_test -- -g "1.18.1.*BlockFinder"

```

--------------------------------

### Enable Protocol Debugging with DEBUG Environment Variable

Source: https://prismarinejs.github.io/mineflayer/index

This snippet demonstrates how to enable detailed protocol debugging output for Mineflayer by setting the DEBUG environment variable. This is useful for troubleshooting network-related issues. The command varies slightly between Unix-like systems and Windows.

```bash
DEBUG="minecraft-protocol" node [...]
```

```batch
set DEBUG=minecraft-protocol
node your_script.js
```

--------------------------------

### Run Specific Test by Name with npm

Source: https://prismarinejs.github.io/mineflayer/index

Execute a particular test by its name using the npm run mocha_test command with the -g flag followed by the test name. This is useful for debugging specific functionalities.

```bash
npm run mocha_test -- -g <test_name>

```

--------------------------------

### Create a basic Mineflayer bot in JavaScript

Source: https://prismarinejs.github.io/mineflayer/index

This JavaScript code snippet demonstrates how to create a basic Mineflayer bot. It connects to a Minecraft server, echoes chat messages, and logs errors. It supports different authentication methods, including Microsoft authentication.

```javascript
const mineflayer = require('mineflayer')

const bot = mineflayer.createBot({
  host: 'localhost', // minecraft server ip
  username: 'Bot', // username to join as if auth is `offline`, else a unique identifier for this account. Switch if you want to change accounts
  auth: 'microsoft' // for offline mode servers, you can set this to 'offline'
  //port: 25565,              // set if you need a port that isn't 25565
  //version: false,           // only set if you need a specific version or snapshot (ie: "1.8.9" or "1.16.5"), otherwise it's set automatically
  //password: '12345678'      // set if you want to use password-based auth (may be unreliable). If specified, the `username` must be an email
})

bot.on('chat', (username, message) => {
  if (username === bot.username) return
  bot.chat(message)
})

// Log errors and kick reasons:
bot.on('kicked', console.log)
bot.on('error', console.log)
```

--------------------------------

### Update Mineflayer using npm

Source: https://prismarinejs.github.io/mineflayer/index

This command updates the Mineflayer package and its dependencies to their latest compatible versions. It's a standard npm command for package management.

```bash
npm update
```

--------------------------------

### Connect Mineflayer bot to a Minecraft Realm in JavaScript

Source: https://prismarinejs.github.io/mineflayer/index

This JavaScript snippet shows how to configure a Mineflayer bot to connect to a Minecraft Realm. It requires the bot's email address for authentication and a function to select the desired Realm from a list of available ones.

```javascript
const client = mineflayer.createBot({
  username: 'email@example.com', // minecraft username
  realms: {
    // This function is called with an array of Realms the account can join. It should return the one it wants to join.
    pickRealm: (realms) => realms[0]
  },
  auth: 'microsoft'
})
```
Tokens:
Raw