mirror of
https://github.com/minescope/mineping.git
synced 2025-07-12 18:54:38 +03:00
Compare commits
23 Commits
Author | SHA1 | Date | |
---|---|---|---|
838ffc497a
|
|||
502029869a
|
|||
e3e7e293ed
|
|||
88ad92e59d
|
|||
009f542c55
|
|||
0b0bed4e71
|
|||
fa4c34d896
|
|||
296294ca96
|
|||
9d25aaf4ea
|
|||
c735604c38
|
|||
afdaa9eb3e
|
|||
435899309f | |||
13e6b8c6ff | |||
d7256eabe7
|
|||
afa2c3025f
|
|||
6c297d0b8c
|
|||
283e9b32c6 | |||
354fa212a6 | |||
d9bf4cfb3f | |||
9dace3748b
|
|||
0aa73655b1
|
|||
78ca03b004
|
|||
910184bf5f
|
@ -1,6 +1,6 @@
|
|||||||
# mineping
|
# mineping
|
||||||
|
|
||||||
`mineping` is a Javasript library thar provides Minecraft server ping protocol implementation. It can be used to collect information about the server, such as MODT, current online, server icon (java edition only) and etc.
|
This JavaScript library provides an implementation of the Minecraft server ping protocol. **It allows you to gather information about a Minecraft server**, such as the MOTD, current online players, server icon (Java Edition only), and more.
|
||||||
|
|
||||||
Mirror on my [<img src="https://git.zeldon.ru/assets/img/logo.svg" align="center" width="20" height="20"/> Git](https://git.zeldon.ru/zeldon/mineping)
|
Mirror on my [<img src="https://git.zeldon.ru/assets/img/logo.svg" align="center" width="20" height="20"/> Git](https://git.zeldon.ru/zeldon/mineping)
|
||||||
|
|
||||||
@ -10,6 +10,8 @@ Mirror on my [<img src="https://git.zeldon.ru/assets/img/logo.svg" align="center
|
|||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
|
To install `mineping`, simply run the following command:
|
||||||
|
|
||||||
```
|
```
|
||||||
npm i @minescope/mineping
|
npm i @minescope/mineping
|
||||||
```
|
```
|
||||||
@ -17,6 +19,7 @@ npm i @minescope/mineping
|
|||||||
## Loading and configuration the module
|
## Loading and configuration the module
|
||||||
|
|
||||||
### ES Modules (ESM)
|
### ES Modules (ESM)
|
||||||
|
If you are using ES Modules, you can import the library like this:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { pingJava, pingBedrock } from '@minescope/mineping';
|
import { pingJava, pingBedrock } from '@minescope/mineping';
|
||||||
@ -59,5 +62,7 @@ console.log(data);
|
|||||||
|
|
||||||
## Acknowledgements
|
## Acknowledgements
|
||||||
|
|
||||||
|
Special thanks to the following projects:
|
||||||
|
|
||||||
- [mcping](https://github.com/Scetch/mcping) crate for Rust
|
- [mcping](https://github.com/Scetch/mcping) crate for Rust
|
||||||
- [mcping-js](https://github.com/Cryptkeeper/mcping-js) library for quering Minecraft Java Edition servers
|
- [mcping-js](https://github.com/Cryptkeeper/mcping-js) library for quering Minecraft Java Edition servers
|
||||||
|
@ -1,19 +1,15 @@
|
|||||||
|
/**
|
||||||
|
* Usage examples:
|
||||||
|
* - Java (with custom timeout): node cli.js -j --host="mc.hypixel.net" --timeout 1000
|
||||||
|
* - Bedrock: node cli.js -b --host="play.timecrack.net"
|
||||||
|
*/
|
||||||
|
|
||||||
import { pingBedrock, pingJava } from '../index.js';
|
import { pingBedrock, pingJava } from '../index.js';
|
||||||
|
|
||||||
const args = getArgs();
|
const args = getArgs();
|
||||||
|
|
||||||
if (args.help || args.h || Object.keys(args).length === 0) {
|
if (shouldShowHelp(args)) {
|
||||||
console.log(`node cli.js [..]
|
printHelp();
|
||||||
A simple to use, efficient, and full-featured Minecraft server info parser!
|
|
||||||
|
|
||||||
USAGE:
|
|
||||||
node cli.js [OPTIONS] --host <HOST> --port <PORT> --timeout <TIMEOUT>
|
|
||||||
|
|
||||||
OPTIONS:
|
|
||||||
-j Use for Minecraft Java Edition
|
|
||||||
-b Use for Minecraft Bedrock Edition
|
|
||||||
P.S. Don't use them at the same time!`);
|
|
||||||
|
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -24,6 +20,42 @@ if (!args.host) {
|
|||||||
|
|
||||||
// easter egg <3
|
// easter egg <3
|
||||||
if (args.j && args.b) {
|
if (args.j && args.b) {
|
||||||
|
printInterestingFacts();
|
||||||
|
process.exit(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
const port = args.port || getDefaultPort(args);
|
||||||
|
const timeout = args.timeout || 500;
|
||||||
|
|
||||||
|
if (args.j) {
|
||||||
|
await pingJavaServer(args.host, port, timeout)
|
||||||
|
.catch(err => console.error(`ERROR: ${err.message}`));
|
||||||
|
} else if (args.b) {
|
||||||
|
await pingBedrockServer(args.host, port, timeout)
|
||||||
|
.catch(err => console.error(`ERROR: ${err.message}`));
|
||||||
|
} else {
|
||||||
|
console.error('ERROR: Unsupported flag passed. Use -h or --help.');
|
||||||
|
}
|
||||||
|
|
||||||
|
function shouldShowHelp(args) {
|
||||||
|
return args.help || args.h || Object.keys(args).length === 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
function printHelp() {
|
||||||
|
console.log(`node cli.js [..]
|
||||||
|
A simple to use, efficient, and full-featured Minecraft server info parser!
|
||||||
|
|
||||||
|
USAGE:
|
||||||
|
node cli.js [OPTIONS] --host <HOST> --port <PORT> --timeout <TIMEOUT>
|
||||||
|
|
||||||
|
OPTIONS:
|
||||||
|
-j Use for Minecraft Java Edition
|
||||||
|
-b Use for Minecraft Bedrock Edition
|
||||||
|
|
||||||
|
P.S. Don't use them at the same time!`);
|
||||||
|
}
|
||||||
|
|
||||||
|
function printInterestingFacts() {
|
||||||
console.log(`Some interesting facts about MOTDs on bedrock:
|
console.log(`Some interesting facts about MOTDs on bedrock:
|
||||||
- so far they seem to exclusively use legacy color codes
|
- so far they seem to exclusively use legacy color codes
|
||||||
- the random style has a special impl for periods, they turn into animated
|
- the random style has a special impl for periods, they turn into animated
|
||||||
@ -31,25 +63,20 @@ if (args.j && args.b) {
|
|||||||
- motd_2 is ignored? client displays "motd_1 - v{version}", where the
|
- motd_2 is ignored? client displays "motd_1 - v{version}", where the
|
||||||
appended version text is considered part of motd_1 for color code processing
|
appended version text is considered part of motd_1 for color code processing
|
||||||
- motd_2 seems to mainly be used to return the server software in use (e.g. PocketMine-MP)`);
|
- motd_2 seems to mainly be used to return the server software in use (e.g. PocketMine-MP)`);
|
||||||
process.exit(0);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (args.j) {
|
function getDefaultPort(args) {
|
||||||
const data = await pingJava(args.host, {
|
return args.j ? 25565 : 19132;
|
||||||
port: args.port || 25565,
|
}
|
||||||
timeout: args.timeout || 500
|
|
||||||
});
|
|
||||||
|
|
||||||
console.log(`host: ${args.host}\nprotocol: ${data.version.protocol}\nonline: ${data.players.online}`);
|
async function pingJavaServer(host, port, timeout) {
|
||||||
} else if (args.b) {
|
const data = await pingJava(host, { port, timeout });
|
||||||
const data = await pingBedrock(args.host, {
|
console.log(`host: ${host}\nprotocol: ${data.version?.protocol}\nonline: ${data.players?.online}`);
|
||||||
port: args.port || 19132,
|
}
|
||||||
timeout: args.timeout || 500
|
|
||||||
});
|
|
||||||
|
|
||||||
console.log(`host: ${args.host}\nprotocol: ${data.version.protocol}\nonline: ${data.players.online}`);
|
async function pingBedrockServer(host, port, timeout) {
|
||||||
} else {
|
const data = await pingBedrock(host, { port, timeout });
|
||||||
console.error('ERROR: Unsupported flag passed. Use -h or --help.');
|
console.log(`host: ${host}\nprotocol: ${data.version.protocol}\nonline: ${data.players.online}`);
|
||||||
}
|
}
|
||||||
|
|
||||||
// parsing command line arguments
|
// parsing command line arguments
|
||||||
|
@ -1,10 +1,20 @@
|
|||||||
import { pingBedrock } from '../index.js';
|
import { pingBedrock } from '../index.js';
|
||||||
|
|
||||||
const [thehive, oasys, frizmine, breadix] = await Promise.allSettled([
|
const hosts = [
|
||||||
pingBedrock('geo.hivebedrock.network'),
|
'play.timecrack.net',
|
||||||
pingBedrock('oasys-pe.com'),
|
'geo.hivebedrock.network',
|
||||||
pingBedrock('frizmine.ru'),
|
'oasys-pe.com',
|
||||||
pingBedrock('play.breadixpe.ru')
|
'play.galaxite.net',
|
||||||
]);
|
];
|
||||||
|
|
||||||
console.dir({ thehive, oasys, frizmine, breadix }, { depth: 3 });
|
const pingPromises = hosts.map(host => pingBedrock(host));
|
||||||
|
const results = await Promise.allSettled(pingPromises);
|
||||||
|
|
||||||
|
for (let result of results) {
|
||||||
|
if (result.status === 'rejected') {
|
||||||
|
console.error(result.reason);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(result.value);
|
||||||
|
}
|
5
example/single.js
Normal file
5
example/single.js
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
import { pingBedrock } from "../index.js";
|
||||||
|
|
||||||
|
const host = "mc.nevertime.su";
|
||||||
|
const ping = await pingBedrock(host);
|
||||||
|
console.log(ping);
|
177
lib/bedrock.js
177
lib/bedrock.js
@ -1,124 +1,61 @@
|
|||||||
/**
|
/**
|
||||||
* Implementation of the RakNet ping/pong protocol.
|
* Implementation of the RakNet ping/pong protocol.
|
||||||
* @see https://wiki.vg/Raknet_Protocol#Unconnected_Ping
|
* @see https://wiki.vg/Raknet_Protocol
|
||||||
*
|
|
||||||
* Data types:
|
|
||||||
* @see https://wiki.vg/Raknet_Protocol#Data_types
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
import dgram from 'dgram';
|
import dgram from 'node:dgram';
|
||||||
|
import crypto from 'node:crypto'
|
||||||
|
|
||||||
|
const MAGIC = "00ffff00fefefefefdfdfdfd12345678";
|
||||||
const START_TIME = new Date().getTime();
|
const START_TIME = new Date().getTime();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a buffer with the specified length.
|
* Creates an Unconnected Ping packet.
|
||||||
* @param {number} length - The length of the buffer.
|
* @param {number} pingId
|
||||||
* @returns {Buffer} - The created buffer.
|
* @returns {Buffer}
|
||||||
*/
|
|
||||||
const createBuffer = (length) => {
|
|
||||||
const buffer = Buffer.alloc(length);
|
|
||||||
buffer[0] = 0x01;
|
|
||||||
return buffer;
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Writes a BigInt value to the buffer at the specified offset using big-endian byte order.
|
|
||||||
* @param {Buffer} buffer - The buffer to write to.
|
|
||||||
* @param {number} value - The BigInt value to write.
|
|
||||||
* @param {number} offset - The offset in the buffer to write the value.
|
|
||||||
*/
|
|
||||||
const writeBigInt64BE = (buffer, value, offset) => {
|
|
||||||
buffer.writeBigInt64BE(BigInt(value), offset);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Copies the specified hex value to the buffer at the specified offset.
|
|
||||||
* @param {Buffer} buffer - The buffer to copy to.
|
|
||||||
* @param {string} hex - The hex value to copy.
|
|
||||||
* @param {number} offset - The offset in the buffer to copy the value.
|
|
||||||
*/
|
|
||||||
const copyHexToBuffer = (buffer, hex, offset) => {
|
|
||||||
Buffer.from(hex, 'hex').copy(buffer, offset);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Reads a BigInt value from the buffer at the specified offset using big-endian byte order.
|
|
||||||
* @param {Buffer} buffer - The buffer to read from.
|
|
||||||
* @param {number} offset - The offset in the buffer to read the value.
|
|
||||||
* @returns {BigInt} - The read BigInt value.
|
|
||||||
*/
|
|
||||||
const readBigInt64BE = (buffer, offset) => {
|
|
||||||
return buffer.readBigInt64BE(offset);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Reads a string from the buffer at the specified offset.
|
|
||||||
* @param {Buffer} buffer - The buffer to read from.
|
|
||||||
* @param {number} offset - The offset in the buffer to read the string.
|
|
||||||
* @returns {string} - The read string.
|
|
||||||
*/
|
|
||||||
const readStringFromBuffer = (buffer, offset) => {
|
|
||||||
const length = buffer.readUInt16BE(offset);
|
|
||||||
return buffer.toString('utf8', offset + 2, offset + 2 + length);
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Parses the advertise string into an object with properties.
|
|
||||||
* @param {string} advertiseStr - The advertise string to parse.
|
|
||||||
* @returns {Object} - The parsed object with properties.
|
|
||||||
*/
|
|
||||||
const parseAdvertiseString = (advertiseStr) => {
|
|
||||||
const parts = advertiseStr.split(';');
|
|
||||||
return {
|
|
||||||
gameId: parts[0],
|
|
||||||
description: parts[1],
|
|
||||||
protocolVersion: parts[2],
|
|
||||||
gameVersion: parts[3],
|
|
||||||
currentPlayers: parts[4],
|
|
||||||
maxPlayers: parts[5],
|
|
||||||
name: parts[7],
|
|
||||||
mode: parts[8]
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Creates an Unconnected Ping buffer.
|
|
||||||
* @param {number} pingId - The ping ID.
|
|
||||||
* @returns {Buffer} - The Unconnected Ping buffer.
|
|
||||||
* @see {@link https://wiki.vg/Raknet_Protocol#Unconnected_Ping}
|
* @see {@link https://wiki.vg/Raknet_Protocol#Unconnected_Ping}
|
||||||
*/
|
*/
|
||||||
const UNCONNECTED_PING = (pingId) => {
|
const createUnconnectedPingFrame = (timestamp) => {
|
||||||
const buffer = createBuffer(35);
|
const buffer = Buffer.alloc(33);
|
||||||
writeBigInt64BE(buffer, pingId, 1);
|
buffer.writeUInt8(0x01, 0); // Packet ID
|
||||||
copyHexToBuffer(buffer, '00ffff00fefefefefdfdfdfd12345678', 9);
|
buffer.writeBigInt64LE(BigInt(timestamp), 1); // Timestamp
|
||||||
writeBigInt64BE(buffer, 0, 25);
|
Buffer.from(MAGIC, "hex").copy(buffer, 9); // OFFLINE_MESSAGE_DATA_ID (Magic)
|
||||||
|
Buffer.from(crypto.randomBytes(8)).copy(buffer, 25); // Client GUID
|
||||||
return buffer;
|
return buffer;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Decodes an Unconnected Pong buffer and returns the parsed data.
|
* Extract Modt from Unconnected Pong Packet and convert to an object
|
||||||
* @param {Buffer} buffer - The Unconnected Pong buffer.
|
* @param {Buffer} unconnectedPongPacket
|
||||||
* @returns {Object} - The parsed Unconnected Pong data.
|
* @returns {Object}
|
||||||
* @see {@link https://wiki.vg/Raknet_Protocol#Unconnected_Pong}
|
* @see {@link https://wiki.vg/Raknet_Protocol#Unconnected_Pong}
|
||||||
*/
|
*/
|
||||||
const UNCONNECTED_PONG = (buffer) => {
|
const extractModt = (unconnectedPongPacket) => {
|
||||||
const pingId = readBigInt64BE(buffer, 1);
|
// Skip everything to Modt
|
||||||
const serverId = readBigInt64BE(buffer, 9);
|
const offset = 33;
|
||||||
let offset = 25;
|
const length = unconnectedPongPacket.readUInt16BE(offset);
|
||||||
let advertiseStr;
|
let modt = unconnectedPongPacket.toString("utf-8", offset + 2, offset + 2 + length);
|
||||||
|
|
||||||
try {
|
const components = modt.split(';');
|
||||||
advertiseStr = readStringFromBuffer(buffer, offset);
|
const parsedComponents = {
|
||||||
} catch (err) {
|
edition: components[0],
|
||||||
const length = parseInt(err.message.substr(err.message.indexOf(',') + 2, 3));
|
name: components[1],
|
||||||
advertiseStr = buffer.toString('utf8', offset, offset + length);
|
version: {
|
||||||
}
|
protocolVersion: Number(components[2]),
|
||||||
|
minecraftVersion: components[3],
|
||||||
|
},
|
||||||
|
players: {
|
||||||
|
online: Number(components[4]),
|
||||||
|
max: Number(components[5])
|
||||||
|
},
|
||||||
|
serverId: components[6],
|
||||||
|
mapName: components[7],
|
||||||
|
gameMode: components[8]
|
||||||
|
};
|
||||||
|
|
||||||
const parsedAdvertiseStr = parseAdvertiseString(advertiseStr);
|
return parsedComponents;
|
||||||
|
|
||||||
return { pingId, advertiseStr, serverId, offset, ...parsedAdvertiseStr };
|
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -131,12 +68,15 @@ const UNCONNECTED_PONG = (buffer) => {
|
|||||||
const ping = (host, port = 19132, cb, timeout = 5000) => {
|
const ping = (host, port = 19132, cb, timeout = 5000) => {
|
||||||
const socket = dgram.createSocket('udp4');
|
const socket = dgram.createSocket('udp4');
|
||||||
|
|
||||||
|
// Set manual timeout interval.
|
||||||
|
// This ensures the connection will NEVER hang regardless of internal state
|
||||||
const timeoutTask = setTimeout(() => {
|
const timeoutTask = setTimeout(() => {
|
||||||
socket.emit('error', new Error('Socket timeout'));
|
socket.emit('error', new Error('Socket timeout'));
|
||||||
}, timeout);
|
}, timeout);
|
||||||
|
|
||||||
const closeSocket = () => {
|
const closeSocket = () => {
|
||||||
socket.close(); clearTimeout(timeoutTask);
|
socket.close();
|
||||||
|
clearTimeout(timeoutTask);
|
||||||
};
|
};
|
||||||
|
|
||||||
// Generic error handler
|
// Generic error handler
|
||||||
@ -144,6 +84,10 @@ const ping = (host, port = 19132, cb, timeout = 5000) => {
|
|||||||
// This is mostly dangerous since it can swallow errors
|
// This is mostly dangerous since it can swallow errors
|
||||||
let didFireError = false;
|
let didFireError = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle any error that occurs during the ping process.
|
||||||
|
* @param {Error} err The error that occurred.
|
||||||
|
*/
|
||||||
const handleError = (err) => {
|
const handleError = (err) => {
|
||||||
closeSocket();
|
closeSocket();
|
||||||
|
|
||||||
@ -154,33 +98,20 @@ const ping = (host, port = 19132, cb, timeout = 5000) => {
|
|||||||
};
|
};
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const ping = UNCONNECTED_PING(new Date().getTime() - START_TIME);
|
const ping = createUnconnectedPingFrame(new Date().getTime() - START_TIME);
|
||||||
socket.send(ping, 0, ping.length, port, host);
|
socket.send(ping, 0, ping.length, port, host);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
handleError(err);
|
handleError(err);
|
||||||
}
|
}
|
||||||
|
|
||||||
socket.on('message', (msg) => {
|
socket.on('message', (pongPacket) => {
|
||||||
const id = msg[0];
|
const id = pongPacket[0];
|
||||||
|
|
||||||
switch (id) {
|
switch (id) {
|
||||||
case 0x1c: {
|
case 0x1c: {
|
||||||
const pong = UNCONNECTED_PONG(msg);
|
const modtObject = extractModt(pongPacket);
|
||||||
const clientData = {
|
|
||||||
version: {
|
|
||||||
name: pong.name,
|
|
||||||
protocol: pong.protocolVersion
|
|
||||||
},
|
|
||||||
players: {
|
|
||||||
max: pong.maxPlayers,
|
|
||||||
online: pong.currentPlayers
|
|
||||||
},
|
|
||||||
description: pong.description.replace(/\xA7[0-9A-FK-OR]/ig, ''),
|
|
||||||
gamemode: pong.mode
|
|
||||||
};
|
|
||||||
|
|
||||||
closeSocket();
|
closeSocket();
|
||||||
cb(clientData, null);
|
cb(modtObject, null);
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -191,15 +122,15 @@ const ping = (host, port = 19132, cb, timeout = 5000) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
socket.on('error', (err) => handleError(err));
|
socket.on('error', handleError);
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Asynchronously ping Minecraft Bedrock server.
|
* Asynchronously ping Minecraft Bedrock server.
|
||||||
* The optional `options` argument can be an object with a `ping` (default is `19132`) or/and `timeout` (default is `5000`) property.
|
* The optional `options` argument can be an object with a `ping` (default is `19132`) or/and `timeout` (default is `5000`) property.
|
||||||
* @param {string} host The Bedrock server address.
|
* @param {string} host The Bedrock server address.
|
||||||
* @param {import('../types/lib/bedrock.js').PingOptions} options The configuration for pinging Minecraft Bedrock server.
|
* @param {import('../types/index.js').PingOptions} options The configuration for pinging Minecraft Bedrock server.
|
||||||
* @returns {Promise<import('../types/lib/bedrock.js').BedrockPingResponse>}
|
* @returns {Promise<import('../types/index.js').BedrockPingResponse>}
|
||||||
*/
|
*/
|
||||||
export const pingBedrock = (host, options = {}) => {
|
export const pingBedrock = (host, options = {}) => {
|
||||||
if (!host) throw new Error('Host argument is not provided');
|
if (!host) throw new Error('Host argument is not provided');
|
||||||
|
42
lib/java.js
42
lib/java.js
@ -5,12 +5,18 @@
|
|||||||
|
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
import net from 'net';
|
import net from 'node:net';
|
||||||
import varint from './varint.js';
|
import varint from './varint.js';
|
||||||
|
|
||||||
const PROTOCOL_VERSION = 0;
|
/**
|
||||||
|
* Ping a Minecraft Java server.
|
||||||
function ping(host, port = 25565, cb, timeout = 5000) {
|
* @param {string} host The host of the Java server.
|
||||||
|
* @param {number} [port=25565] The port of the Java server.
|
||||||
|
* @param {function} cb The callback function to handle the ping response.
|
||||||
|
* @param {number} [timeout=5000] The timeout duration in milliseconds.
|
||||||
|
* @param {number} [protocolVersion=-1] The protocol version of the Java client.
|
||||||
|
*/
|
||||||
|
function ping(host, port = 25565, cb, timeout = 5000, protocolVersion = -1) {
|
||||||
const socket = net.createConnection(({ host, port }));
|
const socket = net.createConnection(({ host, port }));
|
||||||
|
|
||||||
// Set manual timeout interval.
|
// Set manual timeout interval.
|
||||||
@ -29,6 +35,10 @@ function ping(host, port = 25565, cb, timeout = 5000) {
|
|||||||
// This is mostly dangerous since it can swallow errors
|
// This is mostly dangerous since it can swallow errors
|
||||||
let didFireError = false;
|
let didFireError = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle any error that occurs during the ping process.
|
||||||
|
* @param {Error} err The error that occurred.
|
||||||
|
*/
|
||||||
const handleError = (err) => {
|
const handleError = (err) => {
|
||||||
closeSocket();
|
closeSocket();
|
||||||
|
|
||||||
@ -45,7 +55,7 @@ function ping(host, port = 25565, cb, timeout = 5000) {
|
|||||||
socket.on('connect', () => {
|
socket.on('connect', () => {
|
||||||
const handshake = varint.concat([
|
const handshake = varint.concat([
|
||||||
varint.encodeInt(0),
|
varint.encodeInt(0),
|
||||||
varint.encodeInt(PROTOCOL_VERSION),
|
varint.encodeInt(protocolVersion),
|
||||||
varint.encodeInt(host.length),
|
varint.encodeInt(host.length),
|
||||||
varint.encodeString(host),
|
varint.encodeString(host),
|
||||||
varint.encodeUShort(port),
|
varint.encodeUShort(port),
|
||||||
@ -65,6 +75,7 @@ function ping(host, port = 25565, cb, timeout = 5000) {
|
|||||||
|
|
||||||
socket.on('data', (data) => {
|
socket.on('data', (data) => {
|
||||||
incomingBuffer = Buffer.concat([incomingBuffer, data]);
|
incomingBuffer = Buffer.concat([incomingBuffer, data]);
|
||||||
|
|
||||||
// Wait until incomingBuffer is at least 5 bytes long to ensure it has captured the first VarInt value
|
// Wait until incomingBuffer is at least 5 bytes long to ensure it has captured the first VarInt value
|
||||||
// This value is used to determine the full read length of the response
|
// This value is used to determine the full read length of the response
|
||||||
// "VarInts are never longer than 5 bytes"
|
// "VarInts are never longer than 5 bytes"
|
||||||
@ -84,16 +95,15 @@ function ping(host, port = 25565, cb, timeout = 5000) {
|
|||||||
const packetId = varint.decodeInt(incomingBuffer, varint.decodeLength(packetLength));
|
const packetId = varint.decodeInt(incomingBuffer, varint.decodeLength(packetLength));
|
||||||
|
|
||||||
if (packetId === 0) {
|
if (packetId === 0) {
|
||||||
const data = incomingBuffer.slice(varint.decodeLength(packetLength) + varint.decodeLength(packetId));
|
const data = incomingBuffer.subarray(varint.decodeLength(packetLength) + varint.decodeLength(packetId));
|
||||||
const responseLength = varint.decodeInt(data, 0);
|
const responseLength = varint.decodeInt(data, 0);
|
||||||
const response = data.slice(varint.decodeLength(responseLength), varint.decodeLength(responseLength) + responseLength);
|
const response = data.subarray(varint.decodeLength(responseLength), varint.decodeLength(responseLength) + responseLength);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const message = JSON.parse(response);
|
const message = JSON.parse(response);
|
||||||
cb(null, message);
|
|
||||||
|
|
||||||
// Close the socket and clear the timeout task
|
|
||||||
closeSocket();
|
closeSocket();
|
||||||
|
cb(message, null);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
handleError(err);
|
handleError(err);
|
||||||
}
|
}
|
||||||
@ -107,21 +117,19 @@ function ping(host, port = 25565, cb, timeout = 5000) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Asynchronously ping Minecraft Java server.
|
* Asynchronously ping Minecraft Java server.
|
||||||
*
|
* The optional `options` argument can be an object with a `port` (default is `25565`) or/and `timeout` (default is `5000`) or/and `protocolVersion` (default is `-1`) property.
|
||||||
* The optional `options` argument can be an object with a `ping` (default is `25565`) or/and `timeout` (default is `5000`) property.
|
|
||||||
*
|
|
||||||
* @param {string} host The Java server address.
|
* @param {string} host The Java server address.
|
||||||
* @param {import('../types/index.js').PingOptions} options The configuration for pinging Minecraft Java server.
|
* @param {import('../types/index.js').PingOptions} options The configuration for pinging Minecraft Java server.
|
||||||
* @returns {Promise<import('../types/lib/java.js').JavaPingResponse>}
|
* @returns {Promise<import('../types/index.js').JavaPingResponse>}
|
||||||
*/
|
*/
|
||||||
export function pingJava(host, options = {}) {
|
export function pingJava(host, options = {}) {
|
||||||
if (!host) throw new Error('Host argument is not provided');
|
if (!host) throw new Error('Host argument is not provided');
|
||||||
|
|
||||||
const { port = 25565, timeout = 5000 } = options;
|
const { port = 25565, timeout = 5000, protocolVersion = -1 } = options;
|
||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
return new Promise((resolve, reject) => {
|
||||||
ping(host, port, (err, res) => {
|
ping(host, port, (res, err) => {
|
||||||
err ? reject(err) : resolve(res);
|
err ? reject(err) : resolve(res);
|
||||||
}, timeout);
|
}, timeout, protocolVersion);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -1,6 +1,14 @@
|
|||||||
// https://wiki.vg/Data_types
|
// https://wiki.vg/Data_types
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A utility object for encoding and decoding varints.
|
||||||
|
*/
|
||||||
const varint = {
|
const varint = {
|
||||||
|
/**
|
||||||
|
* Encodes an integer value into a varint byte buffer.
|
||||||
|
* @param {number} val - The integer value to encode.
|
||||||
|
* @returns {Buffer}
|
||||||
|
*/
|
||||||
encodeInt: (val) => {
|
encodeInt: (val) => {
|
||||||
// "constInts are never longer than 5 bytes"
|
// "constInts are never longer than 5 bytes"
|
||||||
// https://wiki.vg/Data_types#constInt_and_constLong
|
// https://wiki.vg/Data_types#constInt_and_constLong
|
||||||
@ -8,26 +16,43 @@ const varint = {
|
|||||||
let written = 0;
|
let written = 0;
|
||||||
|
|
||||||
while (true) {
|
while (true) {
|
||||||
if ((val & 0xFFFFFF80) === 0) {
|
const byte = val & 0x7F;
|
||||||
buf.writeUInt8(val, written++);
|
val >>>= 7;
|
||||||
|
|
||||||
|
if (val === 0) {
|
||||||
|
buf.writeUInt8(byte, written++);
|
||||||
break;
|
break;
|
||||||
} else {
|
|
||||||
buf.writeUInt8(val & 0x7F | 0x80, written++);
|
|
||||||
val >>>= 7;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
buf.writeUInt8(byte | 0x80, written++);
|
||||||
}
|
}
|
||||||
|
|
||||||
return buf.slice(0, written);
|
return buf.slice(0, written);
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encodes a string value into a UTF-8 byte buffer.
|
||||||
|
* @param {string} val - The string value to encode.
|
||||||
|
* @returns {Buffer}
|
||||||
|
*/
|
||||||
encodeString: (val) => {
|
encodeString: (val) => {
|
||||||
return Buffer.from(val, 'utf-8');
|
return Buffer.from(val, 'utf-8');
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encodes an unsigned short value into a byte buffer.
|
||||||
|
* @param {number} val - The unsigned short value to encode.
|
||||||
|
* @returns {Buffer}
|
||||||
|
*/
|
||||||
encodeUShort: (val) => {
|
encodeUShort: (val) => {
|
||||||
return Buffer.from([val >> 8, val & 0xFF]);
|
return Buffer.from([val >> 8, val & 0xFF]);
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Concatenates multiple byte buffers into a single byte buffer.
|
||||||
|
* @param {Buffer[]} chunks - An array of byte buffers to concatenate.
|
||||||
|
* @returns {Buffer}
|
||||||
|
*/
|
||||||
concat: (chunks) => {
|
concat: (chunks) => {
|
||||||
let length = 0;
|
let length = 0;
|
||||||
|
|
||||||
@ -43,16 +68,22 @@ const varint = {
|
|||||||
return Buffer.concat(buffer);
|
return Buffer.concat(buffer);
|
||||||
},
|
},
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Decodes a varint integer value from a byte buffer.
|
||||||
|
* @param {Buffer} buffer - The byte buffer to decode from.
|
||||||
|
* @param {number} offset - The offset in the buffer to start decoding from.
|
||||||
|
* @returns {number}
|
||||||
|
*/
|
||||||
decodeInt: (buffer, offset) => {
|
decodeInt: (buffer, offset) => {
|
||||||
let val = 0;
|
let val = 0;
|
||||||
let count = 0;
|
let count = 0;
|
||||||
|
|
||||||
while (true) {
|
while (true) {
|
||||||
const b = buffer.readUInt8(offset++);
|
const byte = buffer.readUInt8(offset++);
|
||||||
|
|
||||||
val |= (b & 0x7F) << count++ * 7;
|
val |= (byte & 0x7F) << count++ * 7;
|
||||||
|
|
||||||
if ((b & 0x80) != 128) {
|
if ((byte & 0x80) !== 0x80) {
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -60,8 +91,13 @@ const varint = {
|
|||||||
return val;
|
return val;
|
||||||
},
|
},
|
||||||
|
|
||||||
// The number of bytes that the last .decodeInt() call had to use to decode.
|
/**
|
||||||
|
* Calculates the number of bytes required to decode a varint integer value.
|
||||||
|
* @param {number} val - The varint integer value.
|
||||||
|
* @returns {5 | 7 | 8 | 1 | 2 | 3 | 4 | 6 | 9 | 10}
|
||||||
|
*/
|
||||||
decodeLength: (val) => {
|
decodeLength: (val) => {
|
||||||
|
// Constants representing the powers of 2 used for comparison
|
||||||
const N1 = Math.pow(2, 7);
|
const N1 = Math.pow(2, 7);
|
||||||
const N2 = Math.pow(2, 14);
|
const N2 = Math.pow(2, 14);
|
||||||
const N3 = Math.pow(2, 21);
|
const N3 = Math.pow(2, 21);
|
||||||
@ -72,6 +108,7 @@ const varint = {
|
|||||||
const N8 = Math.pow(2, 56);
|
const N8 = Math.pow(2, 56);
|
||||||
const N9 = Math.pow(2, 63);
|
const N9 = Math.pow(2, 63);
|
||||||
|
|
||||||
|
// Return the number of bytes required based on the value
|
||||||
return (
|
return (
|
||||||
val < N1 ? 1
|
val < N1 ? 1
|
||||||
: val < N2 ? 2
|
: val < N2 ? 2
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@minescope/mineping",
|
"name": "@minescope/mineping",
|
||||||
"version": "1.1.0",
|
"version": "1.5.0",
|
||||||
"description": "Ping both Minecraft Bedrock and Java servers.",
|
"description": "Ping both Minecraft Bedrock and Java servers.",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"types": "types/index.d.ts",
|
"types": "types/index.d.ts",
|
||||||
|
4
types/index.d.ts
vendored
4
types/index.d.ts
vendored
@ -1,2 +1,2 @@
|
|||||||
export { pingJava } from "./lib/java.js";
|
export * from "./lib/java.js";
|
||||||
export { pingBedrock } from "./lib/bedrock.js";
|
export * from "./lib/bedrock.js";
|
26
types/lib/bedrock.d.ts
vendored
26
types/lib/bedrock.d.ts
vendored
@ -2,22 +2,25 @@
|
|||||||
* @param port The server port.
|
* @param port The server port.
|
||||||
* @param timeout The read/write socket timeout.
|
* @param timeout The read/write socket timeout.
|
||||||
*/
|
*/
|
||||||
export type PingOptions = {
|
export type BedrockPingOptions = {
|
||||||
port: number,
|
port?: number;
|
||||||
timeout: number;
|
timeout?: number;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type BedrockPingResponse = {
|
export type BedrockPingResponse = {
|
||||||
|
edition: string;
|
||||||
|
name: string;
|
||||||
version: {
|
version: {
|
||||||
name: string;
|
protocolVersion: number;
|
||||||
protocol: string;
|
minecraftVersion: string;
|
||||||
};
|
};
|
||||||
players: {
|
players: {
|
||||||
max: string;
|
online: number;
|
||||||
online: string;
|
max: number;
|
||||||
};
|
};
|
||||||
description: string;
|
serverId: string;
|
||||||
gamemode: string;
|
mapName: string;
|
||||||
|
gameMode: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -26,6 +29,7 @@ export type BedrockPingResponse = {
|
|||||||
* The optional `options` argument can be an object with a `ping` (default is `19132`) or/and `timeout` (default is `5000`) property.
|
* The optional `options` argument can be an object with a `ping` (default is `19132`) or/and `timeout` (default is `5000`) property.
|
||||||
*
|
*
|
||||||
* @param host The Bedrock server address.
|
* @param host The Bedrock server address.
|
||||||
|
* @param options The configuration for pinging Minecraft Bedrock server.
|
||||||
*
|
*
|
||||||
* ```js
|
* ```js
|
||||||
* import { pingBedrock } from '@minescope/mineping';
|
* import { pingBedrock } from '@minescope/mineping';
|
||||||
@ -43,7 +47,7 @@ export type BedrockPingResponse = {
|
|||||||
* gamemode: 'Survival'
|
* gamemode: 'Survival'
|
||||||
* }
|
* }
|
||||||
* ```
|
* ```
|
||||||
* @see [source](https://github.com/minescope/mineping/blob/24a48802300f988d3ae520edbeb4f3e12820dcc9/lib/java.js#L117)
|
* @see [source](https://github.com/minescope/mineping/blob/915edbec9c9ad811459458600af3531ec0836911/lib/bedrock.js#L204)
|
||||||
*/
|
*/
|
||||||
export function pingBedrock(host: string, options?: PingOptions): Promise<BedrockPingResponse>;
|
export function pingBedrock(host: string, options?: BedrockPingOptions): Promise<BedrockPingResponse>;
|
||||||
|
|
||||||
|
15
types/lib/java.d.ts
vendored
15
types/lib/java.d.ts
vendored
@ -1,4 +1,13 @@
|
|||||||
import { PingOptions } from "./bedrock";
|
/**
|
||||||
|
* @param port The server port.
|
||||||
|
* @param timeout The read/write socket timeout.
|
||||||
|
* @param protocolVersion The protocol version.
|
||||||
|
*/
|
||||||
|
export type JavaPingOptions = {
|
||||||
|
port?: number | undefined,
|
||||||
|
timeout?: number | undefined,
|
||||||
|
protocolVersion?: number | undefined;
|
||||||
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* JSON format chat component used for description field.
|
* JSON format chat component used for description field.
|
||||||
@ -65,7 +74,7 @@ export type JavaPingResponse = {
|
|||||||
* favicon: 'data:image/png;base64,iVBORw0KGg...
|
* favicon: 'data:image/png;base64,iVBORw0KGg...
|
||||||
}
|
}
|
||||||
* ```
|
* ```
|
||||||
* @see [source](https://github.com/minescope/mineping/blob/8c84925ef7f5c420a7ef52740cba027491e82934/lib/bedrock.js#L158)
|
* @see [source](https://github.com/minescope/mineping/blob/915edbec9c9ad811459458600af3531ec0836911/lib/java.js#L117)
|
||||||
*/
|
*/
|
||||||
export function pingJava(host: string, options?: PingOptions): Promise<JavaPingResponse>;
|
export function pingJava(host: string, options?: JavaPingOptions): Promise<JavaPingResponse>;
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user