npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@switt/minecraft-status

v1.1.0

Published

Node.js module for gathering information about Minecraft Java Edition servers and Minecraft Bedrock Edition servers.

Downloads

2

Readme

minecraft-status

Node.js module for gathering information about Minecraft Java Edition servers and Minecraft Bedrock Edition servers.

minecraft-status was based off of mc-ping-updated, mc-stat, and mcpe-ping.

minecraft-status supports the Server List Ping protocol for Minecraft Java Edition servers on Minecraft versions 1.7 and above (current), 1.6, and 1.4 through 1.5, and Beta 1.8 through 1.3 and the Query protocol for Minecraft Java Edition servers on Minecraft versions 1.9pre4 and above.

Support for Minecraft Bedrock Edition servers should be implemented soon™️.

Documentation

Include minecraft-status in your project like so.

// MinecraftServerListPing (either)
const { MinecraftServerListPing } = require("minecraft-status");
const MinecraftServerListPing = require("minecraft-status").MinecraftServerListPing;

// MinecraftQuery (either)
const { MinecraftQuery } = require("minecraft-status");
const MinecraftQuery = require("minecraft-status").MinecraftQuery;

// Both
const { MinecraftServerListPing, MinecraftQuery } = require("minecraft-status");

For more information on the Server List Ping or Query protocols, consult wiki.vg.

Unlike previous versions of minecraft-status, functions use promises rather than callback functions.

MinecraftServerListPing.ping(4, "mc.hypixel.net", 25565, 3000)
.then(response => {
    // Success
})
.catch(error => {
    // Error
});

Server List Ping

1.7 and above (current)

MinecraftServerListPing.ping(protocol, host, port, timeout)

protocol Default 4. See protocol version numbers. The version the client uses to connect to the server.

host The host, or the domain name, IPv4, or IPv6 address, of the server.

port Default 25565. The port of the server.

callback(error, response)

timeout Default 3000. Milliseconds.

{
    "version": {
        "name": "1.8.7",
        "protocol": 47
    },
    "players": {
        "max": 100,
        "online": 5,
        "sample": [
            {
                "name": "thinkofdeath",
                "id": "4566e69f-c907-48ee-8d71-d7ba5aa00d20"
            }
        ]
    },	
    "description": {
        "text": "Hello world"
    },
    "favicon": "data:image/png;base64,<data>"
}

1.6

MinecraftServerListPing.ping16(protocol, host, port, timeout)

protocol Default 73. See protocol version numbers. The version the client uses to connect to the server.

host The host, or the domain name, IPv4, or IPv6 address, of the server.

port Default 25565. The port of the server.

callback(error, response)

timeout Default 3000. Milliseconds.

{
    "version": {
        "name": "1.6.4",
        "protocol": 78
    },
    "players": {
        "max": 100,
        "online": 5
    },	
    "description": "A Minecraft Server"
}

1.4 through 1.5

MinecraftServerListPing.ping15(host, port, timeout)

host The host, or the domain name, IPv4, or IPv6 address, of the server.

port Default 25565. The port of the server.

callback(error, response)

timeout Default 3000. Milliseconds.

{
    "version": {
        "name": "1.4.7",
        "protocol": 51
    },
    "players": {
        "max": 100,
        "online": 5
    },	
    "description": "A Minecraft Server"
}

Beta 1.8 through 1.3

MinecraftServerListPing.ping13(host, port, timeout)

host The host, or the domain name, IPv4, or IPv6 address, of the server.

port Default 25565. The port of the server.

callback(error, response)

timeout Default 3000. Milliseconds.

{
    "players": {
        "max": 100,
        "online": 5
    },	
    "description": "A Minecraft Server"
}

Query

The following must be configured in the server.properties file.

enable-query=true
query.port=<1-65535>

The default query port matches the port established in server-port.

Basic stat

MinecraftQuery.query(host, port, timeout)

host The host, or the domain name, IPv4, or IPv6 address, of the server.

port Default 25565. The port of the server.

callback(error, response)

timeout Default 3000. Milliseconds.

{
    "players": { 
        "online": 5, 
        "max": 100 
    },
    "description": "\u0001A Minecraft Server",
    "map": "world",
    "game_type": "SMP"
}

Full stat

MinecraftQuery.fullQuery(host, port, timeout)

host The host, or the domain name, IPv4, or IPv6 address, of the server.

port Default 25565. The port of the server.

callback(error, response)

timeout Default 3000. Milliseconds.

{
    "version": {
        "name": "1.15.2"
    },
    "players": { 
        "online": 1, 
        "max": 20,
        "sample": [
            "mathhulk"
        ]
    },
    "description": "A Minecraft Server",
    "map": "world",
    "game_type": "SMP",
    "game_id": "MINECRAFT",
    "server_modification": {
        "name": "Paper on 1.15.2-R0.1-SNAPSHOT",
        "plugins": [
            "SimpleTpa 3.0"
        ]
    }
}