https://github.com/janispritzkau/mc-server-status

A small utility for getting the description, player count and ping of a Minecraft server.
https://github.com/janispritzkau/mc-server-status

minecraft node nodejs ping query server status

Last synced: 24 days ago
JSON representation

A small utility for getting the description, player count and ping of a Minecraft server.

• Host: GitHub
• URL: https://github.com/janispritzkau/mc-server-status
• Owner: janispritzkau
• Created: 2019-08-06T09:54:29.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-06-25T06:59:10.000Z (almost 3 years ago)
• Last Synced: 2025-03-25T11:11:20.243Z (about 1 month ago)
• Topics: minecraft, node, nodejs, ping, query, server, status
• Language: TypeScript
• Homepage:
• Size: 133 KB
• Stars: 16
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Minecraft Server Status

[![npm](https://img.shields.io/npm/v/mc-server-status.svg)](https://www.npmjs.com/package/mc-server-status)

[![downloads](https://img.shields.io/npm/dm/mc-server-status.svg)](https://www.npmjs.com/package/mc-server-status)

A small utility and library for getting the description, player count

and ping of a Minecraft server.

## Usage

```bash

mc-status 2b2t.org

# with port

mc-status localhost 25565

# output json

mc-status --json 


```


![Terminal output](https://gitlab.com/janispritzkau/mc-status/raw/master/terminal.png)

You can also use it as a library:

```js

const { getStatus } = require("mc-server-status")

const status = await getStatus("2b2t.org")

console.log(status)

```