Timofey Gelazoniya f369fa14b9 | ||
---|---|---|
example | ||
lib | ||
types | ||
.gitignore | ||
LICENSE | ||
README.md | ||
SECURITY.md | ||
index.js | ||
package.json | ||
yarn.lock |
README.md
mineping
Collect information about Minecraft (both Java and Bedrock) using Node.js.
Description
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.
Requirements
Node.js 14 or newer is required
Install
npm i @minescope/mineping
Example
Ping a Java server with default options:
import { pingJava } from 'mineping'
const data = await pingJava('mc.hypixel.net');
console.log(data);
Ping a Bedrock server with custom options:
import { pingBedrock } from '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!