Unofficial project of MCStatus.io, a minimalist library that allows you to get information about Minecraft Java or Bedrock servers. Can be used in JavaScript (CJS and ESM) and TypeScript. The current version is improved and made by JustEvil, thank you very much for your contribution.
The API used for check server status is from https://mcstatus.io/ (v2).
NodeJS Version: v16.15.x or higher
NPM Version: v7.x or higher
If you are using NodeJS versions older than v18, you will need to add the
--experimental-fetch
flag when running it, for the package to work correctly. NodeJS Docs.
npm install @hardxploit/mc-status --save
There are 3 different classes in the module, one general and the other two specific for the two possible platforms. And each one has a function (asynchronous) to obtain the statistics in JSON.
Example code:
import { ServerStatus, BedrockStatus, JavaStatus } from 'mc-status';
(async () => {
const Server = new ServerStatus('java', 'mc.hypixel.net', 25565);
const BedrockServer = new BedrockStatus('play.parrotsmp.com');
const JavaServer = new JavaStatus('mc.hypixel.net');
const status = await Server.get();
const bedrockStatus = await BedrockServer.get();
const javaStatus = await JavaServer.get();
console.log(status, bedrockStatus.port, javaStatus.online);
})();
- [x] Get servers status.
- [ ] Get users status.