# @hardxploit/mc-status

> Unofficial project of MCStatus.io, a minimalist library that allows you to get information about Minecraft Java or Bedrock servers.

Latest version **0.2.1** (published 2024-04-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hardxploit/mc-status
pnpm add @hardxploit/mc-status
yarn add @hardxploit/mc-status
bun add @hardxploit/mc-status
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2024-04-19 |
| First published | 2024-03-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 19.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | hardxploit |
| Keywords | minecraft, mcserver, status, serverstatus, minecraft-server |

## Links

- npm: https://www.npmjs.com/package/@hardxploit/mc-status
- Repository: https://github.com/HardXploitDev/mc-status
- Homepage: https://github.com/HardXploitDev/mc-status#readme
- Issues: https://github.com/HardXploitDev/mc-status/issues
- npm.io page: https://npm.io/package/@hardxploit/mc-status

## Recent versions

- 0.2.1 (latest) — 2024-04-19
- 0.1.4 — 2024-03-30
- 0.1.3 — 2024-03-30
- 0.1.0 — 2024-03-30

## README

[![npm v0.2.1](https://img.shields.io/badge/npm-v0.2.1-green.svg)](https://www.npmjs.com/package/@hardxploit/mc-status)

# mc-status
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](https://github.com/EvilG-MC), thank you very much for your contribution.

> The API used for check server status is from https://mcstatus.io/ (v2).

## Usage
### Requirements
```
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](https://nodejs.org/docs/latest-v18.x/api/globals.html#fetch).

### Install
```
npm install @hardxploit/mc-status --save
```

### Start coding
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:
```js
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);
})();
```
[Output (JSON)](https://mcstatus.io/docs)

## Package progress
- [x] Get servers status.
- [ ] Get users status.

---
_Source: https://npm.io/package/@hardxploit/mc-status · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._