Timofey Gelazoniya 23299a9a07 fix: add timeout to SRV record lookup
The `dns.promises.resolveSrv` function used for SRV record lookups
does not have a user-configurable timeout. This could cause the entire
`pingJava` operation to hang for an extended period if the target's
DNS server unresponsive.

To make the SRV lookup more robust and respect the user-provided
timeout, this commit switches to using the `dns.promises.Resolver`
class.
2025-06-25 01:09:07 +03:00
2025-06-25 01:09:07 +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%