Minecraft Server Status Simple

A simple Node.js package to fetch details of Minecraft Java and Bedrock servers using mcsrvstat.us API.

Installation

npm install minecraft-server-status-simple

Basic Usage

You can specify type as either "java" or "bedrock". The port is optional (default: 25565 for Java, 19132 for Bedrock).

Example

const mc = require("minecraft-server-status-simple");

mc.status({
  type: "java", // or "bedrock"
  ip: "play.cubecraft.net",
  port: 25565, // optional
  show: ["online", "players"] // optional, specify fields to return
})
  .then((res) => console.log(res))
  .catch((err) => console.log(err));

Fetching Java Server Info

mc.statusJava({ ip: "play.cubecraft.net", port: 25565 })
  .then((res) => console.log(res))
  .catch((err) => console.log(err));

Fetching Bedrock Server Info

mc.statusBedrock({ ip: "nitrofaction.fr", port: 19132 })
  .then((res) => console.log(res))
  .catch((err) => console.log(err));

Optional Parameters

You can pass an array in show to return only specific fields:

show: [
  "online",
  "ip",
  "port",
  "debug",
  "motd",
  "players",
  "version",
  "protocol",
  "hostname",
  "icon",
  "software",
  "map",
  "gamemode",
  "serverid",
  "plugins",
  "mods",
  "info",
];

API

• mc.status({ type, ip, port, show: [] }) - Fetch Minecraft server info.
• mc.statusJava({ ip, port, show: [] }) - Fetch Java server info.
• mc.statusBedrock({ ip, port, show: [] }) - Fetch Bedrock server info.

This library uses mcsrvstat.us API.