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

mc-server-info

v1.2.0

Published

Get details about a minecraft server by either query or status ping.

Downloads

7

Readme

🔎 Mc Server Info (NPM Package)

Get data about a running minecraft server by either Status request or Query.

Implementation of the UDP Server Query Protocol, as lined out by Dinnerbone in his Original Blog Post, as well as the Server List Ping Protocol ~~in a purely functional manner~~ (only up to v1.1.0). I just want to call a single function and that's it - so I did it.

Requirements

The target minecraft server has to run the JAVA edition of minecraft on any version more recent than to 1.7

In order to use Server Query Protocol (queryBasicStat() and queryFullStat()) the server.properties file (or if a proxy like Bungeecord or Waterfall is used in their specific config file) the option enable-query has to be set to true and the query.port has to bet set to any valid port (can be the same as the game port but has to be specified) and the server must be running Java Edition.

In order to use Server List Ping Protocol (serverStatus()) the server must be online, running Java Edition and may not be behind an obfuscation proxy like TCPShield. It does not have to have enable-query enabled, however the retrievable data is limited in comparison to the Server Query Protocol.

Installation

npm i mc-server-info

How to use

No fancy instantiations or anything necessary, simply require mc-status and call the function(s) you need. You will receive a Map of the server data. It is important that you catch errors since all Errors and Exceptions are propagated back to you via promise rejections.

const { queryFullStat } = require('mc-server-info');

(async function () {
    try {
        let info = await queryFullStat({ host: "localhost", port: 56789, timeout: 6000 });
        console.log(info);
    } catch (err) {
        console.log('FullStat Query threw an error:\n\n' + err);
    }
})();
const { queryBasicStat } = require('mc-server-info');

queryBasicStat({ host: "localhost", port: 56789, timeout: 6000 })
    .then((map)=>{
        console.log(map);
    })
    .catch((err) => console.log(err)); 
const { serverStatus } = require('mc-server-info');

serverStatus({ host: "localhost", port: 56789, timeout: 6000 })
    .then((map)=>{
        console.log(map);
    })
    .catch((err) => console.log(err)); 

Arguments

All functions take an Object parameter consisting of the following attributes:

host: (string) Domain or IP-Address of the target server 
port: (integer) [optional] Query Port of the target server (default 25565)
timeout: (integer) [optional] Time in ms until the request should time out (default: 4000)

All query functions return a Map of the query data.

Output

Full stat:

{
  motd: 'This is a MOTD',
  type: 'SMP',
  gameid: 'MINECRAFT',
  version: '1.x.x',
  plugins: 'Plugin1; Plugin2; Plugin3',
  servertype: 'world',
  playercount: '3',
  maxplayers: '100',
  port: '25565',
  players: [ 'EpicPlayer', '0ti', 'otto6' ]
}

Basic Stat:

{
  motd: 'This is a MOTD',
  type: 'SMP',
  servertype: 'world',
  playersonline: '3',
  maxplayers: '100'
}

Server status data may be limited depending on server software used, but is reliably mapped to the FullStat data map format and uses some internal functions in order to try and get as much readable data as possible. It has an additional field containing the base64 string representation of the favicon of the server, if exists:

{
  motd: 'This is a MOTD',
  type: 'SMP',
  gameid: 'MINECRAFT',
  version: '1.x.x',
  plugins: 'undefined',
  servertype: 'world',
  playercount: '3',
  maxplayers: '100',
  port: '25565',
  players: [ 'EpicPlayer', '0ti', 'otto6' ],
  favicon: *string, base64 encoded*
}

Intended Use

Initially I wrote this small ibrary as a simple way to use the Server Query Protocol, however after learning how little servers even have query enabled in their config, I felt the need to add a fallback option. Therefore the intended use is to try and query server data using the Server Query Protocol and if the server does not allow query, use the Server List Ping Protocol function serverStatus() to force a server status response and acquire server data.

Limitations

Some servers run behind a proxy aimed at protecting from DDOS, such as TCPShield. Many large playercount servers use such system. In that case neither protocols will result in retrievable data and the only way to get data from those servers is to get your request host whitelisted by those servers.

Dependencies

This library is using dgram for UDP Messaging, net for TCP Messaging and buffer to craft the necessary packets. These are standard libraries included in the nodejs runtime and therefore this library does not require any external dependencies.