mineflayer-viaproxy

A mineflayer plugin that allows you to connect to a server through a ViaVersion proxy.

Why? Because I'm tired of people asking for version updates.

If you have issues, join here for support. Alternatively, here for general mineflayer support.

Prerequisites

• Node.js v16 or higher
• Java Runtime Environment (JRE) installed and accessible via command line, preferably version 17 or higher.

TODOS

• [x] Support bedrock versions
• [x] Support adding accounts to ViaProxy gracefully.
• [x] Make fix for prismarine-registry more robust (see patches)
• [ ] Add support for more ViaVersion options
• [x] Add support for more ViaProxy options
• [x] Support Python

Installation

npm install mineflayer-viaproxy

Usage

Basic usage is simple. Just use createBot from this package instead of mineflayer.createBot.

Note! createBot is now asynchronous and must be awaited. This is because it needs to set up the ViaProxy before the bot can connect.

Additionally: the username must now STRICTLY match the in-game username of the account you want to use. This is because ViaProxy needs to authenticate with Mojang/Microsoft using that account's credentials, and the bot needs to use that account's credentials to connect to the server through ViaProxy.

const { createBot } = require('mineflayer-viaproxy')

// only difference is that this must be awaited now.
const bot = await createBot({...})

// if you want to pass viaProxy options, it'd be like so:

const orgBotOpts = {...}
const viaProxyOpts = {...}

// same object. 
const bot = await createBot({...orgBotOpts, ...viaProxyOpts});

More examples can be found in the examples/ folder.

Debugging

This package uses the debug library for logging. To enable debug output, set the DEBUG environment variable to include mineflayer-viaproxy.

Examples:

Enable all mineflayer-viaproxy logs:

# On Windows (PowerShell)
$env:DEBUG = "mineflayer-viaproxy:*"; node your-script.js

# On Windows (Command Prompt)
set DEBUG=mineflayer-viaproxy:* && node your-script.js

# On macOS/Linux
DEBUG=mineflayer-viaproxy:* node your-script.js

Enable specific module logs:

# macOS/Linux
DEBUG=mineflayer-viaproxy:openAuthMod node your-script.js

# Windows (PowerShell)
$env:DEBUG = "mineflayer-viaproxy:openAuthMod"; node your-script.js

Enable logs from multiple packages:

# macOS/Linux
DEBUG=mineflayer-viaproxy:*,minecraft-protocol node your-script.js

For more information on the debug library and its patterns, see the debug documentation.

API

Types

AuthType

export enum AuthType {
    NONE = "NONE",
    OPENAUTHMOD = "OPENAUTHMOD",
    ACCOUNT = "ACCOUNT",
}

| Name | Value | Description | | ------------- | --------------- | ---------------------------------------------- | | NONE | "NONE" | No authentication | | OPENAUTHMOD | "OPENAUTHMOD" | OpenAuthMod authentication | | ACCOUNT | "ACCOUNT" | Account authentication (requires manual setup) |

ViaProxyOpts

export interface ViaProxyOpts {
    forceViaProxy?: boolean;
    javaPath?: string;
    javaArgs?: string[];
    localPort?: number;
    localAuth?: AuthType;
    viaProxyLocation?: string;
    viaProxyWorkingDir?: string;
    autoUpdate?: boolean;
    viaProxyConfig?: Partial<ViaProxyConfig>;
    viaProxyStdoutCb?: (data: any) => void;
    viaProxyStderrCb?: (data: any) => void;
}

| Name | Type | Default | Description | | -------------------- | ------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | forceViaProxy | boolean | false | Whether or not to force the use of ViaProxy. If set to true, it will always use ViaProxy regardless of the server version. | | javaPath | string | "java" | The path to the java executable. | | javaArgs | string[] | [] | Raw Java arguments to be passed directly. | localPort | number | auto determined | The port to listen on for the local server. If none is specified, it will automatically locate an open port for you on your computer. | | localAuth | AuthType | AuthType.NONE | The authentication type to use for the local server. | | viaProxyLocation | string | "" | The location of the ViaVersion proxy jar. If none specified, it will download automatically to the CWD + viaproxy. | | viaProxyWorkingDir | string | "" | The working directory for the ViaVersion proxy. If none specified, it will use the CWD + viaproxy. | | autoUpdate | boolean | true | Whether or not to automatically update the ViaVersion proxy. | | viaProxyConfig | Partial<ViaProxyConfig> | undefined | Configuration options for ViaProxy. | | viaProxyStdoutCb | (data: any) => void | undefined | A callback for the stdout of the ViaVersion proxy. | | viaProxyStderrCb | (data: any) => void | undefined | A callback for the stderr of the ViaVersion proxy. |

ViaProxyConfig

export interface ViaProxyConfig {
    backendProxyUrl: string;
    [key: string]: string | number | boolean;
}

| Name | Type | Description | | | | ----------------- | ------- | ----------------------------------------------------------------------------------- | -------- | ---------------------------------------------- | | backendProxyUrl | string | The URL of the backend proxy to connect to. If none specified, it will not use one. | | | | [key: string] | string \| number \| boolean | Additional configuration options for ViaProxy. |