📅 You're Invited: Meet the Socket team at RSAC (April 28 – May 1).RSVP
Socket
Sign inDemoInstall
Socket

@minescope/mineping

Package Overview
Dependencies
Maintainers
0
Versions
16
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@minescope/mineping

Ping both Minecraft Bedrock and Java servers.

1.6.1
latest
Source
npm
Version published
Weekly downloads
11
-52.17%
Maintainers
0
Weekly downloads
 
Created
Source

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

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

FAQs

Package last updated on 07 Feb 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts