darcros / node-minecraft-proxy

Simple Minecraft proxy written in Node.js using the node-minecraft-protocol library

node-minecraft-proxy

Simple Minecraft proxy written in Node.js using the node-minecraft-protocol library

• node-minecraft-proxy
  • Features
  • Installation
  • Examples
    • Creating a proxy
    • Moving players from a server to another
  • Documentation

Features

• Connect to proxy
• Forward players to servers
• Change server
• Basic plugin support, see ./src/Plugins/ChatCommands.js for an example

Installation

npm install basic-minecraft-proxy

Examples

See also ./examples/ for other examples

Creating a proxy

This example shows how to create a new proxy and how to the options are passed.

const McProxy = require('minecraft-proxy');

let localServerOptions = {
  'port': '25578',
  'version': '1.12.1',
  'online-mode': false,
  'motd': 'nodejs minecraft proxy'
}

let serverList = {
  hub: {
    host: 'localhost',
    port: 25565,
    isDefault: true,
    isFallback: true
  },
  minigames: {
    host: 'localhost',
    port: 25566
  }
}

// if you leave proxyOptions empty yo may as well not pass it in the arguments, I wrote it anyway to point out that it exist
let proxyOptions = {}

/*
  Use the "/server <serverName>" command in chat to move between servers.
  <serverName> is the name that you chose for the server inside the serverList
  This command is implemented by /src/Plugins/ChatCommands.js and it can be disabled by setting enablePlugin: false inside proxyOptions
*/
let proxy = McProxy.createProxy(localServerOptions, serverList, proxyOptions);

proxy.on('error', console.error);

proxy.on('listening', () => {
  console.info('Listening!');
});

Moving players from a server to another

In this example every player will be moved from the hub server (default) to the minigames server 30 seconds after having logged in.

proxy.on('login', (player) => {
  setTimeout(() => {
    proxy.setRemoteServer(player.id, "minigames");
  }, 30 * 1000);
});

Documentation

See the wiki.

node-minecraft-proxy's Issues

Online mode

It doesn' t work with online-mode set to true.

List of events and packets

Is there any list of parameters for:

1. proxy.on,
2. client.on, and
3. client.write

Failed to verify username!

Hi, I lauched your proxy example and got the following error on my hub server:

lost connection: Failed to verify username!

as for the proxy:

Connection lost, timed out

Did I do something wrong? thx

Dynamicly add servers

How can I add a server after the proxy has started?

我都已经安装好了，请问如何启动

我都已经安装好了，请问如何启动

IN FORGE

I used ts to rewrite the client of setremoteserver, but it seems that the protocol is manually configured by the replay method and will not be forwarded, so players cannot join the forge server. Can you help me explain your idea

Get player hostname

For example if I have two domains for my server: play.server.com and survival.server.com.

How can I make that if the player joins via the survival.server.com domain that the player automatically get sent to the Survival.

And if the players connects via play.server.com, it gets sent to the default server.

proxy.setRemoteServer(player.id, "minigames"); says "Expected text to be a string, was an object"

How can I fix this?