Timofey Gelazoniya 371fb9daa7
feat: skip SRV lookup for IP addresses and localhost
Performing DNS SRV lookups for hosts that are already direct IP
addresses or special-case hostnames like 'localhost' is
unnecessary.

In addition, several related test suite improvements
have been included:

- A bug in the Bedrock mock packet creation was fixed where the magic
  GUID was being written to an incorrect buffer offset.
- The DNS mocking strategy in the Java tests has been refactored for
  better accuracy by mocking the `dns.promises.Resolver` class.
- An error test for the Bedrock pinger was corrected to properly
  handle a promise rejection instead of a synchronous throw.
2025-06-25 01:46:53 +03:00
2022-01-10 23:21:47 +03:00
2022-01-10 23:21:47 +03:00
2022-01-10 23:21:47 +03:00

mineping

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 Git

Requirements

Node.js 14 or newer is required

Install

To install mineping, simply run the following command:

npm i @minescope/mineping

To install beta version (if available), run: npm i @minescope/mineping@next

Loading and configuration the module

ES Modules (ESM)

If you are using ES Modules, you can import the library like this:

import { pingJava, pingBedrock } from "@minescope/mineping";

CommonJS

mineping is an ESM-only module — you are not able to import it with require(). If you cannot switch to ESM, you can use the async import() function from CommonJS to load mineping asynchronously:

const pingJava = (...args) =>
	import("@minescope/mineping").then((module) => module.pingJava(...args));
const pingBedrock = (...args) =>
	import("@minescope/mineping").then((module) => module.pingBedrock(...args));

Usage

Ping a Java server with default options:

import { pingJava } from "@minescope/mineping";

const data = await pingJava("mc.hypixel.net");
console.log(data);

Ping a Bedrock server with custom options:

import { pingBedrock } from "@minescope/mineping";

const data = await pingBedrock("mco.mineplex.com", {
	port: 19132,
	timeout: 500,
});
console.log(data);

More complex example can be found in the example folder!

Acknowledgements

Special thanks to the following projects:

  • mcping crate for Rust
  • mcping-js library for quering Minecraft Java Edition servers
Description
Ping both Minecraft Bedrock and Java servers.
Readme MIT 243 KiB
Languages
JavaScript 100%