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.
Mirror on my Git
Node.js 14 or newer is required
npm i @minescope/mineping
import { pingJava, pingBedrock } from '@minescope/mineping';
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));
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!