Ping both Minecraft Bedrock and Java servers.
Go to file
Timofey Gelazoniya 9ae6e7c89d
docs: added clarification regarding CommonJS
2022-01-11 02:24:39 +03:00
example initial commit 2022-01-10 23:21:47 +03:00
lib initial commit 2022-01-10 23:21:47 +03:00
types initial commit 2022-01-10 23:21:47 +03:00
.gitignore initial commit 2022-01-10 23:21:47 +03:00
LICENSE initial commit 2022-01-10 23:21:47 +03:00
README.md docs: added clarification regarding CommonJS 2022-01-11 02:24:39 +03:00
SECURITY.md initial commit 2022-01-10 23:21:47 +03:00
index.js initial commit 2022-01-10 23:21:47 +03:00
package.json 1.0.1 2022-01-10 23:33:04 +03:00
yarn.lock initial commit 2022-01-10 23:21:47 +03:00

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

Loading and configuration the module

ES Modules (ESM)

import { pingJava, pingBedrock } from '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('mineping').then(module => module.pingJava(...args));
const pingBedrock = (...args) => import('mineping').then(module => module.pingBedrock(...args));

Usage

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!

Acknowledgements

  • mcping crate for Rust
  • mcping-js library for quering Minecraft Java Edition servers